Campos de remessa

Referência de todos os campos de um objeto de remessa, com descrição, valor padrão e valores aceitos.

Uma remessa na API da Venddor tem várias propriedades, representadas por campos. Esta página é a lista de todos os campos aceitos, com as descrições, os valores padrão e os tipos de dados aceitos.

Campos da remessa

A tabela a seguir lista todos os campos disponíveis dos objetos de remessa.

Nome do campo	Descrição	Valor padrão	Valores aceitos
`carrier*`	Nome da transportadora	`''`	Nome válido de transportadora
`order_id*`	Id do pedido	n/d	Id de pedido válido
`products*`	Produtos enviados	n/d	Objeto JSON com o id do item do carrinho como chave e a quantidade dele como valor
`shipping*`	Nome da forma de envio	`'Custom shipping method'`	Nome válido de forma de envio
`shipping_id*`	Id da forma de envio	`1`	Id válido de forma de envio
`user_id*`	Id de usuário do cliente	n/d	Id de usuário válido
`tracking_number`	Código de rastreamento	`''`	string
`comments`	Comentários sobre a remessa	`''`	string
`group_key`	Chave do grupo de fornecedores	Definido automaticamente	Chave de grupo de fornecedores válida
`order_timestamp`	Timestamp de criação do pedido	Definido automaticamente	Timestamp válido no formato UNIX

Exemplo de requisição de remessa

json

{
  "carrier": "FedEx",
  "order_id": 78924,
  "products": {
    "467": 2,
    "589": 1
  },
  "shipping": "Express Shipping",
  "shipping_id": 3,
  "user_id": 12453,
  "tracking_number": "FDX783945201847",
  "comments": "Customer requested delivery to back door"
}

Endpoints de remessas na API

Esta página lista quatro endpoints. Todos eles são descritos, com exemplos, na página Endpoints.

Método	Caminho	Descrição
GET	`/api/shipments`	Retorna uma lista de todas as remessas
GET	`/api/shipments/{id}`	Retorna os detalhes de uma remessa específica, pelo id
POST	`/api/shipments`	Cria uma remessa nova com as informações enviadas
PUT	`/api/shipments/{id}`	Atualiza uma remessa existente com as informações enviadas

Veja também