Orders
Update order
PUT
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
application/json
If this was a replacement for another Order, you can include the original order id here.
Example:
"12345"
Order Number on your platform
Example:
"#634C"
Creation date of the order on your platform
Example:
"2000-05-15T21:00:00.000Z"
Updated date of the order on your platform
Example:
"2000-05-15T21:00:00.000Z"
Cancellation date of the order on your platform
Example:
"2000-05-15T21:00:00.000Z"
Platform identifier
Available options:
shopify
, woocommerce
, magento
, bigcommerce
, api
Example:
"api"
Premium paid
Example:
"1.5"
Order currency
Available options:
ADP
, AED
, AFA
, AFN
, ALK
, ALL
, AMD
, ANG
, AOA
, AOK
, AON
, AOR
, ARA
, ARP
, ARS
, ARY
, ATS
, AUD
, AWG
, AYM
, AZM
, AZN
, BAD
, BAM
, BBD
, BDT
, BEC
, BEF
, BEL
, BGJ
, BGK
, BGL
, BGN
, BHD
, BIF
, BMD
, BND
, BOB
, BOP
, BOV
, BRB
, BRC
, BRE
, BRL
, BRN
, BRR
, BSD
, BTN
, BUK
, BWP
, BYB
, BYN
, BYR
, BZD
, CAD
, CDF
, CHC
, CHE
, CHF
, CHW
, CLF
, CLP
, CNY
, COP
, COU
, CRC
, CSD
, CSJ
, CSK
, CUC
, CUP
, CVE
, CYP
, CZK
, DDM
, DEM
, DJF
, DKK
, DOP
, DZD
, ECS
, ECV
, EEK
, EGP
, ERN
, ESA
, ESB
, ESP
, ETB
, EUR
, FIM
, FJD
, FKP
, FRF
, GBP
, GEK
, GEL
, GHC
, GHP
, GHS
, GIP
, GMD
, GNE
, GNF
, GNS
, GQE
, GRD
, GTQ
, GWE
, GWP
, GYD
, HKD
, HNL
, HRD
, HRK
, HTG
, HUF
, IDR
, IEP
, ILP
, ILR
, ILS
, INR
, IQD
, IRR
, ISJ
, ISK
, ITL
, JMD
, JOD
, JPY
, KES
, KGS
, KHR
, KMF
, KPW
, KRW
, KWD
, KYD
, KZT
, LAJ
, LAK
, LBP
, LKR
, LRD
, LSL
, LSM
, LTL
, LTT
, LUC
, LUF
, LUL
, LVL
, LVR
, LYD
, MAD
, MDL
, MGA
, MGF
, MKD
, MLF
, MMK
, MNT
, MOP
, MRO
, MRU
, MTL
, MTP
, MUR
, MVQ
, MVR
, MWK
, MXN
, MXP
, MXV
, MYR
, MZE
, MZM
, MZN
, NAD
, NGN
, NIC
, NIO
, NLG
, NOK
, NPR
, NZD
, OMR
, PAB
, PEH
, PEI
, PEN
, PES
, PGK
, PHP
, PKR
, PLN
, PLZ
, PTE
, PYG
, QAR
, RHD
, ROK
, ROL
, RON
, RSD
, RUB
, RUR
, RWF
, SAR
, SBD
, SCR
, SDD
, SDG
, SDP
, SEK
, SGD
, SHP
, SIT
, SKK
, SLL
, SOS
, SRD
, SRG
, SSP
, STD
, STN
, SUR
, SVC
, SYP
, SZL
, THB
, TJR
, TJS
, TMM
, TMT
, TND
, TOP
, TPE
, TRL
, TRY
, TTD
, TWD
, TZS
, UAH
, UAK
, UGS
, UGW
, UGX
, USD
, USN
, USS
, UYI
, UYN
, UYP
, UYU
, UYW
, UZS
, VEB
, VEF
, VES
, VNC
, VND
, VUV
, WST
, XAF
, XAG
, XAU
, XBA
, XBB
, XBC
, XBD
, XCD
, XDR
, XEU
, XFO
, XFU
, XOF
, XPD
, XPF
, XPT
, XRE
, XSU
, XTS
, XUA
, XXX
, YDD
, YER
, YUD
, YUM
, YUN
, ZAL
, ZAR
, ZMK
, ZMW
, ZRN
, ZRZ
, ZWC
, ZWD
, ZWL
, ZWN
, ZWR
Example:
"USD"
Order total
Example:
"15.40"
Order discount
Example:
"1.20"
Order shipping cost
Example:
"3.50"
Order tax
Example:
"0.55"
Order subtotal
Example:
"11.30"
Customer email
Example:
"john@doe.com"
Customer name
Example:
"John"
Customer phone number
Example:
"+1-555-796-3644"
Tax associated with shipping
Example:
"234"
Response
200
application/json
The order has been successfully updated.
Example:
"ok"