Skip to content

Instantly share code, notes, and snippets.

@leomp12
Last active May 7, 2020 20:34
Show Gist options
  • Select an option

  • Save leomp12/3ec7a835dedb5858da57a6ec9f5e81ad to your computer and use it in GitHub Desktop.

Select an option

Save leomp12/3ec7a835dedb5858da57a6ec9f5e81ad to your computer and use it in GitHub Desktop.
E-Com Plus - Atualizar status de pedido via Store API

E-Com Plus - Atualizar status de pedido via Store API

Referência da API

A forma recomendada de promover uma alteração de status de transações ou entrega (fulfillment) é inserindo registros com (pelo menos) o status atual e data/hora da última atualização.

Atualizando status financeiro

Basta inserir uma entrada via POST no subresource payments_history:

POST /orders/:_id/payments_history.json
{
  "date_time": "2020-05-07T20:12:47.924Z",
  "status": "paid"
}

No exemplo acima o status financeiro do pedido :_id será alterado para pago.

Exemplo com informações adicionais no corpo do POST:

{
  "transaction_id": "fe1230000000000000000005",
  "date_time": "2020-05-07T20:12:47.924Z",
  "status": "paid",
  "notification_code": "WH1234567",
  "flags": [
    "pdv-1"
  ]
}

Possíveis status de transação

  • pending
  • under_analysis
  • authorized
  • unauthorized
  • paid
  • in_dispute
  • refunded
  • voided
  • unknown

Atualizando status de entrega

Basta inserir uma entrada via POST no subresource fulfillments:

POST /orders/:_id/fulfillments.json
{
  "date_time": "2020-05-07T20:12:47.924Z",
  "status": "shipped"
}

No exemplo acima o status de entrega do pedido :_id será alterado para enviado.

Exemplo com informações adicionais no corpo do POST:

{
  "shipping_line_id": "af1230000000000000000005",
  "date_time": "2020-05-07T20:12:47.924Z",
  "status": "delivered",
  "notification_code": "TN1234567",
  "flags": [
    "azul-cargo"
  ]
}

Possíveis status de fulfillment

  • invoice_issued
  • in_production
  • in_separation
  • ready_for_shipping
  • shipped
  • delivered
  • returned_for_exchange
  • received_for_exchange
  • returned
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment