Integração sistema de estabelecimentos

Atualizar status de um pedido

Em desenvolvimento

Amb. de prod.

https://api.amo.delivery

PUT

/establishments/{establishment_id}/orders/{order_id}/status

Requisição

Authorization

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Parâmetros Path

establishment_id

string

requerido

order_id

string

requerido

Parâmetros Header

client-type

enum<string>

requerido

Valores permitidos:

rest

api-version

enum<number>

requerido

Valor fixo:

Parâmetros Bodyapplication/json

status

enum<string>

requerido

Novo status do pedido. (confirmado pelo estabelecimento, enviado ou pronto para retirada, cancelado)

Valores permitidos:

confirmedsentcanceled

estimated_delivery_time

number

opcional

Tempo estimado para o delivery do pedido. O campo deve ser enviado quando o status informado for "sent". É permitido o valor 0

cancellation_type

string

opcional

Tipo de cancelamento. O valor informado deve ser "establishment". O campo deve ser enviado quando o status for "canceled"

cancellation_reason

string

opcional

Motivo do cancelamento. O campo deve ser enviado quando o status for "canceled"

Exemplo

{
  "status": "canceled",
  "cancellation_type": "establishment",
  "cancellation_reason": "Sem ingredientes"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.amo.delivery/establishments//orders//status' \
--header 'client-type;' \
--header 'api-version;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "status": "canceled",
  "cancellation_type": "establishment",
  "cancellation_reason": "Sem ingredientes"
}'

Respostas

🟢204Sem Conteúdo

application/json

Body

object {0}

Exemplo

{}

Página anterior

MÓDULO DE GERENCIAMENTO DE PEDIDOS

Próxima página

MÓDULO DE GERENCIAMENTO DO ESTABELECIMENTO