Pedidos de Venda

Listagem de pedidos de venda com filtros específicos

GET {url_base}/orders

São permitidos apenas filtros com até 30 dias no período informado nos parâmetros from e to.

Status dos pedidos de venda disponíveis:

error, stockout, holded, waiting_label, picking, picked, packing, packed, waiting_dispatch, dispatched e cancelled

Query Parameters

Name	Type	Description
from*	DateString	Data de início da criação dos pedidos de venda para filtro Formato: YYYY-MM-DD
to*	DateString	Data de fim da criação dos pedidos de venda para filtro Formato: YYYY-MM-DD
updated*	DateString	Data de última atualização dos pedidos de venda para filtro Formato: YYYY-MM-DD
columns*	Array	Lista do nome das colunas requisitadas, separadas por vírgula

Headers

Name	Type	Description
X-Api-Key*	String	Chave de API criada através da plataforma
X-Api-Version*	String	Versão da API a ser utilizada, de acordo com a documentação Enviar "v1" como default

200: OK Pedidos de venda listados com sucesso

401: Unauthorized Acesso não autorizado

Colunas disponíveis para listagem dos pedidos de venda:

Nome	Descrição	Tipo	Formato
id	ID único da Estoca para o pedido de venda	UUID
created_at	Data de sincronização do pedido de venda	Timestamp	YYYYMMDDHHMMSS
customer_full_address	Endereço completo referente ao cliente destinatário do pedido de venda	String
customer_name	Nome completo referente ao cliente destinatário do pedido de venda	String
delivered_at	Data e hora de entrega do pedido de venda	Timestamp	YYYYMMDDHHMMSS
delivery_full_address	Endereço completo de entrega do pedido de venda	String
delivery_name	Nome do recebedor do pedido de venda	String
erp_marketplace_id	ID único externo de referência no Marketplace para o pedido de venda	String
external_id	ID único externo de referência para o pedido de venda	String
handoff_finished_at	Data e hora de despacho do pedido de venda	Timestamp	YYYYMMDDHHMMSS
handoff_idle_time	Diferença total em segundos desde última etapa antes do despacho	Int
has_extra_packaging	Indicador se o pedido de venda contém empacotamento extra	Boolean
holded_at	Data e hora de reserva do pedido de venda	Timestamp	YYYYMMDDHHMMSS
human_id	ID único da Estoca para o pedido de venda em formato legível	String
invoice_access_key	Chave de acesso da nota fiscal	String
invoice_number	Número da nota fiscal	String
invoice_serie	Série da nota fiscal	String
is_manual_order	Indicador se o pedido de venda foi criado manualmente na plataforma	Boolean
is_quarantine	Indicador se o pedido de venda está em quarentena	Boolean
is_same_day_delivery	Indicador se o pedido de venda tem entrega no mesmo dia	Boolean
marketplace_name	Nome descritivo do Marketplace	String
operator_name	E-mail do operador que despachou o pedido de venda	String
order_price	Valor total do pedido de venda	Decimal
packing_finished_at	Data e hora de finalização do empacotamento do pedido de venda	Timestamp	YYYYMMDDHHMMSS
packing_idle_time	Diferença total em segundos desde última etapa antes do empacotamento	Int
packing_packer_name	E-mail do operador que empacotou o pedido de venda	String
packing_started_at	Data e hora de início do empacotamento do pedido de venda	Timestamp	YYYYMMDDHHMMSS
packing_total_time	Tempo total em segundos do empacotamento do pedido de venda	Int
picking_finished_at	Data e hora de finalização da separação do pedido de venda	Timestamp	YYYYMMDDHHMMSS
picking_idle_time	Diferença total em segundos desde última etapa antes da separação	Int
picking_picker_name	E-mail do operador que separou o pedido de venda	String
picking_started_at	Data e hora de início da separação do pedido de venda	Timestamp	YYYYMMDDHHMMSS
picking_total_time	Tempo total em segundos da separação do pedido de venda	Int
quarantine_comment	Comentários extras da quarentena do pedido de venda	String
service_name	Nome do serviço de entrega	String
shipping_released_at	Data e hora de liberação do frete	Timestamp	YYYYMMDDHHMMSS
status	Status atual do pedido de venda	String
store_id	ID único da Estoca para a loja	UUID
store_name	Nome descritivo da Estoca para a loja	String
total_items	Quantidade total de itens no pedido de venda	Int
total_skus	Quantidade total de SKUs no pedido de venda	Int
transporter	Nome da transportadora	String
updated_at	Data e hora da última atualização do pedido de venda	Timestamp	YYYYMMDDHHMMSS
warehouse_name	ID único da Estoca para o armazém	String

Consulta de um pedido de venda específico pelo ID Estoca

GET {url_base}/orders/{id}

Status dos pedidos de venda disponíveis:

error, stockout, holded, waiting_label, picking, picked, packing, packed, waiting_dispatch, dispatched e cancelled

Path Parameters

Name	Type	Description
id*	String	ID único da Estoca para o pedido de venda

Headers

Name	Type	Description
X-Api-Key*	String	Chave de API criada através da plataforma
X-Api-Version*	String	Versão da API a ser utilizada, de acordo com a documentação Enviar "v1" como default

200: OK Pedido de venda encontrado com sucesso

{
    "status": "success",
    {
      "order_data": {
        "id": "fd59d262-1234-4c97-91d1-39c8f5g2w8f5",
        "price": 857.71,
        "freight": 38.85,
        "discount": 0,
        "total_value": 366.56,
        "human_id": "G2W.8F5",
        "synced_at": "2024-05-30 15:00:13",
        "holded_at": "2024-05-30 15:00:14",
        "date": "2024-05-30",
        "released_at": "2024-05-30 15:13:19",
        "external_id": "1234",
        "status": "dispatched",
        "store": {
          "id": "e4d62580-07d5-4ed3-a132-4ba9358rv123",
          "name": "Store Name"
        },
        "delivery": {
          "name": "Client Name",
          "transporter": "Transporter Name",
          "transporter_federal_registration": "",
          "transporter_state": "",
          "volumes": {
            "f3d49f97-f1bd-4f26-b0f1-3fa99ba55d4f": {
              "service_name": "Transporter Name",
              "tracking_code": "3528852as155"
            }
          },
          "address": {
            "zip_code": "12345678",
            "address": "Rua",
            "number": "1234",
            "complement": "Complemento",
            "neighborhood": "Bairro",
            "city": "Cidade",
            "state": "ES"
          }
        },
        "customer": {
          "name": "Client Name",
          "email": "[e-mail]",
          "federal_registration": "98544123272",
          "state_registration": null,
          "address": {
            "zip_code": "12345678",
            "address": "Rua",
            "number": "1234",
            "complement": "Complemento",
            "neighborhood": "Bairro",
            "city": "Cidade",
            "state": "ES"
          }
        },
        "marketplace": null,
        "intermediary": null,
        "invoice": {
          "requested": false
        },
        "return_invoice": null,
        "warehouse": {
          "id": "3ad1cc54-2cf5-44be-ade6-de6bdb123ABC",
          "name": "Armazém"
        },
        "items": {
          "c3ecd3a0-291a-434a-b88d-85e1ba123ABC": {
            "name": "Produto",
            "sku": "SKUCODE",
            "amount": 1.0,
            "freight": 0.0,
            "serial_number": [],
            "batch": {
                "3f37bc7e-4ab9-4378-8e36-d10df1ad428a": {
                    "expiration_date": "2024-06-30",
                    "fabrication_date": "2024-06-03",
                    "quantity": 10,
                    "batch": "01"
                },
                "2d48d541-d951-48c7-b46e-21747db177f6": {
                    "expiration_date": "2024-06-30",
                    "fabrication_date": "2024-06-03",
                    "quantity": 1,
                    "batch": "01"
                }
            },
            "holds": {
              "ef5540c4-62cf-4a2b-aabc-42c375123ABC": {
                "invoice": {
                  "number": "12345",
                  "serie": "1",
                  "issue_date": "2024-04-17 19:25:05+00:00",
                  "access_key": "35240432761719000131550010000479431123456789"
                },
                "amount": 1
              }
            }
          }
        },
        "cancel": {},
        "pick": {
          "started_at": "2024-05-31 11:43:42",
          "picker": "[e-mail]",
          "finished_at": "2024-05-31 12:09:03"
        },
        "pack": {
          "started_at": "2024-05-31 14:55:41",
          "packer": "[e-mail]",
          "finished_at": "2024-05-31 14:56:27"
        },
        "handoff": {
          "finished_at": "2024-05-31 21:19:35",
          "operator": "[e-mail]"
        },
        "tracking": {
          "status": "bipe de sa\u00edda para entrega",
          "shipped_date": "2024-06-03 21:12:57",
          "delivered_date": null
        }
      },
      "status": "success"
    }
}

200: OK Pedido em processamento

{
    "status": "Order processing",
    "order_data": {}
}

400: Bad Request Pedido de venda com erro no processamento

{
    "status": "Order processed with error",
    "order_data": {}
}

401: Unauthorized Acesso não autorizado

404: Not Found Pedido de venda não encontrado

{
    "status": "No order found",
    "order_data": {}
}

Consulta de um pedido de venda específico pelo ID externo de referência

GET {url_base}/orders/{id}/external

ID externo pode ser uma referência no ERP ou Marketplace, de acordo com a origem do pedido de venda para integração na plataforma.

Status dos pedidos de venda disponíveis:

error, stockout, holded, waiting_label, picking, picked, packing, packed, waiting_dispatch, dispatched e cancelled

Path Parameters

Name	Type	Description
id*	String	ID único externo de referência para o pedido de venda

Headers

Name	Type	Description
X-Api-Key*	String	Chave de API criada através da plataforma
X-Api-Version*	String	Versão da API a ser utilizada, de acordo com a documentação Enviar "v1" como default

200: OK Pedido de venda encontrado com sucesso

{
    "status": "success",
    {
      "order_data": {
        "id": "fd59d262-1234-4c97-91d1-39c8f5g2w8f5",
        "price": 857.71,
        "freight": 38.85,
        "discount": 0,
        "total_value": 366.56,
        "human_id": "G2W.8F5",
        "synced_at": "2024-05-30 15:00:13",
        "holded_at": "2024-05-30 15:00:14",
        "date": "2024-05-30",
        "released_at": "2024-05-30 15:13:19",
        "external_id": "1234",
        "status": "dispatched",
        "store": {
          "id": "e4d62580-07d5-4ed3-a132-4ba9358rv123",
          "name": "Store Name"
        },
        "delivery": {
          "name": "Client Name",
          "transporter": "Transporter Name",
          "transporter_federal_registration": "",
          "transporter_state": "",
          "volumes": {
            "f3d49f97-f1bd-4f26-b0f1-3fa99ba55d4f": {
              "service_name": "Transporter Name",
              "tracking_code": "3528852as155"
            }
          },
          "address": {
            "zip_code": "12345678",
            "address": "Rua",
            "number": "1234",
            "complement": "Complemento",
            "neighborhood": "Bairro",
            "city": "Cidade",
            "state": "ES"
          }
        },
        "customer": {
          "name": "Client Name",
          "email": "[e-mail]",
          "federal_registration": "98544123272",
          "state_registration": null,
          "address": {
            "zip_code": "12345678",
            "address": "Rua",
            "number": "1234",
            "complement": "Complemento",
            "neighborhood": "Bairro",
            "city": "Cidade",
            "state": "ES"
          }
        },
        "marketplace": null,
        "intermediary": null,
        "invoice": {
          "requested": false
        },
        "return_invoice": null,
        "warehouse": {
          "id": "3ad1cc54-2cf5-44be-ade6-de6bdb123ABC",
          "name": "Armazém"
        },
        "items": {
          "c3ecd3a0-291a-434a-b88d-85e1ba123ABC": {
            "name": "Produto",
            "sku": "SKUCODE",
            "amount": 1.0,
            "freight": 0.0,
            "serial_number": [],
            "batch": {
                "3f37bc7e-4ab9-4378-8e36-d10df1ad428a": {
                    "expiration_date": "2024-06-30",
                    "fabrication_date": "2024-06-03",
                    "quantity": 10,
                    "batch": "01"
                },
                "2d48d541-d951-48c7-b46e-21747db177f6": {
                    "expiration_date": "2024-06-30",
                    "fabrication_date": "2024-06-03",
                    "quantity": 1,
                    "batch": "01"
                }
            },
            "holds": {
              "ef5540c4-62cf-4a2b-aabc-42c375123ABC": {
                "invoice": {
                  "number": "12345",
                  "serie": "1",
                  "issue_date": "2024-04-17 19:25:05+00:00",
                  "access_key": "35240432761719000131550010000479431123456789"
                },
                "amount": 1
              }
            }
          }
        },
        "cancel": {},
        "pick": {
          "started_at": "2024-05-31 11:43:42",
          "picker": "[e-mail]",
          "finished_at": "2024-05-31 12:09:03"
        },
        "pack": {
          "started_at": "2024-05-31 14:55:41",
          "packer": "[e-mail]",
          "finished_at": "2024-05-31 14:56:27"
        },
        "handoff": {
          "finished_at": "2024-05-31 21:19:35",
          "operator": "[e-mail]"
        },
        "tracking": {
          "status": "bipe de sa\u00edda para entrega",
          "shipped_date": "2024-06-03 21:12:57",
          "delivered_date": null
        }
      },
      "status": "success"
    }
}

200: OK Pedido de venda em processamento

{
    "status": "Order processing",
    "order_data": {}
}

400: Bad Request Pedido de venda com erro no processamento

{
    "status": "Order processed with error",
    "order_data": {}
}

401: Unauthorized Acesso não autorizado

404: Not Found Pedido de venda não encontrado

{
    "status": "No order found",
    "order_data": {}
}

Criação de novo pedido de venda

POST {url_base}/orders

A criação de pedidos de venda funciona de forma assíncrona, ou seja, o ID do pedido que retorna na resposta da rota é o ID reservado para aquele pedido, porém o pedido passará por uma fila de integração, e precisa de verificação para saber se o mesmo foi criado de fato, ou se houve alguma falha. (o pedido pode ser consultado utilizando esse método)

Headers

Name	Type	Description
X-Api-Key*	String	Chave de API criada através da plataforma
X-Api-Version*	String	Versão da API a ser utilizada, de acordo com a documentação Enviar "v1" como default

Request Body

Name	Type	Description
order*	Object	Objeto do pedido de venda
order.date*	DateString	Data de criação do pedido de venda Formato: YYYY-MM-DD HH:mm:ss
order.id*	String	ID único externo de referência para o pedido de venda
order.external_id	String	ID único auxiliar de referência para o pedido de venda
order.marketplace_name	String	Nome descritivo do Marketplace, de acordo com a origem do pedido de venda
order.marketplace_id	String	ID único do Marketplace, de acordo com a origem do pedido de venda
order.total_value*	String	Valor total do pedido de venda Formato: 0.00
order.freight_value	String	Valor de frete do pedido de venda Formato: 0.00
order.status	String	Status do pedido de venda
order.integration_type	String	Tipo de integração para referência interna do pedido de venda
order.client	Object	Objeto do cliente destinatário do pedido de venda
order.client.name*	String	Nome ou razão social do cliente destinatário do pedido de venda
order.client.cnpj*	String	CNPJ ou CPF do cliente destinatário do pedido de venda
order.client.ie	String	Inscrição estuadal do cliente destinatário do pedido de venda
order.client.rg	String	RG do cliente destinatário do pedido de venda
order.client.email	String	E-mail do cliente destinatário do pedido de venda
order.client.mobile	String	Telefone celular do cliente destinatário do pedido de venda
order.client.phone	String	Telefone fixo ou comercial do cliente destinatário do pedido de venda
order.client.address	String	Logradouro do cliente destinatário do pedido de venda
order.client.number	String	Número referente ao endereço do cliente destinatário do pedido de venda
order.client.complement	String	Complemente referente ao endereço do cliente destinatário do pedido de venda
order.client.neighborhood	String	Bairro referente ao endereço do cliente destinatário do pedido de venda
order.client.city	String	Cidade referente ao endereço do cliente destinatário do pedido de venda
order.client.zip_code	String	Código de CEP referente ao endereço do cliente destinatário do pedido de venda Utilizar base dos Correios Formato: 00000-000
order.client.state	String	Estado referente ao endereço do cliente destinatário do pedido de venda
order.intermediary	Object	Objeto do intermediador do pedido de venda
order.intermediary.name	String	Nome de usuário do intermediador do pedido de venda
order.intermediary.federal_registration	String	CNPJ do intermediador do pedido de venda
order.items*	Array	Objeto dos produtos pertencentes ao pedido de venda
order.items.sku*	String	SKU do produto, de acordo com a nota fiscal e catálogo da plataforma
order.items.quantity*	String	Quantidade do produto, de acordo com a nota fiscal
order.items.name*	String	Nome do produto, de acordo com a nota fiscal
order.items.value*	String	Preço unitário do produto, de acordo com a nota fiscal Formato: 0.00
order.invoice*	Object	Objeto da nota fiscal de venda
order.invoice.number*	String	Número da nota fiscal
order.invoice.serie*	String	Série da nota fiscal
order.invoice.access_key*	String	Chave de acesso da nota fiscal
order.invoice.status*	String	Status da nota fiscal
order.invoice.value*	String	Valor total da nota fiscal Formato: 0.00
order.invoice.issue_date*	String	Data de emissão da nota fiscal Formato: YYYY-MM-DD HH:mm:ss
order.invoice.xml*	String	Conteúdo literal do XML da nota fiscal
order.transport*	Object	Objeto de dados do transporte
order.transport.transporter*	String	Nome da tansportadora
order.transport.volumes*	Array	Objeto de volumes de transporte
order.transport.volumes.service_name*	String	Nome do serviço para entrega
order.transport.volumes.tracking_code	String	Código de rastreio da entrega
order.transport.volumes.label	String	Link da etiqueta de transportes para entrega Formato: URL pública completa e sem autenticação via cabeçalho da requisição
order.transport.delivery_address*	Object	Objeto de entrega do transporte
order.transport.delivery_address.name*	String	Nome do recebedor para entrega do pedido de venda
order.transport.delivery_address.address*	String	Logradouro para entrega do pedido de venda
order.transport.delivery_address.number*	String	Número do logradouro para entrega do pedido de venda
order.transport.delivery_address.complement*	String	Complemento do logradouro para entrega do pedido de venda
order.transport.delivery_address.neighborhood*	String	Bairro do logradouro para entrega do pedido de venda
order.transport.delivery_address.zip_code*	String	Código de CEP do logradouro para entrega do pedido de venda
order.transport.delivery_address.city*	String	Cidade do logradouro para entrega do pedido de venda
order.transport.delivery_address.state*	String	Estado referente ao endereço de entrega do pedido de venda

* Propriedades obrigatórias

* Propriedades obrigatórias quando o objeto pai for enviado

200: OK Pedido de venda criado com sucesso

{
    "status": "Order Created: [UUID('00000000-0000-0000-0000-000000000000')]"
}

401: Unauthorized Acesso não autorizado

Payload de exemplo:

{
  "order": {
    "date": "2024-10-22 00:00:00",
    "id": "000101",
    "external_id": "0632c43c-5276-4401-8fac-bd8949afebfe",
    "total_value": "39.11",
    "integration_type": "API",
    "client": {
      "name": "Letícia Almeida Castro",
      "cnpj": "894.105.169-00",
      "email": "[e-mail]",
      "phone": "(11) 4211-2384",
      "address": "Rua Noel Rosa",
      "number": "1944",
      "complement": "",
      "neighborhood": "Planalto",
      "city": "São Bernardo do Campo",
      "zip_code": "09896-350",
      "state": "SP"
    },
    "items": [
      {
        "sku": "952181",
        "quantity": "3",
        "name": "Produto Teste",
        "value": "8.8"
      }
    ],
    "invoice": {
      "number": "000000001",
      "serie": "001",
      "access_key": "31240940595809000713550010000000011527903731",
      "status": "Autorizada",
      "value": "39.11",
      "issue_date": "2024-10-22 00:00:00",
      "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?> <nfeProc xmlns=\"http://www.portalfiscal.inf.br/nfe\" versao=\"4.00\"> <NFe xmlns=\"http://www.portalfiscal.inf.br/nfe\"> <infNFe Id=\"NFe31240940595809000713550010000000011527903730\" versao=\"4.00\"> <ide> <cUF>31</cUF> <cNF>52790373</cNF> <natOp>VENDA MERC. RECEB.TERC. C/ S.TRIBUT. CONT. SUBSTITUIDO</natOp> <mod>55</mod> <serie>1</serie> <nNF>1</nNF> <dhEmi>2024-09-26T15: 59: 00-03: 00</dhEmi> <dhSaiEnt>2024-09-26T15: 59: 00-03: 00</dhSaiEnt> <tpNF>1</tpNF> <idDest>1</idDest> <cMunFG>3125101</cMunFG> <tpImp>1</tpImp> <tpEmis>1</tpEmis> <cDV>0</cDV> <tpAmb>2</tpAmb> <finNFe>1</finNFe> <indFinal>1</indFinal> <indPres>2</indPres> <indIntermed>0</indIntermed> <procEmi>0</procEmi> <verProc>12.1.2310 | 3.0</verProc> </ide> <emit> <CNPJ>40595809000713</CNPJ> <xNome>SP. SUMARE - EXTREMA - MG</xNome> <xFant>SP. SUMARE - EXTREMA - MG</xFant> <enderEmit> <xLgr>AV JOAQUIM LOURENCO DE LIMA</xLgr> <nro>2150</nro> <xCpl>GALPAO11 Q</xCpl> <xBairro>VARGEM DO JOAO PINTO</xBairro> <cMun>3125101</cMun> <xMun>EXTREMA</xMun> <UF>MG</UF> <CEP>37644901</CEP> <cPais>1058</cPais> <xPais>BRASIL</xPais> <fone>1130265999</fone> </enderEmit> <IE>0048727000060</IE> <CRT>3</CRT> </emit> <dest> <CPF>56035322620</CPF> <xNome>NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL</xNome> <enderDest> <xLgr>Rua Noel Rosa</xLgr> <nro>1944</nro> <xBairro>Planalto</xBairro> <cMun>3106200</cMun> <xMun>São Bernardo do Campo</xMun> <UF>SP</UF> <CEP>30180109</CEP> <cPais>1058</cPais> <xPais>BRASIL</xPais> <fone>1142112384</fone> </enderDest> <indIEDest>9</indIEDest> <email>[e-mail]</email> </dest> <det nItem=\"1\"> <prod> <cProd>952181</cProd> <cEAN>27898085944749</cEAN> <xProd>CAC OLEO CORPORAL SUAVE 120ML 12UN</xProd> <NCM>33072090</NCM> <CEST>2002900</CEST> <cBenef></cBenef> <CFOP>5405</CFOP> <uCom>UN</uCom> <qCom>3.0000</qCom> <vUnCom>8.8000000000</vUnCom> <vProd>26.40</vProd> <cEANTrib>7898085944745</cEANTrib> <uTrib>UN</uTrib> <qTrib>3.0000</qTrib> <vUnTrib>8.8000000000</vUnTrib> <vFrete>12.71</vFrete> <indTot>1</indTot> <xPed>615492</xPed> <nItemPed>01</nItemPed> </prod> <imposto> <ICMS> <ICMS60> <orig>0</orig> <CST>60</CST> <vBCSTRet>0</vBCSTRet> <pST>0.0000</pST> <vICMSSubstituto>0</vICMSSubstituto> <vICMSSTRet>0</vICMSSTRet> <pRedBCEfet>0.0000</pRedBCEfet> <vBCEfet>39.11</vBCEfet> <pICMSEfet>18.0000</pICMSEfet> <vICMSEfet>7.04</vICMSEfet> </ICMS60> </ICMS> <IPI> <cEnq>999</cEnq> <IPINT> <CST>53</CST> </IPINT> </IPI> <PIS> <PISAliq> <CST>02</CST> <vBC>39.11</vBC> <pPIS>1.6500</pPIS> <vPIS>0.65</vPIS> </PISAliq> </PIS> <COFINS> <COFINSAliq> <CST>02</CST> <vBC>39.11</vBC> <pCOFINS>7.6000</pCOFINS> <vCOFINS>2.97</vCOFINS> </COFINSAliq> </COFINS> </imposto> <infAdProd>- EAN: 27898085944749 - EANTrib: 7898085944745</infAdProd> </det> <total> <ICMSTot> <vBC>0</vBC> <vICMS>0</vICMS> <vICMSDeson>0</vICMSDeson> <vFCPUFDest>0</vFCPUFDest> <vICMSUFDest>0</vICMSUFDest> <vICMSUFRemet>0</vICMSUFRemet> <vFCP>0</vFCP> <vBCST>0</vBCST> <vST>0</vST> <vFCPST>0</vFCPST> <vFCPSTRet>0</vFCPSTRet> <vProd>26.40</vProd> <vFrete>12.71</vFrete> <vSeg>0</vSeg> <vDesc>0</vDesc> <vII>0</vII> <vIPI>0</vIPI> <vIPIDevol>0</vIPIDevol> <vPIS>0.65</vPIS> <vCOFINS>2.97</vCOFINS> <vOutro>0</vOutro> <vNF>39.11</vNF> </ICMSTot> </total> <transp> <modFrete>0</modFrete> <transporta> <xNome>TEX COURIER LTDA</xNome> <IE>206214714111</IE> <xEnder>AV PIRACEMA, 155</xEnder> <xMun>BARUERI</xMun> <UF>SP</UF> </transporta> <vol> <esp>CAIXA</esp> <pesoL>0.360</pesoL> <pesoB>0.437</pesoB> </vol> </transp> <cobr> <fat> <nFat>001000000001</nFat> <vOrig>39.11</vOrig> <vDesc>0</vDesc> <vLiq>39.11</vLiq> </fat> <dup> <nDup>001</nDup> <dVenc>2024-09-26</dVenc> <vDup>39.11</vDup> </dup> </cobr> <pag> <detPag> <indPag>0</indPag> <tPag>15</tPag> <vPag>39.11</vPag> </detPag> </pag> <infAdic> <infCpl>- Pedido: 615492- Vendedor: VENDEDOR LOJA VIRTUAL- Via de Transporte: Rodoviario- Cond.Pagto.: A VISTA- Frete: CIF</infCpl> </infAdic> <infRespTec> <CNPJ>53113791000122</CNPJ> <xContato>Rodrigo de Almeida Sartorio</xContato> <email>[e-mail]</email> <fone>1128593904</fone> </infRespTec> </infNFe> <Signature xmlns=\"http://www.w3.org/2000/09/xmldsig#\"> <SignedInfo xmlns=\"http://www.w3.org/2000/09/xmldsig#\"> <CanonicalizationMethod Algorithm=\"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"></CanonicalizationMethod> <SignatureMethod Algorithm=\"http://www.w3.org/2000/09/xmldsig#rsa-sha1\"></SignatureMethod> <Reference URI=\"#NFe31240940595809000713550010000000011527903730\"> <Transforms> <Transform Algorithm=\"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"></Transform> <Transform Algorithm=\"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"></Transform> </Transforms> <DigestMethod Algorithm=\"http://www.w3.org/2000/09/xmldsig#sha1\"></DigestMethod> <DigestValue>c42VHgKIrwAbpU8TjAGaiggo1OY=</DigestValue> </Reference> </SignedInfo> <SignatureValue>WW5/4ZG/XdgNgkJBwkm/hhlpLoiUp66MtjcyD0c5ABhNHhO3LDS5aH6MJWwE2hnp4GdCWdTdXLGuTT7J6YZb/fozmqgkE7+2TkFHXD7+ROKu2QkwSzOrfkL/PE3k9gzaoiqHwraxJhK/RMQ1Y4NZDjsc/gAANSdj6FJQFogTkqrwmmA3EN4+MBct6km8/uuKUIwWTMNdfRAsN3sFr4pc3IWOKc/JukR5APbS8mXZaO6Ii0r1BLbRBZeXJEQNlpQFeYbgGRRIX4Ih8M2+hNegCeB4SzXN/jE3AHnwAqaRf6NAempSjksOnT3/8BbyCy/XuP0ElD1/iMk/uMhpYWo9tw==</SignatureValue> <KeyInfo> <X509Data> <X509Certificate>MIIH6DCCBdCgAwIBAgIUAzVwhM0zBPAfPUj69uvOh9S6BvkwDQYJKoZIhvcNAQELBQAwejELMAkGA1UEBhMCQlIxEzARBgNVBAoTCklDUC1CcmFzaWwxNjA0BgNVBAsTLVNlY3JldGFyaWEgZGEgUmVjZWl0YSBGZWRlcmFsIGRvIEJyYXNpbCAtIFJGQjEeMBwGA1UEAxMVQUMgRElHSVRBTFNJR04gUkZCIEczMB4XDTI0MDYxMDE2NTMyMVoXDTI1MDYxMDE2NTMyMVowggEBMQswCQYDVQQGEwJCUjETMBEGA1UECgwKSUNQLUJyYXNpbDELMAkGA1UECAwCTUcxEDAOBgNVBAcMB0V4dHJlbWExNjA0BgNVBAsMLVNlY3JldGFyaWEgZGEgUmVjZWl0YSBGZWRlcmFsIGRvIEJyYXNpbCAtIFJGQjEWMBQGA1UECwwNUkZCIGUtQ05QSiBBMTEXMBUGA1UECwwOMjQxODEyNTMwMDAxNzcxGTAXBgNVBAsMEHZpZGVvY29uZmVyZW5jaWExOjA4BgNVBAMMMVNQIFNVTUFSRSBQUk9EVVRPUyBERSBISUdJRU5FIExUREE6NDA1OTU4MDkwMDA3MTMwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCv1uybp0F52hm3CFwtSvmJgq+Byq1cS47mcUmJMb73FnoHsm0A5PmY+RVU2OiI69uXXViMNHWSeFbiFi7QZVr3wYU2Tg0OXFBt/eY93GQDRYKBhyaAu/7rKGdroDphszwWKgv3gf/WmXhI26rQFAUaPBNaRviLhpJ1TWJLRW9c4DC4v558ZdY1bN7dIhI9Nxzo6lL5UgZl5lqzXFuJ/Moq6khISo3NCfb5C4ijeJpItVQ5mNLXrhMvJhV/drT2m1TxDq0muQ+sDlIpvgLBasXGrMxPgSSAoOgraelGNQ9CZwyDpNQQVKwsFJZ2rdqWu4j54Fze4NKenaL58uAkgtx9AgMBAAGjggLbMIIC1zAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFN24td0C3LhQyn4GVEPBfvyu9K17MIGoBggrBgEFBQcBAQSBmzCBmDBdBggrBgEFBQcwAoZRaHR0cDovL3d3dy5kaWdpdGFsc2lnbmNlcnRpZmljYWRvcmEuY29tLmJyL3JlcG9zaXRvcmlvL3JmYi9BQ0RJR0lUQUxTSUdOUkZCRzMucDdiMDcGCCsGAQUFBzABhitodHRwOi8vb2NzcC5kaWdpdGFsc2lnbmNlcnRpZmljYWRvcmEuY29tLmJyMF0GA1UdIARWMFQwUgYGYEwBAgEsMEgwRgYIKwYBBQUHAgEWOmh0dHA6Ly93d3cuZGlnaXRhbHNpZ25jZXJ0aWZpY2Fkb3JhLmNvbS5ici9yZXBvc2l0b3Jpby9yZmIwHQYDVR0lBBYwFAYIKwYBBQUHAwIGCCsGAQUFBwMEMIGxBgNVHR8EgakwgaYwV6BVoFOGUWh0dHA6Ly93d3cuZGlnaXRhbHNpZ25jZXJ0aWZpY2Fkb3JhLmNvbS5ici9yZXBvc2l0b3Jpby9yZmIvQUNESUdJVEFMU0lHTlJGQkczLmNybDBLoEmgR4ZFaHR0cDovL3d3dy5kaWdpdGFsdHJ1c3QuY29tLmJyL3JlcG9zaXRvcmlvL3JmYi9BQ0RJR0lUQUxTSUdOUkZCRzMuY3JsMA4GA1UdDwEB/wQEAwIF4DCBuwYDVR0RBIGzMIGwgRVjb250YWJpbEBmaW9yZS5jbnQuYnKgPQYFYEwBAwSgNAQyMDEwOTE5OTU0MzQ3Njc4OTgzNzAwMDAwMDAwMDAwMDAwMDAwMzQxNTk3OTcxU1NQU1CgJAYFYEwBAwKgGwQZTUFOQVNIQSBWRU5BTkNJTyBNT1JJWk9OT6AZBgVgTAEDA6AQBA40MDU5NTgwOTAwMDcxM6AXBgVgTAEDB6AOBAwwMDAwMDAwMDAwMDAwDQYJKoZIhvcNAQELBQADggIBAHA9EQGst9YCAQLpW8hieoNaUVKCFTj8A0wtqHhuSSF/ZP6gQZk+/ASIox9ZEPgEH/STUn+QUNLWXfEpkLXR4qBacP8QUvZYDFWiSgbqsuc6nwQRwGFLwRSkhjcdjjHiVTmAT64QDxsv+vsFLSDXdFLEAADA+Pl/+iiAWWBmlr3ejIYXvcK0Jmlsn0Xo1TwQkW/9t5e4Lu45R2vwXvfusqMqOKNkj69ovUyaB8EIFAdHE2WmuFLU6Y35GZD6VKOVRNFXIJ62SKB1xo+odyymk9h/DDoTkeF7kJzIdxNxzb8z7ChN1F2skAzVMuE5I71pfyaAhqD9ROR/ofqtuihzwED9M1zVC2z2B5lejVOwoyCDQ/itICkPszuOXaxOFFAQUIA1ssJHKl5J6lROh+TxE8oFSsmnMGCf8iaWuUqTHR2vJRrbhRzJMDPa+MTDfv4Nra0UHLTQ+X/teyss/jq66XPi/olHtHAa7mZ0itPtmJAAbd34mvZukDVqDVTvbr8bdXWf5v+iXRIKFsBNYkAZbWZaegVI0U/ANaE+yBuWVQ/+gtavLlM9CL9em0j33GvMei4eNkiohaT6z9rr+g81 //q2BrQEaSTDmlVcL6oxsj7btOrwz+NHSGfjXcc9JjRgr43D6IQONy1/hDNlgcf5ipGN2GGu4oy6TuelIhSjjexo</X509Certificate> </X509Data> </KeyInfo> </Signature> </NFe> <protNFe xmlns=\"http://www.portalfiscal.inf.br/nfe\" versao=\"4.00\"> <infProt> <tpAmb>2</tpAmb> <verAplic>J-3.2.57</verAplic> <chNFe>31240940595809000713550010000000011527903730</chNFe> <dhRecbto>2024-09-26T16: 01: 38-03: 00</dhRecbto> <nProt>131240149311126</nProt> <digVal>c42VHgKIrwAbpU8TjAGaiggo1OY=</digVal> <cStat>100</cStat> <xMotivo>Autorizado o uso da NF-e</xMotivo> </infProt> </protNFe> </nfeProc>"
    },
    "transport": {
      "transporter": "ESTOCA TECNOLOGIAS DO BRASIL LTDA",
      "delivery_address": {
        "name": "Letícia Almeida Castro",
        "address": "Rua Noel Rosa",
        "number": "1944",
        "complement": "",
        "neighborhood": "Planalto",
        "city": "São Bernardo do Campo",
        "zip_code": "09896-350",
        "state": "SP"
      },
      "volumes": [
        {
          "service_name": "Expresso"
        }
      ]
    }
  }
}

Atualização de um pedido de venda

PUT {url_base}/orders

Headers

Name	Type	Description
X-Api-Key*	String	Chave de API criada através da plataforma
X-Api-Version*	String	Versão da API a ser utilizada, de acordo com a documentação Enviar "v1" como default

Request Body

Name	Type	Description
order*	Object	Objeto do pedido de venda
order.date*	DateString	Data de criação do pedido de venda Formato: YYYY-MM-DD HH:mm:ss
order.id*	String	ID único externo de referência para o pedido de venda
order.external_id	String	ID único auxiliar de referência para o pedido de venda
order.marketplace_name	String	Nome descritivo do Marketplace, de acordo com a origem do pedido de venda
order.marketplace_id	String	ID único do Marketplace, de acordo com a origem do pedido de venda
order.total_value*	String	Valor total do pedido de venda Formato: 0.00
order.freight_value	String	Valor de frete do pedido de venda Formato: 0.00
order.status	String	Status do pedido de venda
order.integration_type	String	Tipo de integração para referência interna do pedido de venda
order.client	Object	Objeto do cliente destinatário do pedido de venda
order.client.name*	String	Nome ou razão social do cliente destinatário do pedido de venda
order.client.cnpj*	String	CNPJ ou CPF do cliente destinatário do pedido de venda
order.client.ie	String	Inscrição estuadal do cliente destinatário do pedido de venda
order.client.rg	String	RG do cliente destinatário do pedido de venda
order.client.email	String	E-mail do cliente destinatário do pedido de venda
order.client.mobile	String	Telefone celular do cliente destinatário do pedido de venda
order.client.phone	String	Telefone fixo ou comercial do cliente destinatário do pedido de venda
order.client.address	String	Logradouro do cliente destinatário do pedido de venda
order.client.number	String	Número referente ao endereço do cliente destinatário do pedido de venda
order.client.complement	String	Complemente referente ao endereço do cliente destinatário do pedido de venda
order.client.neighborhood	String	Bairro referente ao endereço do cliente destinatário do pedido de venda
order.client.city	String	Cidade referente ao endereço do cliente destinatário do pedido de venda
order.client.zip_code	String	Código de CEP referente ao endereço do cliente destinatário do pedido de venda Utilizar base dos Correios Formato: 00000-000
order.client.state	String	Estado referente ao endereço do cliente destinatário do pedido de venda
order.intermediary	Object	Objeto do intermediador do pedido de venda
order.intermediary.name	String	Nome de usuário do intermediador do pedido de venda
order.intermediary.federal_registration	String	CNPJ do intermediador do pedido de venda
order.items*	Object	Objeto dos produtos pertencentes ao pedido de venda
order.items.sku*	String	SKU do produto, de acordo com a nota fiscal e catálogo da plataforma
order.items.quantity*	String	Quantidade do produto, de acordo com a nota fiscal
order.items.name*	String	Nome do produto, de acordo com a nota fiscal
order.items.value*	String	Preço unitário do produto, de acordo com a nota fiscal Formato: 0.00
order.invoice*	Object	Objeto da nota fiscal de venda
order.invoice.number*	String	Número da nota fiscal
order.invoice.serie*	String	Série da nota fiscal
order.invoice.access_key	String	Chave de acesso da nota fiscal
order.invoice.status	String	Status da nota fiscal
order.invoice.value	String	Valor total da nota fiscal Formato: 0.00
order.invoice.issue_date	String	Data de emissão da nota fiscal
order.invoice.xml	String	Conteúdo literal do XML da nota fiscal (deve ser o xml da nota autorizada)
order.transport*	Object	Objeto de dados do transporte
order.transport.transporter*	String	Nome da transportadora
order.transport.volumes*	Object	Objeto de volumes de transporte
order.transport.volumes.service_name*	String	Nome do serviço para entrega
order.transport.volumes.tracking_code	String	Código de rastreio da entrega
order.transport.volumes.label	String	Link da etiqueta de transportes para entrega Formato: URL pública completa e sem autenticação via cabeçalho da requisição
order.transport.delivery_address*	Object	Objeto de entrega do transporte
order.transport.delivery_address.name*	String	Nome do recebedor para entrega do pedido de venda
order.transport.delivery_address.address*	String	Logradouro para entrega do pedido de venda
order.transport.delivery_address.number*	String	Número do logradouro para entrega do pedido de venda
order.transport.delivery_address.complement*	String	Complemento do logradouro para entrega do pedido de venda
order.transport.delivery_address.neighborhood*	String	Bairro do logradouro para entrega do pedido de venda
order.transport.delivery_address.zip_code*	String	Código de CEP do logradouro para entrega do pedido de venda
order.transport.delivery_address.city*	String	Cidade do logradouro para entrega do pedido de venda

200: OK Pedido de venda atualizado com sucesso

{
    "status": "Order Created: [UUID('00000000-0000-0000-0000-000000000000')]"
}

400: Bad Request Pedido de venda em processamento

{
    "status": "Order processing",
    "order_data": {}
}

401: Unauthorized Acesso não autorizado