HomeGuidesAPI Reference
Log In
API Reference

Criar Shipment assíncrono.

Cria um Shipment de forma assíncrona. Para iniciar um envio, você precisará de um endereço de origem, outro de destino e um pacote.

Teste abaixo o endpoint

⚠️ Os campos abaixo precisam ser preenchidos para realização dos testes de endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identificador do embarcador

Body Params

Os objetos correiosAddress e lineAddress são mutuamente exclusivos. Ao atribuir os valores de shipFrom.address e shipTo.address é necessário informar apenas um tipo de endereço, o padrão internacional ou Correios. Exemplos:

  • shipTo.address.addressLines = {...} ou shipTo.address.correiosAddress = {...} .
  • shipFrom.address.addressLines = {...} ou shipFrom.address.correiosAddress = {...} .

Objeto que representa a criação de um shipment de forma assíncrona.

shipFrom
object
required

Objeto que representa os dados do embarcador.

shipTo
object
required

Objeto que representa os dados do recebedor.

returnTo
object

Objeto que representa os dados para a devolução do pacote.

shippingCompany
object

Identifica a transportadora responsável pelo pacote no fluxo de operação universal.

packages
array of objects | null
required

Pacote associado ao envio. A soma das medidas (altura, largura e comprimento) do pacote não podem passar de 200 cm.

packages*
string | null
required

Deverá ser informado pelo Sales Engineering responsável pela sua homologação.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json