Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 1.05 KB

v1-update-order-request.md

File metadata and controls

31 lines (22 loc) · 1.05 KB
Raw

V1 Update Order Request

V1UpdateOrderRequest

Structure

V1 Update Order Request

Fields

Name Type Tags Description
action str (V1 Update Order Request Action) Required -
shipped_tracking_number string Optional The tracking number of the shipment associated with the order. Only valid if action is COMPLETE.
completed_note string Optional A merchant-specified note about the completion of the order. Only valid if action is COMPLETE.
refunded_note string Optional A merchant-specified note about the refunding of the order. Only valid if action is REFUND.
canceled_note string Optional A merchant-specified note about the canceling of the order. Only valid if action is CANCEL.

Example (as JSON)

{
  "action": "COMPLETE",
  "shipped_tracking_number": "shipped_tracking_number0",
  "completed_note": "completed_note0",
  "refunded_note": "refunded_note4",
  "canceled_note": "canceled_note0"
}