SQsquarespace
Orders

Create order

Creates an order using information from a third-party sales channel. A successful request creates an Order resource.

post/1.0/commerce/orders

Request

Headers

Idempotency-Keystring required

Idempotency key to prevent duplicate order creation.

Authorizationstring required

API key or OAuth access token

User-Agentstring required

User Agent

Request body

channelNamestring required

Name of third-party sales channel.

createdOnstring date-time required

ISO 8601 UTC date and time string. Represents the date and time when the order was placed through the third-party sales channel.

customerEmailstring email

Email address provided at checkout on the third-party sales channel.

externalOrderReferencestring required

Order reference identifier used by the third-party sales channel.

fulfilledOnstring date-time

ISO 8601 UTC date and time string. Represents the moment the order was fulfilled. Required if fulfillmentStatus is FULFILLED.

fulfillmentStatus'PENDING' | 'FULFILLED'

Current fulfillment status of the order. Value may be PENDING or FULFILLED.

inventoryBehavior'DEDUCT' | 'SKIP'

Indicates whether to deduct stock quantity for the product variant upon Order creation. Values may be DEDUCT or SKIP. Defaults to SKIP.

priceTaxInterpretation'INCLUSIVE' | 'EXCLUSIVE' required

Indicates that lineItems.unitPricePaid includes tax. Values may be EXCLUSIVE or INCLUSIVE.

shopperFulfillmentNotificationBehavior'SEND' | 'SKIP'

Indicates whether to send a fulfillment notification email to the customer. Value may be SEND or SKIP.

Example request

{
  "customerEmail": "john.doe@example.com",
  "discountLines": [
    {
      "amount": {
        "value": 49.99
      }
    }
  ],
  "discountTotal": {
    "value": 49.99
  },
  "grandTotal": {
    "value": 49.99
  },
  "lineItems": [
    {
      "nonSaleUnitPrice": {
        "value": 49.99
      },
      "unitPricePaid": {
        "value": 49.99
      }
    }
  ],
  "shippingLines": [
    {
      "amount": {
        "value": 49.99
      }
    }
  ],
  "shippingTotal": {
    "value": 49.99
  },
  "subtotal": {
    "value": 49.99
  },
  "taxTotal": {
    "value": 49.99
  }
}

Response

The created order.

channelstring

Where the order originated; possible values are: web and pos.

channelNamestring

Name of the third-party sales channel.

createdOnstring date-time

ISO 8601 UTC date and time string; represents the moment when the order was placed.

customerEmailstring

Email address entered at checkout or, for recurring subscription orders, the customer's current email address.

customerIdstring

Unique customer id.

externalOrderReferencestring

Order reference identifier used by the third-party sales channel.

fulfilledOnstring date-time

ISO 8601 UTC date and time string; represents the moment the order was fulfilled.

fulfillmentStatus'PENDING' | 'FULFILLED' | 'CANCELED'

Current fulfillment status of the order. Value may be: PENDING, FULFILLED, or CANCELED.

idstring

Unique Order id.

modifiedOnstring date-time

ISO 8601 UTC date and time string; represents when the order was last modified.

orderNumberstring

Unique, sequential number for the Order.

paymentState'NOT_CHARGED' | 'AUTHORIZED' | 'PAID' | 'REFUNDED' | 'PENDING' | 'FAILED' | 'REFUND_PENDING' | 'REFUND_FAILED' | 'PARTIALLY_PAID'

Current state of payment for the order.

priceTaxInterpretationstring

Indicates whether lineItems.unitPricePaid includes tax. Values may be EXCLUSIVE or INCLUSIVE.

shippingOptionNamestring

the specific shipping service name selected at checkout (e.g. "USPS Ground Advantage", "Royal Mail Tracked 48").

shippingOptionServiceType'FEDEX_GROUND' | 'FEDEX_GROUND_HOME_DELIVERY' | 'FEDEX_PRIORITY_OVERNIGHT' | 'FEDEX_STANDARD_OVERNIGHT' | 'FEDEX_2_DAY' | 'FEDEX_2_DAY_AM' | 'FEDEX_EXPRESS_SAVER' | 'FEDEX_FIRST_FREIGHT' | 'FEDEX_FREIGHT_PRIORITY' | 'FEDEX_FREIGHT_ECONOMY' | 'FEDEX_FIRST_OVERNIGHT' | 'FEDEX_SAME_DAY' | 'FEDEX_SAME_DAY_CITY' | 'FEDEX_EUROPE_FIRST_INTERNATIONAL_PRIORITY' | 'FEDEX_INTERNATIONAL_ECONOMY' | 'FEDEX_INTERNATIONAL_FIRST' | 'FEDEX_INTERNATIONAL_PRIORITY' | 'FEDEX_INTERNATIONAL_ECONOMY_FREIGHT' | 'FEDEX_INTERNATIONAL_PRIORITY_FREIGHT' | 'UPS_GROUND' | 'UPS_NEXT_DAY_AIR' | 'UPS_NEXT_DAY_AIR_SAVER' | 'UPS_NEXT_DAY_AIR_EARLY_AM' | 'UPS_TWO_DAY_AIR' | 'UPS_THREE_DAY_SELECT' | 'UPS_TWO_DAY_AIR_AM' | 'USPS_UNKNOWN' | 'USPS_FIRST_CLASS' | 'USPS_PRIORITY' | 'USPS_EXPRESS' | 'USPS_STANDARD' | 'USPS_ALL' | 'USPS_ONLINE' | 'OTHER'

The carrier service type identifier.

testmodeboolean

If true, the order is a test order created using a payment method in test mode.

Example response

{
  "billingAddress": {
    "address1": "459 Broadway",
    "city": "New York",
    "countryCode": "US",
    "firstName": "Bob",
    "lastName": "Loblaw",
    "phone": "5553334444",
    "postalCode": "10003",
    "state": "NY"
  },
  "channel": "web",
  "channelName": "Faire Wholesale",
  "createdOn": "2016-12-23T15:58:07.187Z",
  "customerEmail": "foo@example.com",
  "customerId": "585d498fdee9f31a60284a38",
  "discountLines": [
    {
      "amount": {
        "value": 49.99
      },
      "description": "20% off all orders over $50",
      "name": "Summer Sale - 20% Off",
      "promoCode": "SUMMER20"
    }
  ],
  "discountTotal": {
    "value": 49.99
  },
  "externalOrderReference": "EXT-98765",
  "formSubmission": [
    {
      "label": "How did you hear about us?",
      "value": "Facebook"
    }
  ],
  "fulfillments": [
    {
      "carrierName": "FedEx",
      "service": "Same-Day Delivery",
      "shipDate": "2017-01-29T22:19:26.98Z",
      "trackingNumber": "103932814692659",
      "trackingUrl": "https://www.fedex.com/apps/fedextrack/?tracknumbers=103932814692659"
    }
  ],
  "grandTotal": {
    "value": 49.99
  },
  "id": "585d498fdee9f31a60284a37",
  "internalNotes": [
    {
      "content": "First note"
    }
  ],
  "lineItems": [
    {
      "customizations": [
        {
          "label": "How did you hear about us?",
          "value": "Facebook"
        }
      ],
      "height": 4,
      "id": "585d4975dee9f31a60284a16",
      "imageUrl": "https://static.squarespace.com/universal/commerce/images/brine-32oz-spring-mix-v2.jpg?format=300w",
      "length": 3,
      "lineItemType": "PHYSICAL_PRODUCT",
      "productId": "565c8f3da7c8a3cf71d5fd0a",
      "productName": "Product",
      "quantity": 1,
      "sku": "SQ3381024",
      "unitPricePaid": {
        "value": 49.99
      },
      "variantId": "88c16ee4-547b-445e-a392-bded9991ae30",
      "variantOptions": [
        {
          "optionName": "Size",
          "value": "Large"
        }
      ],
      "weight": 1,
      "width": 2
    }
  ],
  "modifiedOn": "2016-12-23T15:58:07.187Z",
  "orderNumber": "3",
  "priceTaxInterpretation": "EXCLUSIVE",
  "refundedTotal": {
    "value": 49.99
  },
  "shippingAddress": {
    "address1": "459 Broadway",
    "city": "New York",
    "countryCode": "US",
    "firstName": "Bob",
    "lastName": "Loblaw",
    "phone": "5553334444",
    "postalCode": "10003",
    "state": "NY"
  },
  "shippingLines": [
    {
      "amount": {
        "value": 49.99
      },
      "method": "UPS Ground"
    }
  ],
  "shippingTotal": {
    "value": 49.99
  },
  "subtotal": {
    "value": 49.99
  },
  "taxTotal": {
    "value": 49.99
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.