Recuperando um pedido

curl --request GET \
  --url https://lojinha.dev/api/v1/:customer/orders/:id \
  --header 'Authorization: Bearer <token>'

{
  "order": {
    "id": "4f24a75c-792a-4aff-9265-19deb198be07",
    "store": "org_2StqHEqEqKtCH66IJjLb73J2ww6",
    "customerId": "7b16fb4f-6c54-4f7c-a751-3027b451b4ed",
    "addressId": "96c0e914-0094-4694-b735-a54633f8dfbc",
    "price": 8000,
    "originalPrice": null,
    "status": "CREATED",
    "createdAt": "2023-07-23T22:04:52.234Z",
    "updatedAt": "2023-07-24T15:00:44.852Z",
    "deletedAt": null,
    "products": [
      {
        "id": "4cf35a0f-7f25-43ef-8e5e-208fbfeb1bd0",
        "store": "org_2StqHEqEqKtCH66IJjLb73J2ww6",
        "status": "ACTIVE",
        "name": "A Tormenta de Espadas",
        "slug": "a-tormenta-de-espadas",
        "description": "<p>Terceiro livro da série</p>",
        "price": 8000,
        "originalPrice": 12000,
        "quantity": 9,
        "sku": "LI-004",
        "createdAt": "2023-07-22T00:51:44.685Z",
        "updatedAt": "2023-07-24T02:09:03.948Z",
        "deletedAt": null,
        "order": {
          "quantity": 1,
          "price": 8000
        }
      }
    ],
    "address": {
      "id": "96c0e914-0094-4694-b735-a54633f8dfbc",
      "customerId": "7b16fb4f-6c54-4f7c-a751-3027b451b4ed",
      "alias": "Casa",
      "zipcode": "87045-700",
      "street": "Praça Pioneiro Antônio Laurentino Tavares",
      "state": "PR",
      "city": "Maringá",
      "country": "Brasil",
      "neightborhood": "Jd. América",
      "number": "200",
      "complement": "Casa Azul",
      "createdAt": "2023-07-24T14:46:19.941Z",
      "updatedAt": null,
      "deletedAt": null
    }
  }
}

GET

:customer

orders

:id

Recuperando um pedido

curl --request GET \
  --url https://lojinha.dev/api/v1/:customer/orders/:id \
  --header 'Authorization: Bearer <token>'

{
  "order": {
    "id": "4f24a75c-792a-4aff-9265-19deb198be07",
    "store": "org_2StqHEqEqKtCH66IJjLb73J2ww6",
    "customerId": "7b16fb4f-6c54-4f7c-a751-3027b451b4ed",
    "addressId": "96c0e914-0094-4694-b735-a54633f8dfbc",
    "price": 8000,
    "originalPrice": null,
    "status": "CREATED",
    "createdAt": "2023-07-23T22:04:52.234Z",
    "updatedAt": "2023-07-24T15:00:44.852Z",
    "deletedAt": null,
    "products": [
      {
        "id": "4cf35a0f-7f25-43ef-8e5e-208fbfeb1bd0",
        "store": "org_2StqHEqEqKtCH66IJjLb73J2ww6",
        "status": "ACTIVE",
        "name": "A Tormenta de Espadas",
        "slug": "a-tormenta-de-espadas",
        "description": "<p>Terceiro livro da série</p>",
        "price": 8000,
        "originalPrice": 12000,
        "quantity": 9,
        "sku": "LI-004",
        "createdAt": "2023-07-22T00:51:44.685Z",
        "updatedAt": "2023-07-24T02:09:03.948Z",
        "deletedAt": null,
        "order": {
          "quantity": 1,
          "price": 8000
        }
      }
    ],
    "address": {
      "id": "96c0e914-0094-4694-b735-a54633f8dfbc",
      "customerId": "7b16fb4f-6c54-4f7c-a751-3027b451b4ed",
      "alias": "Casa",
      "zipcode": "87045-700",
      "street": "Praça Pioneiro Antônio Laurentino Tavares",
      "state": "PR",
      "city": "Maringá",
      "country": "Brasil",
      "neightborhood": "Jd. América",
      "number": "200",
      "complement": "Casa Azul",
      "createdAt": "2023-07-24T14:46:19.941Z",
      "updatedAt": null,
      "deletedAt": null
    }
  }
}

customer

uuid

required

ID do cliente.

uuid

required

ID do pedido.

Resposta

order

object

Show child attributes

uuid

ID do pedido

store

uuid

ID da loja

customerId

uuid

ID do cliente

addressId

uuid

ID do endereço

price

number

Valor do pedido

originalPrice

number | null

Valor original do pedido

status

enum

default:"CREATED"

Status do pedido, veja mais detalhes aqui.

createdAt

string

Data de criação.

updatedAt

string | null

Data da última modificação.

deletedAt

string | null

Data em que o pedido foi cancelado.

products

array

Show child attributes

uuid

Id do produto

store

string

ID da loja

status

enum

default:"ACTIVE"

Status do produto, pode ser: DRAFT | ACTIVE

name

string

Nome do produto

slug

string

Slug do produto

description

string | null

Descrição do produto em uma string com HTML

price

number | null

Preço atual do produto

originalPrice

number | null

Preço original do produto

quantity

number | null

Quantidade do produto em estoque

sku

string | null

Código do produto pra controle de estoque Stock Keeping Unit, pode ser o código de barras de um produto único

createdAt

string

Data de criação

updatedAt

string | null

Data da última modifição

deletedAt

string | null

Data em que que foi arquivado

Pela API este dado sempre deve retornar null

order

object

Informações deste produto no carrinho.

Show child attributes

quantity

number

Quantidade deste produto neste carrinho.

price

number

Preço do produto no carrinho.

address

object

Endereço do cliente.

Show child attributes

uuid

ID do endereço

customerId

uuid

ID do cliente

alias

string

Nome para o endereço

zipcode

string

CEP do endereço

street

string

Nome da rua ou avenida

state

string

Estado

city

string

Cidade

country

string

País

neightborhood

string

Bairro

number

string

Número

complement

string

Complemento

createdAt

string

Data de criação

updatedAt

string

Data da última utilização

deletedAt

string

Data em que foi arquivado

{
  "order": {
    "id": "4f24a75c-792a-4aff-9265-19deb198be07",
    "store": "org_2StqHEqEqKtCH66IJjLb73J2ww6",
    "customerId": "7b16fb4f-6c54-4f7c-a751-3027b451b4ed",
    "addressId": "96c0e914-0094-4694-b735-a54633f8dfbc",
    "price": 8000,
    "originalPrice": null,
    "status": "CREATED",
    "createdAt": "2023-07-23T22:04:52.234Z",
    "updatedAt": "2023-07-24T15:00:44.852Z",
    "deletedAt": null,
    "products": [
      {
        "id": "4cf35a0f-7f25-43ef-8e5e-208fbfeb1bd0",
        "store": "org_2StqHEqEqKtCH66IJjLb73J2ww6",
        "status": "ACTIVE",
        "name": "A Tormenta de Espadas",
        "slug": "a-tormenta-de-espadas",
        "description": "<p>Terceiro livro da série</p>",
        "price": 8000,
        "originalPrice": 12000,
        "quantity": 9,
        "sku": "LI-004",
        "createdAt": "2023-07-22T00:51:44.685Z",
        "updatedAt": "2023-07-24T02:09:03.948Z",
        "deletedAt": null,
        "order": {
          "quantity": 1,
          "price": 8000
        }
      }
    ],
    "address": {
      "id": "96c0e914-0094-4694-b735-a54633f8dfbc",
      "customerId": "7b16fb4f-6c54-4f7c-a751-3027b451b4ed",
      "alias": "Casa",
      "zipcode": "87045-700",
      "street": "Praça Pioneiro Antônio Laurentino Tavares",
      "state": "PR",
      "city": "Maringá",
      "country": "Brasil",
      "neightborhood": "Jd. América",
      "number": "200",
      "complement": "Casa Azul",
      "createdAt": "2023-07-24T14:46:19.941Z",
      "updatedAt": null,
      "deletedAt": null
    }
  }
}

Recuperando Pedidos

API

​Resposta

Resposta