Atualiza um pedido existente

Atualiza parcialmente um pedido existente no sistema Agulhão. (Obs: É obrigatório informar id ou idExterno. Se ambos forem fornecidos, o id terá prioridade.)

PATCH /pedidos

cURL

cancelando

curl --request PATCH \
  --url https://api-integracoes.agulhao.com.br/pedidos \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "idExterno": "4560a17a-ea59-4c4b-a2a4-78610dd04d4a",
  "cancelado": true
}
'

200

{
  "idAgulhao": "1",
  "idExterno": "4560a17a-ea59-4c4b-a2a4-78610dd04d4a"
}

Authorizations

x-api-key · string · header · required

Chave da API gerada no agulhão

Body

application/json

Dados do pedido a ser atualizado

idExterno · string

ID do pedido na integração (seu id)

cancelado · boolean

Indica se o pedido foi cancelado

Example:

false

observacoes · string

Observações do pedido

Example:

"Observações atualizadas do pedido"

Response

200

application/json

Pedido atualizado com sucesso

idAgulhao · string

Identificador único do pedido criado no Agulhão

Example:

"1"

idExterno · string

Identificador único do pedido na integração (seu id)

Example:

"4560a17a-ea59-4c4b-a2a4-78610dd04d4a"