Cadastrar um novo pedido

Pedidos no Sensio podem ser vendas, orçamentos ou compras. Com esse endpoint você pode cadastrar um novo pedido. É obrigatório o tipo e itens (saleLines). O código é gerado pelo próprio Sensio. Para integrações, você pode utilizar os campos orig e origId para referenciar, exemplo orig "Ecommerce X", origId "1234". Você pode passar o id do cliente pelo atributo customerId, ou o nome pelo atributo customer.

Requisição

Parâmetros Bodyapplication/json

child

string

opcional

Id da empresa, se ela for uma filial.

total

number <float>

opcional

Valor total dos itens adicionados no pedido.

dateSold

string <date>

opcional

Data do pedido.

fixedPaymentsDate

boolean

opcional

Informa se as datas das parcelas são fixas.

type

enum<string>

requerido

Tipo do pedido.

Valores permitidos:

VendaAssistência TécnicaOrçamentoCompraVenda RepresentaçãoBonificação/RemessaOutros

status

enum<string>

opcional

Valores permitidos:

Em abertoFaturado

paymentConditionType

string

opcional

Condição de pagamento a ser escolhida, os sem 'X' são os dias pra cada parcela.

Exemplo:

2x, 30 60 90

paymentMethod

enum<string>

opcional

Método de pagamento a ser feito.

Valores permitidos:

DinheiroChequeDébito em contaDébito Direto Autorizado (DDA)Depósito/TransferênciaCartão de CréditoCartão de DébitoCrédito LojaFinanceiraVale CréditoVale AlimentaçãoVale RefeiçãoVale PresenteVale CombustívelDuplicata MercantilBoleto BancárioPrograma de fidelidade, Cashback, Crédito VirtualSem PagamentoCarteiraPIXOutros

Exemplo:

Dinheiro

priceList

string

opcional

Tabela de preços, são adicionados à essa tabela os itens que pode ser vendido. Se for referênciado no pedido, deve-se adicionar somente os itens que compões a tabela.

payments

array[object (salePostObject_payments) {5}]

opcional

Lista das parcelas.

nDup

integer

opcional

Número da parcela.

dVenc

string <date>

requerido

vDup

number <float>

opcional

Valor da parcela.

tPag

string

opcional

Método de pagamento.

acquirerFee

number <float>

opcional

Taxa adicional na parcela.

customer

string

requerido

Nome do cliente que fez o pedido.

customerId

string

requerido

Id do cliente que fez o pedido.

otherExpenses

number <float>

opcional

Outras despesas que é adicionado junto ao valor líquido do pedido.

Padrão:

discount

number <float>

opcional

Desconto em real da venda.

Padrão:

discountType

enum<string>

opcional

Valores permitidos:

%R$

Padrão:

discountPercentage

number <float>

opcional

Porcentagem informada ao escolher o tipo de desconto como 'porcentagem', tanto este campo quanto o campo discount devem ser informados.

Padrão:

transportFee

number <float>

opcional

Taxa do transporte/frete.

Padrão:

details

string

opcional

Observações que pode ser feito para o pedido.

string

opcional

campo para informar OC/número do pedido do cliente/fornecedor

sellersInfo

array[object (salePostObject_sellersInfo) {4}]

opcional

Informações do vendedor, bem como sua comissão

seller

string

requerido

Id do vendedor

comissionType

enum<string>

opcional

Valores permitidos:

%R$

Padrão:

comissionValue

number <float>

opcional

Valor da comissão.

comission

number <float>

opcional

Valor da comissão em porcentagem. Deve ser informado junto a 'comission' o valor em real no comissionValue.

netTotal

number <float>

opcional

Valor líquido, valor resultante da subtração do desconto, da soma das 'outras despesas', 'taxa de transporte' e 'valor total'.

negotiationStatus

enum<string>

opcional

Status da negociação

Valores permitidos:

Em orçamentoRecusadoAprovado

dueDate

string <date>

opcional

Data de vencimento do orçamento, ou seja, somente no tipo orçamento é preenchido este campo.

foreseenDelivery

string <date>

opcional

Previsão de entrega, somente utilizado quando o pedido é do tipo orçamento.

quoteDate

string <date>

opcional

Data do orçamento, somente utilizado quando o pedido é do tipo orçamento.

orig

string

opcional

Origem do pedido - utilizado para importações do pedido apartir de um ecommerce.

origId

string

opcional

Id da origem do pedido - utilizado para importações do pedido a partir de um ecommerce.

tags

array[object (salePostObject_tags) {1}]

opcional

Lista das tags que compõe o pedido, somente pode ser adicionado tags que fazem parte do escopo do pedido.

tagId

string

opcional

Id da tag.

origStatus

string

opcional

Status no ecommerce do pedido.

origPaymentMethod

string

opcional

Método de pagamento no ecommerce.

bonificacao

boolean

opcional

Quando habilitado ele não será contado no faturamento final.

Padrão:

false

carrier

string

opcional

Id da pessoa responsável por fazer o frete.

modFrete

enum<string>

opcional

Tipo de transporte a ser realizado.

Valores permitidos:

0 - Por conta do emitente1 - Por conta do destinatário/remetente2 - Por conta de terceiros9 - Sem frete

foreseenShipment

string <date>

opcional

Previsão de entrega.

shipmentDetails

string

opcional

Observações para entrega.

shipmentAddress

enum<string>

opcional

Valores permitidos:

Endereço da PessoaEndereço de EntregaEndereço de CobrançaEndereço Secundário

Padrão:

Endereço da Pessoa

shipment

string

opcional

Descrição do frete.

shipped

boolean

opcional

Informa se os itens do pedido já foi enviado.

shipmentCode

string

opcional

Código do envio.

shipmentDate

string <date>

opcional

Data do envio.

approved

boolean

opcional

Indicador se o pedido está aprovado

Padrão:

true

description

string

opcional

saleLines

array[object (salePostObject_saleLines) {6}]

requerido

productId

string

requerido

Id do item adicionado no pedido.

variationId

string

opcional

Id da variação do item, caso este item tenha variação é necessário que seja informado a variação.

qty

integer

requerido

Quantidade solicitada no pedido

price

number <float>

requerido

Preço do pedido

details

string

opcional

Observações sobre o item.

detailsNF

boolean

opcional

Informa se a obserção do item vai sair na NFe.

contactId

string

opcional

Id do contato principal (person).

acquirer

object (salePostObject_acquirer)

opcional

isWithAcquirerFee

boolean

opcional

acquirerId

string

opcional

feeType

string

opcional

Exemplo

{
    "child": "string",
    "total": 0,
    "dateSold": "2019-08-24",
    "fixedPaymentsDate": true,
    "type": "Venda",
    "status": "Em aberto",
    "paymentConditionType": "2x, 30 60 90",
    "paymentMethod": "Dinheiro",
    "priceList": "string",
    "payments": [
        {
            "nDup": 0,
            "dVenc": "2019-08-24",
            "vDup": 0,
            "tPag": "string",
            "acquirerFee": 0
        }
    ],
    "customer": "string",
    "customerId": "string",
    "otherExpenses": 0,
    "discount": 0,
    "discountType": "R$",
    "discountPercentage": 0,
    "transportFee": 0,
    "details": "string",
    "oc": "string",
    "sellersInfo": [
        {
            "seller": "string",
            "comissionType": "%",
            "comissionValue": 0,
            "comission": 0
        }
    ],
    "netTotal": 0,
    "negotiationStatus": "Em orçamento",
    "dueDate": "2019-08-24",
    "foreseenDelivery": "2019-08-24",
    "quoteDate": "2019-08-24",
    "orig": "string",
    "origId": "string",
    "tags": [
        {
            "tagId": "string"
        }
    ],
    "origStatus": "string",
    "origPaymentMethod": "string",
    "bonificacao": false,
    "carrier": "string",
    "modFrete": "0 - Por conta do emitente",
    "foreseenShipment": "2019-08-24",
    "shipmentDetails": "string",
    "shipmentAddress": "Endereço da Pessoa",
    "shipment": "string",
    "shipped": true,
    "shipmentCode": "string",
    "shipmentDate": "2019-08-24",
    "approved": true,
    "description": "string",
    "saleLines": [
        {
            "productId": "string",
            "variationId": "string",
            "qty": 0,
            "price": 0,
            "details": "string",
            "detailsNF": true
        }
    ],
    "contactId": "string",
    "acquirer": {
        "isWithAcquirerFee": true,
        "acquirerId": "string",
        "feeType": "string"
    }
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/sales' \
--header 'Content-Type: application/json' \
--data-raw '{
    "child": "string",
    "total": 0,
    "dateSold": "2019-08-24",
    "fixedPaymentsDate": true,
    "type": "Venda",
    "status": "Em aberto",
    "paymentConditionType": "2x, 30 60 90",
    "paymentMethod": "Dinheiro",
    "priceList": "string",
    "payments": [
        {
            "nDup": 0,
            "dVenc": "2019-08-24",
            "vDup": 0,
            "tPag": "string",
            "acquirerFee": 0
        }
    ],
    "customer": "string",
    "customerId": "string",
    "otherExpenses": 0,
    "discount": 0,
    "discountType": "R$",
    "discountPercentage": 0,
    "transportFee": 0,
    "details": "string",
    "oc": "string",
    "sellersInfo": [
        {
            "seller": "string",
            "comissionType": "%",
            "comissionValue": 0,
            "comission": 0
        }
    ],
    "netTotal": 0,
    "negotiationStatus": "Em orçamento",
    "dueDate": "2019-08-24",
    "foreseenDelivery": "2019-08-24",
    "quoteDate": "2019-08-24",
    "orig": "string",
    "origId": "string",
    "tags": [
        {
            "tagId": "string"
        }
    ],
    "origStatus": "string",
    "origPaymentMethod": "string",
    "bonificacao": false,
    "carrier": "string",
    "modFrete": "0 - Por conta do emitente",
    "foreseenShipment": "2019-08-24",
    "shipmentDetails": "string",
    "shipmentAddress": "Endereço da Pessoa",
    "shipment": "string",
    "shipped": true,
    "shipmentCode": "string",
    "shipmentDate": "2019-08-24",
    "approved": true,
    "description": "string",
    "saleLines": [
        {
            "productId": "string",
            "variationId": "string",
            "qty": 0,
            "price": 0,
            "details": "string",
            "detailsNF": true
        }
    ],
    "contactId": "string",
    "acquirer": {
        "isWithAcquirerFee": true,
        "acquirerId": "string",
        "feeType": "string"
    }
}'

Respostas

🟢201Created

application/json

Sucesso

Body

success

boolean

opcional

Padrão:

true

message

string

opcional

Padrão:

Pedido registrado com sucesso

response

string

opcional

Id do pedido registrado

Padrão:

Id do pedido registrado

Exemplo

{
    "success": true,
    "message": "Pedido registrado com sucesso",
    "response": "Id do pedido registrado"
}