GuidesAPI Reference
API Reference

/v2/order/{key}

Update an existing Credit Key order.

Path Params
string
required

The unique order key generated by Credit Key.

Body Params
number

The total amount for this order in USD.

string

An optional unique order ID provided by merchants.

string
enum

The new status the order should be changed to

Allowed:
shipping_address
object

Shipping address for the order.

metadata
object

Merchant provided data in a key/value blob stored on the order.

items
array of objects

Array of items associated with this order.

items
Responses

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json