Create an order

Create a new order in Corso systems, to represent a purchase by a customer of the merchant. An order should be created regardless of whether or not it is protected by Green Shipping Protection, to allow Corso staff to assist customers in knowing whether their order is protected.

application/json

Request Body

• currencyConversionRate number

  The conversion rate between store and customer

• storeId number required

  The ID of the store in Corso systems. Some merchants may have multiple stores under a single API client_id, so this value should always be specified. Please contact Corso if you do not have this value for your integration.

• sourceOrderId string required

  The order identifier from the source platform. Is unique across the store, and typically across the entire platform used by the merchant.

• orderNumber string

  The order number from the source platform, if none is provided. sourceOrderId will be used

• orderName string

  Customer-facing identifier for the order the source platform. Often composed of the store-unique order number plus some modifying prefixes and suffixes.

• customer object

  anyOf

  • MOD1
  • MOD2

  ---

  email string required

  Customer email address.

  phone string

  Customer phone number is E-164 format.

  email string

  Customer email address.

  phone string required

  Customer phone number is E-164 format.

• sourceCustomerId string required

  The customer ID (the source system).

• firstName string required

  First name.

• lastName string required

  Last name.

lineItems object[] required

Possible values: >= 1

Array of objects representing the line items on the order.

Array [

sourceLineItemId string required

The line item ID (from the source system).

productId string required

The product ID for the line item (from the source system).

variantId string required

The variant ID for the line item (from the source system). For the line item that represents the Corso Green Shipping Product (if purchased on the order), this should match the corresponding variant ID stored by Corso in our system, so that we can identify the order as protected.

name string required

The line item name, typically the value shown to the customer representing the product/variant combination purchased.

quantity number required

The quantity purchased for the line item.

sku string required

The SKU of product/variant of the line item.

tax currency required

Any tax applied to the line item.

vendor string

The vendor of the line item

price currency required

The price of the line item

]

sourceCreatedOn date-time

Date/time when the order was created in the source system.

sourceUpdatedOn date-time

Date/time when the order was most recently updated in the source system

shippingMoney currency required

The cost of shipping the order as charged to the customer.

subtotalMoney currency required

The subtotal of the order in the merchant's currency; typically equal to the cost of all product line items in the order totalled together.

taxMoney currency required

The amount of all tax applied to the order as included in the order total.

totalMoney currency required

The total amount charged to the customer. Must be equal to the sum of shippingMoney, subtotalMoney, and taxMoney, or the request will fail.

billingAddress object required

name string

The name line on an address. Often the name of the customer, or the business name something is shipped to.

line1 string required

Address line 1, generally the street number and name.

line2 string

Address line 2. Not mandatory, but often used for an apartment or suite number.

city string required

City of the Address

stateOrProvinceCode string required

State or province code, typically 2 characters.

postalCode string required

Postal Code

countryCode string required

ISO 3166 country code

latitude number

longitude number

shippingAddress object required

name string

The name line on an address. Often the name of the customer, or the business name something is shipped to.

line1 string required

Address line 1, generally the street number and name.

line2 string

Address line 2. Not mandatory, but often used for an apartment or suite number.

city string required

City of the Address

stateOrProvinceCode string required

State or province code, typically 2 characters.

postalCode string required

Postal Code

countryCode string required

ISO 3166 country code

latitude number

longitude number

grams number

The weight of the order, in grams.

carbonGrams number

The amount of carbon offset for the order, in grams. Only available after fulfillment (when the shipping origin can be determined).

carbonCalculationMethod string

How the carbon was calculated, depending on the accuracy of the input data such as weight and distance.

shippingTitle string

The name of the shipping plan used.

notes string

Any notes on the order

channel string

The name of the channel the order was created on.

channelId string

The ID of the sales channel the order was created from.

customerCurrencyCode string

The 3 letter currency code used by the customer in ISO 4217 format