API legada/Referência completa/Pedidos (REST)

Obter um pedido

Retorna os detalhes completos de um pedido pelo id: cliente, valores, pagamento, entrega, produtos e endereços.

Este endpoint retorna as informações detalhadas de um pedido específico, pelo identificador único dele. Use-o depois de listar os pedidos, quando precisar dos produtos, da forma de pagamento e dos endereços de um pedido.

Quando o pedido existe, você recebe HTTP/1.1 200 OK e um corpo JSON com os detalhes do pedido. Quando ele não existe, você recebe HTTP/1.1 404 Not Found.

GET/api/orders/{order_id}Admin

Obter um pedido específico pelo id

Parâmetros de caminho

order_idintegerobrigatório

O identificador único do pedido.

Exemplo de requisição

A requisição GET /api/orders/100 retorna o pedido de id 100.

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/orders/100"

Resposta

200Pedido encontrado

json

{
  "order_id": "100",
  "is_parent_order": "N",
  "parent_order_id": "0",
  "status": "P",
  "timestamp": "1627294200",
  "company_id": "1",
  "user_id": "5",
  "firstname": "Jane",
  "lastname": "Smith",
  "email": "jane.smith@example.com",
  "phone": "+1 (555) 123-4567",
  "total": "145.50",
  "subtotal": "135.00",
  "shipping_cost": "10.50",
  "payment_id": "2",
  "payment_method": {
    "payment_id": "2",
    "payment": "Credit Card",
    "description": "Visa, MasterCard, Discover, American Express",
    "status": "A"
  },
  "shipping_id": "1",
  "shipping": [
    {
      "shipping_id": "1",
      "shipping": "Standard Shipping",
      "delivery_time": "3-5 business days",
      "status": "A"
    }
  ],
  "products": [
    {
      "item_id": "5432123",
      "product_id": "12",
      "product": "Premium T-Shirt",
      "price": "45.00",
      "amount": "3"
    }
  ],
  "s_firstname": "Jane",
  "s_lastname": "Smith",
  "s_address": "123 Main St",
  "s_city": "New York",
  "s_state": "NY",
  "s_country": "US",
  "s_zipcode": "10001",
  "b_firstname": "Jane",
  "b_lastname": "Smith",
  "b_address": "123 Main St",
  "b_city": "New York",
  "b_state": "NY",
  "b_country": "US",
  "b_zipcode": "10001"
}

Campos da resposta

Informações básicas do pedido

Campos da resposta

order_idstring

O identificador único do pedido.

is_parent_orderstring

YN

"Y" se este for um pedido pai, "N" caso contrário.

parent_order_idstring

Id do pedido pai (quando este é um pedido filho).

statusstring

Código de status do pedido (por exemplo, "P" para Processado, "C" para Concluído).

timestampstring

Timestamp UNIX do momento em que o pedido foi feito.

company_idstring

Id do vendedor/empresa.

Informações do cliente

Campos da resposta

user_idstring

Id de usuário do cliente (0 para pedidos de visitantes).

firstnamestring

Nome do cliente.

lastnamestring

Sobrenome do cliente.

emailstring

E-mail do cliente.

phonestring

Telefone do cliente.

Informações financeiras

Campos da resposta

totalstring

Valor total do pedido, incluindo o frete.

subtotalstring

Subtotal do pedido (antes do frete).

shipping_coststring

Custo do frete.

payment_idstring

Id da forma de pagamento.

payment_methodobject

Detalhes da forma de pagamento.

Informações de entrega

Campos da resposta

shipping_idstring

Id da forma de envio.

shippingarray

Detalhes da(s) forma(s) de envio.

s_firstname, s_lastname, etc.string

Campos do endereço de entrega (prefixo s_*).

b_firstname, b_lastname, etc.string

Campos do endereço de cobrança (prefixo b_*).

Erros

Status	Quando
`200 OK`	O pedido existe e os detalhes dele estão no corpo.
`404 Not Found`	O pedido não existe.

Veja também

Obter um pedido

Retorna os detalhes completos de um pedido pelo id: cliente, valores, pagamento, entrega, produtos e endereços.

Quando o pedido existe, você recebe HTTP/1.1 200 OK e um corpo JSON com os detalhes do pedido. Quando ele não existe, você recebe HTTP/1.1 404 Not Found.

GET/api/orders/{order_id}Admin

Obter um pedido específico pelo id

Parâmetros de caminho

order_idintegerobrigatório

O identificador único do pedido.

Exemplo de requisição

A requisição GET /api/orders/100 retorna o pedido de id 100.

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/orders/100"

Resposta

200Pedido encontrado

json

{
  "order_id": "100",
  "is_parent_order": "N",
  "parent_order_id": "0",
  "status": "P",
  "timestamp": "1627294200",
  "company_id": "1",
  "user_id": "5",
  "firstname": "Jane",
  "lastname": "Smith",
  "email": "jane.smith@example.com",
  "phone": "+1 (555) 123-4567",
  "total": "145.50",
  "subtotal": "135.00",
  "shipping_cost": "10.50",
  "payment_id": "2",
  "payment_method": {
    "payment_id": "2",
    "payment": "Credit Card",
    "description": "Visa, MasterCard, Discover, American Express",
    "status": "A"
  },
  "shipping_id": "1",
  "shipping": [
    {
      "shipping_id": "1",
      "shipping": "Standard Shipping",
      "delivery_time": "3-5 business days",
      "status": "A"
    }
  ],
  "products": [
    {
      "item_id": "5432123",
      "product_id": "12",
      "product": "Premium T-Shirt",
      "price": "45.00",
      "amount": "3"
    }
  ],
  "s_firstname": "Jane",
  "s_lastname": "Smith",
  "s_address": "123 Main St",
  "s_city": "New York",
  "s_state": "NY",
  "s_country": "US",
  "s_zipcode": "10001",
  "b_firstname": "Jane",
  "b_lastname": "Smith",
  "b_address": "123 Main St",
  "b_city": "New York",
  "b_state": "NY",
  "b_country": "US",
  "b_zipcode": "10001"
}

Campos da resposta

Informações básicas do pedido

Campos da resposta

order_idstring

O identificador único do pedido.

is_parent_orderstring

YN

"Y" se este for um pedido pai, "N" caso contrário.

parent_order_idstring

Id do pedido pai (quando este é um pedido filho).

statusstring

Código de status do pedido (por exemplo, "P" para Processado, "C" para Concluído).

timestampstring

Timestamp UNIX do momento em que o pedido foi feito.

company_idstring

Id do vendedor/empresa.

Informações do cliente

Campos da resposta

user_idstring

Id de usuário do cliente (0 para pedidos de visitantes).

firstnamestring

Nome do cliente.

lastnamestring

Sobrenome do cliente.

emailstring

E-mail do cliente.

phonestring

Telefone do cliente.

Informações financeiras

Campos da resposta

totalstring

Valor total do pedido, incluindo o frete.

subtotalstring

Subtotal do pedido (antes do frete).

shipping_coststring

Custo do frete.

payment_idstring

Id da forma de pagamento.

payment_methodobject

Detalhes da forma de pagamento.

Informações de entrega

Campos da resposta

shipping_idstring

Id da forma de envio.

shippingarray

Detalhes da(s) forma(s) de envio.

s_firstname, s_lastname, etc.string

Campos do endereço de entrega (prefixo s_*).

b_firstname, b_lastname, etc.string

Campos do endereço de cobrança (prefixo b_*).

Erros

Status	Quando
`200 OK`	O pedido existe e os detalhes dele estão no corpo.
`404 Not Found`	O pedido não existe.