/v1/orders

post

https://api.shippedsuite.com/v1/orders

Creates or updates an Order

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

number

string

required

The Order number

string

required

The email address associated with the Order

external_id

string

required

Unique ID of Order in partner platform

placed_at

date-time

required

Date and time the order was placed. RFC 3339.

canceled_at

date-time

Date and time the order was canceled. RFC 3339.

payment_status

string

enum

The payment status of the Order

Allowed:

fulfillment_status

string

enum

The fulfillment status of the Order

display_currency

string

enum

The currency the order is displayed in

transaction_currency

string

enum

The currency the order is transacted in

customer

object

required

shipping_address

object

order_items

array of objects

required

order_items*

order_adjustments

array of objects

order_adjustments

transactions

array of objects

transactions

shield_selected

boolean

required

Whether or not the Customer selected Shield. For merchant-paid Shield, please set this field to false. Shield cannot be added to an existing order.

shield_display_fee

double

The price of Shield, in the display currency, that was shown to the customer.

green_selected

boolean

Defaults to false

Whether or not the Customer selected Green. For merchant-paid Green, please set this field to false. Green cannot be added to an existing order.

green_display_fee

double

The price of Green, in the display currency, that was shown to the customer.

taxes_included

boolean

Defaults to false

Whether or not prices already include taxes. Please provide tax amounts even if they are already included in the unit_price/amount.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Creates or updates an Order