Endpoints de status

Todas as URLs da API de status: listar e criar status, e consultar, atualizar ou excluir um status pelo id.

A API de status oferece os endpoints que gerenciam o fluxo de status de pedido da sua loja. Com eles você cria, consulta, atualiza e exclui as opções de status que representam as diferentes etapas do ciclo de vida de um pedido. A referência mostra a URL base como https://www.venddor.com.br/api; nos exemplos abaixo ela aparece como $BASE_URL/api.

A coleção de status

O caminho /statuses dá acesso a todos os status de pedido disponíveis (GET) ou cria um status novo (POST).

Método	Descrição
GET	Retorna todos os status de pedido
POST	Cria um status de pedido novo

GET/api/statusesAdmin

Retornar todos os status de pedido

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/statuses"

Resposta

200Status retornados

json

{
  "data": [
    {
      "id": "status_001",
      "name": "New Order",
      "description": "Order has been placed but not yet processed",
      "color": "#3498db",
      "position": 1,
      "is_default": true,
      "notifications": {
        "customer": true,
        "admin": true
      }
    },
    {
      "id": "status_002",
      "name": "Processing",
      "description": "Order is being prepared for shipping",
      "color": "#f39c12",
      "position": 2,
      "is_default": false,
      "notifications": {
        "customer": true,
        "admin": false
      }
    }
  ],
  "meta": {
    "total": 6,
    "page": 1,
    "per_page": 10
  }
}

POST/api/statusesAdmin

Criar um status de pedido novo

Esta requisição exige um corpo JSON com os detalhes do status. A referência mostra este exemplo.

Exemplo de requisição

bash

curl -X POST -u "$EMAIL:$API_KEY" "$BASE_URL/api/statuses" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Delivered",
  "description": "Order has been successfully delivered to the customer",
  "color": "#27ae60",
  "position": 4,
  "is_default": false,
  "notifications": {
    "customer": true,
    "admin": true
  },
  "actions": [
    "send_thank_you_email",
    "request_review"
  ]
}'

Um status específico

O caminho /statuses/:id consulta, atualiza ou exclui um status de pedido pelo id.

Método	Descrição
GET	Retorna um status específico
PUT	Atualiza um status específico
DELETE	Exclui um status específico

GET/api/statuses/{id}Admin

Consultar um status específico

Parâmetros de caminho

idstringobrigatório

O identificador único do status.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/statuses/status_002"

PUT/api/statuses/{id}Admin

Atualizar um status específico

Parâmetros de caminho

idstringobrigatório

O identificador único do status.

A referência mostra este exemplo de requisição PUT.

Exemplo de requisição

bash

curl -X PUT -u "$EMAIL:$API_KEY" "$BASE_URL/api/statuses/status_002" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Shipped",
  "description": "Order has been shipped and is in transit",
  "color": "#9b59b6",
  "notifications": {
    "customer": true,
    "admin": false
  }
}'

DELETE/api/statuses/{id}Admin

Excluir um status específico

Parâmetros de caminho

idstringobrigatório

O identificador único do status.

Exemplo de requisição

bash

curl -X DELETE -u "$EMAIL:$API_KEY" "$BASE_URL/api/statuses/status_002"

Códigos de status da resposta

Código de status	Descrição
`200 OK`	Operação concluída com sucesso
`400 Bad Request`	Parâmetros da requisição inválidos
`404 Not Found`	Não existe status com o id informado
`409 Conflict`	Não é possível excluir um status que está em uso por pedidos

Veja também

API legada/Referência completa/Status

Endpoints de status

Todas as URLs da API de status: listar e criar status, e consultar, atualizar ou excluir um status pelo id.

A coleção de status

O caminho /statuses dá acesso a todos os status de pedido disponíveis (GET) ou cria um status novo (POST).

Método	Descrição
GET	Retorna todos os status de pedido
POST	Cria um status de pedido novo

GET/api/statusesAdmin

Retornar todos os status de pedido

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/statuses"

Resposta

200Status retornados

json

{
  "data": [
    {
      "id": "status_001",
      "name": "New Order",
      "description": "Order has been placed but not yet processed",
      "color": "#3498db",
      "position": 1,
      "is_default": true,
      "notifications": {
        "customer": true,
        "admin": true
      }
    },
    {
      "id": "status_002",
      "name": "Processing",
      "description": "Order is being prepared for shipping",
      "color": "#f39c12",
      "position": 2,
      "is_default": false,
      "notifications": {
        "customer": true,
        "admin": false
      }
    }
  ],
  "meta": {
    "total": 6,
    "page": 1,
    "per_page": 10
  }
}

POST/api/statusesAdmin

Criar um status de pedido novo

Esta requisição exige um corpo JSON com os detalhes do status. A referência mostra este exemplo.

Exemplo de requisição

bash

curl -X POST -u "$EMAIL:$API_KEY" "$BASE_URL/api/statuses" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Delivered",
  "description": "Order has been successfully delivered to the customer",
  "color": "#27ae60",
  "position": 4,
  "is_default": false,
  "notifications": {
    "customer": true,
    "admin": true
  },
  "actions": [
    "send_thank_you_email",
    "request_review"
  ]
}'

Um status específico

O caminho /statuses/:id consulta, atualiza ou exclui um status de pedido pelo id.

Método	Descrição
GET	Retorna um status específico
PUT	Atualiza um status específico
DELETE	Exclui um status específico

GET/api/statuses/{id}Admin

Consultar um status específico

Parâmetros de caminho

idstringobrigatório

O identificador único do status.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/statuses/status_002"

PUT/api/statuses/{id}Admin

Atualizar um status específico

Parâmetros de caminho

idstringobrigatório

O identificador único do status.

A referência mostra este exemplo de requisição PUT.

Exemplo de requisição

bash

curl -X PUT -u "$EMAIL:$API_KEY" "$BASE_URL/api/statuses/status_002" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Shipped",
  "description": "Order has been shipped and is in transit",
  "color": "#9b59b6",
  "notifications": {
    "customer": true,
    "admin": false
  }
}'

DELETE/api/statuses/{id}Admin

Excluir um status específico

Parâmetros de caminho

idstringobrigatório

O identificador único do status.

Exemplo de requisição

bash

curl -X DELETE -u "$EMAIL:$API_KEY" "$BASE_URL/api/statuses/status_002"

Códigos de status da resposta

Código de status	Descrição
`200 OK`	Operação concluída com sucesso
`400 Bad Request`	Parâmetros da requisição inválidos
`404 Not Found`	Não existe status com o id informado
`409 Conflict`	Não é possível excluir um status que está em uso por pedidos