YAyampi
Pedidos - Etiquetas

Criar etiqueta

Changed on

Cria uma nova etiqueta para um pedido específico

post/{alias}/orders/{orderId}/labels

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/orders/{orderId}/labels
  • Auth
    API key in header User-Token and API key in header User-Secret-Key

Path parameters

aliasstring required

Alias da loja

orderIdinteger required

ID do pedido

Request body

codestring

Código da etiqueta

tracking_codestring

Código de rastreamento da etiqueta

tracking_urlstring

URL de rastreamento

shipping_servicestring

Nome do serviço de entrega

file_urlstring required

URL do arquivo da etiqueta

Example request

{
  "code": "123123123132",
  "tracking_code": "P182371823713BR",
  "tracking_url": "https://url.com/P182371823713BR",
  "shipping_service": "pac",
  "file_url": "https://url.com/label.pdf"
}

Response

Etiqueta criada com sucesso

Example response

{
  "data": [
    {
      "shipping_service": "pac",
      "code": "123123123132",
      "tracking_code": "P182371823713BR",
      "tracking_url": "https://url.com/P182371823713BR",
      "file_url": "https://url.com/label.pdf",
      "created_at": {
        "date": "2000-08-17 10:24:24",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      },
      "updated_at": {
        "date": "2000-08-17 10:24:24",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      }
    }
  ]
}

Changes

  • bbafb577e11cRevision changes
    • breaking

      the /// response's property type changed from string to object, and format from date-time to no format for status

    • breaking

      the /// response's property type changed from string to object, and format from date-time to no format for status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      the response optional property /// became not read-only for the status

    • info

      the response optional property /// became not read-only for the status