NAV

Storefront Checkout/Cart API

Checkout

getCheckouts

GET /checkouts/{checkoutId}

Returns information about a given Checkout, specified by its ID. Which is the same as the cartId.

A checkout is an aggregation of multiple entities – Cart, Addresses, Shipping Options, and more.

Parameters

Parameter In Type Required Description
includes query string false No description
checkoutId path string true No description

Enumerated Values

Parameter Value
includes consignments.availableShippingOptions
{
  "data": {
    "id": "string",
    "cart": {
      "id": "string",
      "customer_id": 0,
      "currency": {
        "name": "string",
        "code": "string",
        "symbol": "string"
      },
      "taxIncluded": true,
      "baseAmount": 0,
      "discountAmount": 0,
      "cartAmount": 0,
      "coupons": [
        {
          "id": "string",
          "code": "string",
          "name": "string",
          "couponType": "string",
          "discountedAmount": 0
        }
      ],
      "discounts": [
        {
          "name": "string",
          "discountedAmount": 0
        }
      ],
      "lineItems": [
        {
          "physicalItems": [
            {
              "id": "string",
              "variantId": 0,
              "productId": 0,
              "sku": "string",
              "name": "string",
              "url": "http://example.com",
              "quantity": 0,
              "isTaxable": true,
              "imageUrl": "http://example.com",
              "discounts": [
                {
                  "name": "string",
                  "discountedAmount": 0
                }
              ],
              "discountAmount": 0,
              "couponAmount": 0,
              "listPrice": 0,
              "salePrice": 0,
              "extendedListPrice": 0,
              "extendedSalePrice": 0,
              "isShippingRequired": true,
              "giftWrapping": {
                "name": "string",
                "message": "string",
                "amount": 0
              }
            }
          ],
          "digitalItems": [
            {
              "id": "string",
              "variantId": 0,
              "productId": 0,
              "sku": "string",
              "name": "string",
              "url": "http://example.com",
              "quantity": 0,
              "isTaxable": true,
              "imageUrl": "http://example.com",
              "discounts": [
                {
                  "name": "string",
                  "discountedAmount": 0
                }
              ],
              "discountAmount": 0,
              "couponAmount": 0,
              "listPrice": 0,
              "salePrice": 0,
              "extendedListPrice": 0,
              "extendedSalePrice": 0,
              "downloadFileUrls": [
                "string"
              ],
              "downloadPageUrl": "string",
              "downloadSize": "string"
            }
          ],
          "giftCertificate": [
            {
              "id": "string",
              "theme": "string",
              "amount": 0,
              "taxable": true,
              "sender": {
                "name": "string",
                "email": "user@example.com"
              },
              "recipient": {
                "name": "string",
                "email": "user@example.com"
              },
              "message": "string"
            }
          ]
        }
      ],
      "createdTime": "string",
      "updatedTime": "string"
    },
    "shopper": {
      "customerId": "string",
      "customerGroupId": "string",
      "storeCredit": "string"
    },
    "billingAddress": {
      "id": "string",
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "street1": "string",
      "street2": "string",
      "city": "string",
      "region": "string",
      "regionCode": "string",
      "country": "string",
      "countryCode": "string",
      "postalCode": "string",
      "phone": "string",
      "customFields": [
        {
          "fieldId": "string",
          "fieldValue": "string"
        }
      ]
    },
    "consignments": [
      {
        "id": "string",
        "shippingAddress": {
          "id": "string",
          "firstName": "string",
          "lastName": "string",
          "company": "string",
          "street1": "string",
          "street2": "string",
          "city": "string",
          "region": "string",
          "regionCode": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "phone": "string",
          "customFields": [
            {
              "fieldId": "string",
              "fieldValue": "string"
            }
          ]
        },
        "availableShippingOptions": [
          {
            "description": "string",
            "id": "string",
            "imageUrl": "string",
            "price": 0,
            "transitTime": "string"
          }
        ],
        "selectedShippingOptionId": "string",
        "shippingCost": 0,
        "lineItemIds": [
          "string"
        ]
      }
    ],
    "taxes": [
      {
        "itemId": "string",
        "name": "string",
        "amount": 0,
        "percentage": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "orderId": "string",
    "shippingCostTotal": 0,
    "taxTotal": 0,
    "grandTotal": 0,
    "storeCredit": 0,
    "giftCertificates": [
      {
        "balance": 0,
        "code": "string",
        "purchaseDate": "2018-02-02"
      }
    ],
    "balanceDue": 0,
    "createdTime": "string",
    "updatedTime": "string"
  }
}
{
  "errors": [
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "detail": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Returns Checkout Object. Inline
400 Bad Request When a problem arises, returns (for now) a generic response. CheckoutError

Response Schema

Status Code 200

Name Type Required Description
data Checkout false No description
id string(UUID) false No description
cart Cart false A cart contains a collection of items, prices, discounts, etc. It does not contain customer-related data.
shopper Shopper false Includes customerId and customerGroupID
billingAddress AddressResponse false No description
consignments Consignment false No description
taxes Tax false No description
discounts AppliedDiscount false Discounts applied after addresses have been selected.
coupons AppliedCoupon false Coupons applied at checkout level.
orderId string false No description
shippingCostTotal number false Shipping cost before any discounts are applied.
taxTotal number false No description
grandTotal number false The total payable amount, before applying any store credit or gift certificate.
storeCredit number false Applied store credit.
giftCertificates GiftCertificate false Applied gift certificate (as a payment method).
balanceDue number false The total payable amount due, after applying any store credit or gift certificate.
createdTime string(ISO-8601) false Time when the cart was created.
updatedTime string(ISO-8601) false Time when the cart was last updated.

putCheckoutCartItems

PUT /checkouts/{checkoutId}/carts/{cartId}/items/{itemId}

Partial updates of cart sub-resource, via checkout endpoint.

{
  "lineItem": {
    "quantity": 0,
    "productId": 0,
    "variantId": 0
  },
  "giftCertificate": {
    "theme": "string",
    "amount": 1,
    "sender": {
      "name": "string",
      "email": "user@example.com"
    },
    "recipient": {
      "name": "string",
      "email": "user@example.com"
    },
    "message": "string",
    "quantity": 0
  }
}

Parameters

Parameter In Type Required Description
checkoutId path string true No description
cartId path string(UUID) true No description
itemId path string true No description
body body CartUpdateRequest true No description
giftCertificate body LineItemGiftCertificateRequestData false No description
{
  "id": "string",
  "cart": {
    "id": "string",
    "customer_id": 0,
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "taxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "taxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string"
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "street1": "string",
    "street2": "string",
    "city": "string",
    "region": "string",
    "regionCode": "string",
    "country": "string",
    "countryCode": "string",
    "postalCode": "string",
    "phone": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "consignments": [
    {
      "id": "string",
      "shippingAddress": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "street1": "string",
        "street2": "string",
        "city": "string",
        "region": "string",
        "regionCode": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "phone": "string",
        "customFields": [
          {
            "fieldId": "string",
            "fieldValue": "string"
          }
        ]
      },
      "availableShippingOptions": [
        {
          "description": "string",
          "id": "string",
          "imageUrl": "string",
          "price": 0,
          "transitTime": "string"
        }
      ],
      "selectedShippingOptionId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        "string"
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2018-02-02"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Checkout Object. Checkout

deleteCheckoutLineItem

DELETE /checkouts/{checkoutId}/carts/{cartId}/items/{itemId}

Removes a line item from the cart.

Parameters

Parameter In Type Required Description
checkoutId path string true No description
cartId path string(UUID) true No description
itemId path string(number) true No description
{
  "id": "string",
  "cart": {
    "id": "string",
    "customer_id": 0,
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "taxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "taxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string"
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "street1": "string",
    "street2": "string",
    "city": "string",
    "region": "string",
    "regionCode": "string",
    "country": "string",
    "countryCode": "string",
    "postalCode": "string",
    "phone": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "consignments": [
    {
      "id": "string",
      "shippingAddress": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "street1": "string",
        "street2": "string",
        "city": "string",
        "region": "string",
        "regionCode": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "phone": "string",
        "customFields": [
          {
            "fieldId": "string",
            "fieldValue": "string"
          }
        ]
      },
      "availableShippingOptions": [
        {
          "description": "string",
          "id": "string",
          "imageUrl": "string",
          "price": 0,
          "transitTime": "string"
        }
      ],
      "selectedShippingOptionId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        "string"
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2018-02-02"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Cart Entity Object. Checkout

postCheckoutBillingAddress

POST /checkouts/{checkoutId}/billing-address

Adds customer’s billing address to checkout.

{
  "firstName": "string",
  "lastName": "string",
  "company": "string",
  "street1": "string",
  "street2": "string",
  "city": "string",
  "region": "string",
  "regionCode": "string",
  "country": "string",
  "countryCode": "string",
  "postalCode": "string",
  "phone": "string",
  "customFields": [
    {
      "fieldId": "string",
      "fieldValue": "string"
    }
  ]
}

Parameters

Parameter In Type Required Description
checkoutId path string true No description
body body AddressRequest true No description
{
  "id": "string",
  "cart": {
    "id": "string",
    "customer_id": 0,
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "taxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "taxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string"
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "street1": "string",
    "street2": "string",
    "city": "string",
    "region": "string",
    "regionCode": "string",
    "country": "string",
    "countryCode": "string",
    "postalCode": "string",
    "phone": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "consignments": [
    {
      "id": "string",
      "shippingAddress": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "street1": "string",
        "street2": "string",
        "city": "string",
        "region": "string",
        "regionCode": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "phone": "string",
        "customFields": [
          {
            "fieldId": "string",
            "fieldValue": "string"
          }
        ]
      },
      "availableShippingOptions": [
        {
          "description": "string",
          "id": "string",
          "imageUrl": "string",
          "price": 0,
          "transitTime": "string"
        }
      ],
      "selectedShippingOptionId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        "string"
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2018-02-02"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Checkout Object. Checkout

putCheckoutBillingAddress

PUT /checkouts/{checkoutId}/billing-address/{addressId}

Updates customer’s billing address in checkout.

{
  "firstName": "string",
  "lastName": "string",
  "company": "string",
  "street1": "string",
  "street2": "string",
  "city": "string",
  "region": "string",
  "regionCode": "string",
  "country": "string",
  "countryCode": "string",
  "postalCode": "string",
  "phone": "string",
  "customFields": [
    {
      "fieldId": "string",
      "fieldValue": "string"
    }
  ]
}

Parameters

Parameter In Type Required Description
checkoutId path string true No description
addressId path number true No description
body body AddressRequest true No description
{
  "id": "string",
  "cart": {
    "id": "string",
    "customer_id": 0,
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "taxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "taxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string"
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "street1": "string",
    "street2": "string",
    "city": "string",
    "region": "string",
    "regionCode": "string",
    "country": "string",
    "countryCode": "string",
    "postalCode": "string",
    "phone": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "consignments": [
    {
      "id": "string",
      "shippingAddress": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "street1": "string",
        "street2": "string",
        "city": "string",
        "region": "string",
        "regionCode": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "phone": "string",
        "customFields": [
          {
            "fieldId": "string",
            "fieldValue": "string"
          }
        ]
      },
      "availableShippingOptions": [
        {
          "description": "string",
          "id": "string",
          "imageUrl": "string",
          "price": 0,
          "transitTime": "string"
        }
      ],
      "selectedShippingOptionId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        "string"
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2018-02-02"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Checkout Object. Checkout

postCheckoutsConsignments

POST /checkouts/{checkoutId}/consignments

Adds a new consignment to checkout. A Consginment includes a shipping address, a list of line item IDs that ship to this address and a shipping option ID. When creating a new consignment, you’ll need to provide an address and a list of line item IDs. Shipping option ID should be added to this consignment later, using PUT.

[
  {
    "shippingAddress": {
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "street1": "string",
      "street2": "string",
      "city": "string",
      "region": "string",
      "regionCode": "string",
      "country": "string",
      "countryCode": "string",
      "postalCode": "string",
      "phone": "string",
      "customFields": [
        {
          "fieldId": "string",
          "fieldValue": "string"
        }
      ]
    },
    "lineItems": [
      {
        "itemId": "string",
        "quantity": 0
      }
    ]
  }
]

Parameters

Parameter In Type Required Description
includes query string false No description
checkoutId path string true No description
body body CreateConsignmentRequest true No description

Enumerated Values

Parameter Value
includes consignments.availableShippingOptions
{
  "id": "string",
  "cart": {
    "id": "string",
    "customer_id": 0,
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "taxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "taxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string"
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "street1": "string",
    "street2": "string",
    "city": "string",
    "region": "string",
    "regionCode": "string",
    "country": "string",
    "countryCode": "string",
    "postalCode": "string",
    "phone": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "consignments": [
    {
      "id": "string",
      "shippingAddress": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "street1": "string",
        "street2": "string",
        "city": "string",
        "region": "string",
        "regionCode": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "phone": "string",
        "customFields": [
          {
            "fieldId": "string",
            "fieldValue": "string"
          }
        ]
      },
      "availableShippingOptions": [
        {
          "description": "string",
          "id": "string",
          "imageUrl": "string",
          "price": 0,
          "transitTime": "string"
        }
      ],
      "selectedShippingOptionId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        "string"
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2018-02-02"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Checkout Object. Checkout

putCheckoutsConsignments

PUT /checkouts/{checkoutId}/consignments/{consignmentId}

Updates an existing consignment. Shipping address, line item IDs or the shipping option ID can be updated using this endpoint.

{
  "shippingAddress": {
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "street1": "string",
    "street2": "string",
    "city": "string",
    "region": "string",
    "regionCode": "string",
    "country": "string",
    "countryCode": "string",
    "postalCode": "string",
    "phone": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "lineItems": [
    {
      "itemId": "string",
      "quantity": 0
    }
  ],
  "shippingOptionId": "string"
}

Parameters

Parameter In Type Required Description
includes query string false No description
checkoutId path string true No description
consignmentId path string true No description
body body UpdateConsignmentRequest true No description
lineItems body ConsignmentLineItem false No description

Enumerated Values

Parameter Value
includes consignments.availableShippingOptions
{
  "id": "string",
  "cart": {
    "id": "string",
    "customer_id": 0,
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "taxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "taxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string"
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "street1": "string",
    "street2": "string",
    "city": "string",
    "region": "string",
    "regionCode": "string",
    "country": "string",
    "countryCode": "string",
    "postalCode": "string",
    "phone": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "consignments": [
    {
      "id": "string",
      "shippingAddress": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "street1": "string",
        "street2": "string",
        "city": "string",
        "region": "string",
        "regionCode": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "phone": "string",
        "customFields": [
          {
            "fieldId": "string",
            "fieldValue": "string"
          }
        ]
      },
      "availableShippingOptions": [
        {
          "description": "string",
          "id": "string",
          "imageUrl": "string",
          "price": 0,
          "transitTime": "string"
        }
      ],
      "selectedShippingOptionId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        "string"
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2018-02-02"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Checkout Object. Checkout

deleteCheckoutConsigments

DELETE /checkouts/{checkoutId}/consignments/{consignmentId}

Removes an existing consignment from checkout.

Parameters

Parameter In Type Required Description
checkoutId path string true No description
consignmentId path string true No description
{
  "id": "string",
  "cart": {
    "id": "string",
    "customer_id": 0,
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "taxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "taxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string"
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "street1": "string",
    "street2": "string",
    "city": "string",
    "region": "string",
    "regionCode": "string",
    "country": "string",
    "countryCode": "string",
    "postalCode": "string",
    "phone": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "consignments": [
    {
      "id": "string",
      "shippingAddress": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "street1": "string",
        "street2": "string",
        "city": "string",
        "region": "string",
        "regionCode": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "phone": "string",
        "customFields": [
          {
            "fieldId": "string",
            "fieldValue": "string"
          }
        ]
      },
      "availableShippingOptions": [
        {
          "description": "string",
          "id": "string",
          "imageUrl": "string",
          "price": 0,
          "transitTime": "string"
        }
      ],
      "selectedShippingOptionId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        "string"
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2018-02-02"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Checkout Object. Checkout

postCheckoutsGiftCertificate

POST /checkouts/{checkoutId}/gift-certificates

Adds gift certificate code to checkout.

{
  "giftCertificateCode": "string"
}

Parameters

Parameter In Type Required Description
checkoutId path string true No description
body body GiftCertificateRequest true No description
{
  "id": "string",
  "cart": {
    "id": "string",
    "customer_id": 0,
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "taxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "taxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string"
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "street1": "string",
    "street2": "string",
    "city": "string",
    "region": "string",
    "regionCode": "string",
    "country": "string",
    "countryCode": "string",
    "postalCode": "string",
    "phone": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "consignments": [
    {
      "id": "string",
      "shippingAddress": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "street1": "string",
        "street2": "string",
        "city": "string",
        "region": "string",
        "regionCode": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "phone": "string",
        "customFields": [
          {
            "fieldId": "string",
            "fieldValue": "string"
          }
        ]
      },
      "availableShippingOptions": [
        {
          "description": "string",
          "id": "string",
          "imageUrl": "string",
          "price": 0,
          "transitTime": "string"
        }
      ],
      "selectedShippingOptionId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        "string"
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2018-02-02"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Checkout Object Checkout

deleteCheckoutsGiftCertificate

DELETE /checkouts/{checkoutId}/gift-certificates/{giftCertificateCode}

Removes an existing gift certificate from checkout.

Parameters

Parameter In Type Required Description
checkoutId path string true No description
giftCertificateCode path string true No description
{
  "id": "string",
  "cart": {
    "id": "string",
    "customer_id": 0,
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "taxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "taxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string"
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "street1": "string",
    "street2": "string",
    "city": "string",
    "region": "string",
    "regionCode": "string",
    "country": "string",
    "countryCode": "string",
    "postalCode": "string",
    "phone": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "consignments": [
    {
      "id": "string",
      "shippingAddress": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "street1": "string",
        "street2": "string",
        "city": "string",
        "region": "string",
        "regionCode": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "phone": "string",
        "customFields": [
          {
            "fieldId": "string",
            "fieldValue": "string"
          }
        ]
      },
      "availableShippingOptions": [
        {
          "description": "string",
          "id": "string",
          "imageUrl": "string",
          "price": 0,
          "transitTime": "string"
        }
      ],
      "selectedShippingOptionId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        "string"
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2018-02-02"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Checkout Object. Checkout

postCheckoutCouponsCode

POST /checkouts/{checkoutId}/coupons

Adds a coupon code to checkout.

{
  "couponCode": "string"
}

Parameters

Parameter In Type Required Description
checkoutId path string true No description
body body CouponCodeRequest true No description
{
  "id": "string",
  "cart": {
    "id": "string",
    "customer_id": 0,
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "taxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "taxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string"
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "street1": "string",
    "street2": "string",
    "city": "string",
    "region": "string",
    "regionCode": "string",
    "country": "string",
    "countryCode": "string",
    "postalCode": "string",
    "phone": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "consignments": [
    {
      "id": "string",
      "shippingAddress": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "street1": "string",
        "street2": "string",
        "city": "string",
        "region": "string",
        "regionCode": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "phone": "string",
        "customFields": [
          {
            "fieldId": "string",
            "fieldValue": "string"
          }
        ]
      },
      "availableShippingOptions": [
        {
          "description": "string",
          "id": "string",
          "imageUrl": "string",
          "price": 0,
          "transitTime": "string"
        }
      ],
      "selectedShippingOptionId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        "string"
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2018-02-02"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Checkout Object. Checkout

deleteCheckoutCouponCode

DELETE /checkouts/{checkoutId}/coupons/{couponCode}

Removes an existing coupon from checkout.

Parameters

Parameter In Type Required Description
checkoutId path string true No description
couponCode path string true No description
{
  "id": "string",
  "cart": {
    "id": "string",
    "customer_id": 0,
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "taxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "taxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string"
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "street1": "string",
    "street2": "string",
    "city": "string",
    "region": "string",
    "regionCode": "string",
    "country": "string",
    "countryCode": "string",
    "postalCode": "string",
    "phone": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "consignments": [
    {
      "id": "string",
      "shippingAddress": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "street1": "string",
        "street2": "string",
        "city": "string",
        "region": "string",
        "regionCode": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "phone": "string",
        "customFields": [
          {
            "fieldId": "string",
            "fieldValue": "string"
          }
        ]
      },
      "availableShippingOptions": [
        {
          "description": "string",
          "id": "string",
          "imageUrl": "string",
          "price": 0,
          "transitTime": "string"
        }
      ],
      "selectedShippingOptionId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        "string"
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2018-02-02"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Checkout Object. Checkout

postCheckoutOrder

POST /checkouts/{checkoutId}/order

Creates an order.

{
  "customerMessage": "string",
  "payment": {
    "name": "string",
    "paymentData": {
      "applePayToken": {},
      "ccNumber": 0,
      "ccCvv": 0,
      "ccName": "string",
      "ccExpiry": {
        "month": 0,
        "year": 0
      },
      "ccType": "string"
    }
  }
}

Parameters

Parameter In Type Required Description
checkoutId path string true No description
body body RequestOrderData true A data collection consumed that the order endpoint consumes when creating an order with different payment methods/payment providers.
{
  "meta": {},
  "data": {
    "order": {
      "orderId": 0,
      "cartId": "string",
      "currency": {
        "name": "string",
        "code": "string",
        "symbol": "string"
      },
      "isTaxIncluded": true,
      "baseAmount": 0,
      "discountAmount": 0,
      "orderAmount": 0,
      "coupons": [
        {
          "id": "string",
          "code": "string",
          "name": "string",
          "couponType": "string",
          "discountedAmount": 0
        }
      ],
      "discounts": [
        {
          "name": "string",
          "discountedAmount": 0
        }
      ],
      "lineItems": [
        {
          "physicalItems": [
            {
              "id": "string",
              "variantId": 0,
              "productId": 0,
              "sku": "string",
              "name": "string",
              "url": "http://example.com",
              "quantity": 0,
              "isTaxable": true,
              "imageUrl": "http://example.com",
              "discounts": [
                {
                  "name": "string",
                  "discountedAmount": 0
                }
              ],
              "discountAmount": 0,
              "couponAmount": 0,
              "listPrice": 0,
              "salePrice": 0,
              "extendedListPrice": 0,
              "extendedSalePrice": 0,
              "isShippingRequired": true,
              "giftWrapping": {
                "name": "string",
                "message": "string",
                "amount": 0
              }
            }
          ],
          "digitalItems": [
            {
              "id": "string",
              "variantId": 0,
              "productId": 0,
              "sku": "string",
              "name": "string",
              "url": "http://example.com",
              "quantity": 0,
              "isTaxable": true,
              "imageUrl": "http://example.com",
              "discounts": [
                {
                  "name": "string",
                  "discountedAmount": 0
                }
              ],
              "discountAmount": 0,
              "couponAmount": 0,
              "listPrice": 0,
              "salePrice": 0,
              "extendedListPrice": 0,
              "extendedSalePrice": 0,
              "downloadFileUrls": [
                "string"
              ],
              "downloadPageUrl": "string",
              "downloadSize": "string"
            }
          ],
          "giftCertificate": [
            {
              "name": "string",
              "quantity": 0,
              "isTaxable": true,
              "amount": 0
            }
          ]
        }
      ],
      "customerId": "string",
      "token": "string",
      "billingAddress": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "street1": "string",
        "street2": "string",
        "city": "string",
        "region": "string",
        "regionCode": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "phone": "string",
        "customFields": [
          {
            "fieldId": "string",
            "fieldValue": "string"
          }
        ]
      },
      "payment": {
        "id": "string",
        "redirectUrl": "string",
        "returnUrl": "string",
        "status": "PAYMENT_STATUS_INITIALIZE",
        "helpText": "string"
      },
      "status": "INCOMPLETE",
      "customerCreated": true,
      "hasDigitalItems": true,
      "isDownloadable": true,
      "isComplete": true
    }
  }
}

Responses

Status Meaning Description Schema
201 Created Returns a subset of Order Object. ResponseOrderData

Order

getOrders

GET /orders/{orderId}

Retrieves order data.

Parameters

Parameter In Type Required Description
orderId path integer true ID of an Order.
{
  "meta": {},
  "data": {
    "order": {
      "orderId": 0,
      "cartId": "string",
      "currency": {
        "name": "string",
        "code": "string",
        "symbol": "string"
      },
      "isTaxIncluded": true,
      "baseAmount": 0,
      "discountAmount": 0,
      "orderAmount": 0,
      "coupons": [
        {
          "id": "string",
          "code": "string",
          "name": "string",
          "couponType": "string",
          "discountedAmount": 0
        }
      ],
      "discounts": [
        {
          "name": "string",
          "discountedAmount": 0
        }
      ],
      "lineItems": [
        {
          "physicalItems": [
            {
              "id": "string",
              "variantId": 0,
              "productId": 0,
              "sku": "string",
              "name": "string",
              "url": "http://example.com",
              "quantity": 0,
              "isTaxable": true,
              "imageUrl": "http://example.com",
              "discounts": [
                {
                  "name": "string",
                  "discountedAmount": 0
                }
              ],
              "discountAmount": 0,
              "couponAmount": 0,
              "listPrice": 0,
              "salePrice": 0,
              "extendedListPrice": 0,
              "extendedSalePrice": 0,
              "isShippingRequired": true,
              "giftWrapping": {
                "name": "string",
                "message": "string",
                "amount": 0
              }
            }
          ],
          "digitalItems": [
            {
              "id": "string",
              "variantId": 0,
              "productId": 0,
              "sku": "string",
              "name": "string",
              "url": "http://example.com",
              "quantity": 0,
              "isTaxable": true,
              "imageUrl": "http://example.com",
              "discounts": [
                {
                  "name": "string",
                  "discountedAmount": 0
                }
              ],
              "discountAmount": 0,
              "couponAmount": 0,
              "listPrice": 0,
              "salePrice": 0,
              "extendedListPrice": 0,
              "extendedSalePrice": 0,
              "downloadFileUrls": [
                "string"
              ],
              "downloadPageUrl": "string",
              "downloadSize": "string"
            }
          ],
          "giftCertificate": [
            {
              "name": "string",
              "quantity": 0,
              "isTaxable": true,
              "amount": 0
            }
          ]
        }
      ],
      "customerId": "string",
      "token": "string",
      "billingAddress": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "street1": "string",
        "street2": "string",
        "city": "string",
        "region": "string",
        "regionCode": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "phone": "string",
        "customFields": [
          {
            "fieldId": "string",
            "fieldValue": "string"
          }
        ]
      },
      "payment": {
        "id": "string",
        "redirectUrl": "string",
        "returnUrl": "string",
        "status": "PAYMENT_STATUS_INITIALIZE",
        "helpText": "string"
      },
      "status": "INCOMPLETE",
      "customerCreated": true,
      "hasDigitalItems": true,
      "isDownloadable": true,
      "isComplete": true
    }
  }
}

Responses

Status Meaning Description Schema
200 OK Returns a subset of Order Object. ResponseOrderData

Schemas

LineItemRequestData

{
  "quantity": 0,
  "productId": 0,
  "variantId": 0
}

Properties

Name Type Required Description
quantity number false No description
productId number false No description
variantId number false No description

LineItemGiftCertificateRequestData

{
  "theme": "string",
  "amount": 1,
  "sender": {
    "name": "string",
    "email": "user@example.com"
  },
  "recipient": {
    "name": "string",
    "email": "user@example.com"
  },
  "message": "string",
  "quantity": 0
}

Properties

Name Type Required Description
theme string true Currently supports Birthday, Boy, Celebration, Christmas, General, and Girl.
amount number true No description
sender ContactEntity true No description
recipient ContactEntity true No description
message string false Message shown to recipient, as provided by sender.
quantity number true No description

Checkout

{
  "id": "string",
  "cart": {
    "id": "string",
    "customer_id": 0,
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "taxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "variantId": 0,
            "productId": 0,
            "sku": "string",
            "name": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "discountAmount": 0,
            "couponAmount": 0,
            "listPrice": 0,
            "salePrice": 0,
            "extendedListPrice": 0,
            "extendedSalePrice": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "taxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string"
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "street1": "string",
    "street2": "string",
    "city": "string",
    "region": "string",
    "regionCode": "string",
    "country": "string",
    "countryCode": "string",
    "postalCode": "string",
    "phone": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "consignments": [
    {
      "id": "string",
      "shippingAddress": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "street1": "string",
        "street2": "string",
        "city": "string",
        "region": "string",
        "regionCode": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "phone": "string",
        "customFields": [
          {
            "fieldId": "string",
            "fieldValue": "string"
          }
        ]
      },
      "availableShippingOptions": [
        {
          "description": "string",
          "id": "string",
          "imageUrl": "string",
          "price": 0,
          "transitTime": "string"
        }
      ],
      "selectedShippingOptionId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        "string"
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2018-02-02"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Properties

Name Type Required Description
id string(UUID) false No description
cart Cart false No description
shopper Shopper false No description
billingAddress AddressResponse false No description
consignments Consignment false No description
taxes Tax false No description
discounts AppliedDiscount false Discounts applied after addresses have been selected.
coupons AppliedCoupon false Coupons applied at checkout level.
orderId string false No description
shippingCostTotal number false Shipping cost before any discounts are applied.
taxTotal number false No description
grandTotal number false The total payable amount, before applying any store credit or gift certificate.
storeCredit number false Applied store credit.
giftCertificates GiftCertificate false Applied gift certificate (as a payment method).
balanceDue number false The total payable amount due, after applying any store credit or gift certificate.
createdTime string(ISO-8601) false Time when the cart was created.
updatedTime string(ISO-8601) false Time when the cart was last updated.

Cart

{
  "id": "string",
  "customer_id": 0,
  "currency": {
    "name": "string",
    "code": "string",
    "symbol": "string"
  },
  "taxIncluded": true,
  "baseAmount": 0,
  "discountAmount": 0,
  "cartAmount": 0,
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "lineItems": [
    {
      "physicalItems": [
        {
          "id": "string",
          "variantId": 0,
          "productId": 0,
          "sku": "string",
          "name": "string",
          "url": "http://example.com",
          "quantity": 0,
          "isTaxable": true,
          "imageUrl": "http://example.com",
          "discounts": [
            {
              "name": "string",
              "discountedAmount": 0
            }
          ],
          "discountAmount": 0,
          "couponAmount": 0,
          "listPrice": 0,
          "salePrice": 0,
          "extendedListPrice": 0,
          "extendedSalePrice": 0,
          "isShippingRequired": true,
          "giftWrapping": {
            "name": "string",
            "message": "string",
            "amount": 0
          }
        }
      ],
      "digitalItems": [
        {
          "id": "string",
          "variantId": 0,
          "productId": 0,
          "sku": "string",
          "name": "string",
          "url": "http://example.com",
          "quantity": 0,
          "isTaxable": true,
          "imageUrl": "http://example.com",
          "discounts": [
            {
              "name": "string",
              "discountedAmount": 0
            }
          ],
          "discountAmount": 0,
          "couponAmount": 0,
          "listPrice": 0,
          "salePrice": 0,
          "extendedListPrice": 0,
          "extendedSalePrice": 0,
          "downloadFileUrls": [
            "string"
          ],
          "downloadPageUrl": "string",
          "downloadSize": "string"
        }
      ],
      "giftCertificate": [
        {
          "id": "string",
          "theme": "string",
          "amount": 0,
          "taxable": true,
          "sender": {
            "name": "string",
            "email": "user@example.com"
          },
          "recipient": {
            "name": "string",
            "email": "user@example.com"
          },
          "message": "string"
        }
      ]
    }
  ],
  "createdTime": "string",
  "updatedTime": "string"
}

Properties

Name Type Required Description
id string(UUID) false Cart ID, provided after creating a cart with a POST.
customer_id integer false ID of the customer to which the cart belongs.
currency Currency false No description
taxIncluded boolean false Boolean representing whether tax information is included.
baseAmount number false Cost of cart’s contents, before applying discounts.
discountAmount number false Discounted amount.
cartAmount number false Sum of line-items amounts, minus cart-level discounts and coupons. This amount includes taxes (where applicable).
coupons AppliedCoupon false No description
discounts AppliedDiscount false No description
lineItems LineItem false No description
createdTime string(ISO-8601) false Time when the cart was created.
updatedTime string(ISO-8601) false Time when the cart was last updated.

Consignment

{
  "id": "string",
  "shippingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "street1": "string",
    "street2": "string",
    "city": "string",
    "region": "string",
    "regionCode": "string",
    "country": "string",
    "countryCode": "string",
    "postalCode": "string",
    "phone": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "availableShippingOptions": [
    {
      "description": "string",
      "id": "string",
      "imageUrl": "string",
      "price": 0,
      "transitTime": "string"
    }
  ],
  "selectedShippingOptionId": "string",
  "shippingCost": 0,
  "lineItemIds": [
    "string"
  ]
}

Properties

Name Type Required Description
id string false No description
shippingAddress AddressResponse false No description
availableShippingOptions ShippingOptionEntity false * Note
selectedShippingOptionId string false The ID of the selected shipping option for a given consignment.
shippingCost number(float) false The cost of shipping for this consignment.
lineItemIds [string] false No description

Shopper

{
  "customerId": "string",
  "customerGroupId": "string",
  "storeCredit": "string"
}

Properties

Name Type Required Description
customerId string false No description
customerGroupId string false No description
storeCredit string false No description

Currency

{
  "name": "string",
  "code": "string",
  "symbol": "string"
}

Properties

Name Type Required Description
name string false The currency name.
code string false ISO-4217 currency code. (See: http://en.wikipedia.org/wiki/ISO_4217.)
symbol string false The currency symbol.

AddressResponse

{
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "company": "string",
  "street1": "string",
  "street2": "string",
  "city": "string",
  "region": "string",
  "regionCode": "string",
  "country": "string",
  "countryCode": "string",
  "postalCode": "string",
  "phone": "string",
  "customFields": [
    {
      "fieldId": "string",
      "fieldValue": "string"
    }
  ]
}

Properties

Name Type Required Description
id string false No description

OrderLineItem

{
  "physicalItems": [
    {
      "id": "string",
      "variantId": 0,
      "productId": 0,
      "sku": "string",
      "name": "string",
      "url": "http://example.com",
      "quantity": 0,
      "isTaxable": true,
      "imageUrl": "http://example.com",
      "discounts": [
        {
          "name": "string",
          "discountedAmount": 0
        }
      ],
      "discountAmount": 0,
      "couponAmount": 0,
      "listPrice": 0,
      "salePrice": 0,
      "extendedListPrice": 0,
      "extendedSalePrice": 0,
      "isShippingRequired": true,
      "giftWrapping": {
        "name": "string",
        "message": "string",
        "amount": 0
      }
    }
  ],
  "digitalItems": [
    {
      "id": "string",
      "variantId": 0,
      "productId": 0,
      "sku": "string",
      "name": "string",
      "url": "http://example.com",
      "quantity": 0,
      "isTaxable": true,
      "imageUrl": "http://example.com",
      "discounts": [
        {
          "name": "string",
          "discountedAmount": 0
        }
      ],
      "discountAmount": 0,
      "couponAmount": 0,
      "listPrice": 0,
      "salePrice": 0,
      "extendedListPrice": 0,
      "extendedSalePrice": 0,
      "downloadFileUrls": [
        "string"
      ],
      "downloadPageUrl": "string",
      "downloadSize": "string"
    }
  ],
  "giftCertificate": [
    {
      "name": "string",
      "quantity": 0,
      "isTaxable": true,
      "amount": 0
    }
  ]
}

Properties

Name Type Required Description
physicalItems ItemPhysical true Array of ItemPhysical objects.
digitalItems OrderItemDigital true Array of ItemDigital objects.
giftCertificate OrderItemGiftCertificate true Array of ItemGiftCertificate objects.

LineItem

{
  "physicalItems": [
    {
      "id": "string",
      "variantId": 0,
      "productId": 0,
      "sku": "string",
      "name": "string",
      "url": "http://example.com",
      "quantity": 0,
      "isTaxable": true,
      "imageUrl": "http://example.com",
      "discounts": [
        {
          "name": "string",
          "discountedAmount": 0
        }
      ],
      "discountAmount": 0,
      "couponAmount": 0,
      "listPrice": 0,
      "salePrice": 0,
      "extendedListPrice": 0,
      "extendedSalePrice": 0,
      "isShippingRequired": true,
      "giftWrapping": {
        "name": "string",
        "message": "string",
        "amount": 0
      }
    }
  ],
  "digitalItems": [
    {
      "id": "string",
      "variantId": 0,
      "productId": 0,
      "sku": "string",
      "name": "string",
      "url": "http://example.com",
      "quantity": 0,
      "isTaxable": true,
      "imageUrl": "http://example.com",
      "discounts": [
        {
          "name": "string",
          "discountedAmount": 0
        }
      ],
      "discountAmount": 0,
      "couponAmount": 0,
      "listPrice": 0,
      "salePrice": 0,
      "extendedListPrice": 0,
      "extendedSalePrice": 0,
      "downloadFileUrls": [
        "string"
      ],
      "downloadPageUrl": "string",
      "downloadSize": "string"
    }
  ],
  "giftCertificate": [
    {
      "id": "string",
      "theme": "string",
      "amount": 0,
      "taxable": true,
      "sender": {
        "name": "string",
        "email": "user@example.com"
      },
      "recipient": {
        "name": "string",
        "email": "user@example.com"
      },
      "message": "string"
    }
  ]
}

Properties

Name Type Required Description
physicalItems ItemPhysical true No description
digitalItems ItemDigital true No description
giftCertificate ItemGiftCertificate true No description

CartUpdateRequest

{
  "lineItem": {
    "quantity": 0,
    "productId": 0,
    "variantId": 0
  },
  "giftCertificate": {
    "theme": "string",
    "amount": 1,
    "sender": {
      "name": "string",
      "email": "user@example.com"
    },
    "recipient": {
      "name": "string",
      "email": "user@example.com"
    },
    "message": "string",
    "quantity": 0
  }
}

Properties

Name Type Required Description
lineItem LineItemRequestData false No description
giftCertificate LineItemGiftCertificateRequestData false No description

OrderItemGiftCertificate

{
  "name": "string",
  "quantity": 0,
  "isTaxable": true,
  "amount": 0
}

Properties

Name Type Required Description
name string false The item’s product name.
quantity number false Quantity of this item.
isTaxable boolean false Whether the item is taxable.
amount number(float) false Price of the item

ItemGiftCertificate

{
  "id": "string",
  "theme": "string",
  "amount": 0,
  "taxable": true,
  "sender": {
    "name": "string",
    "email": "user@example.com"
  },
  "recipient": {
    "name": "string",
    "email": "user@example.com"
  },
  "message": "string"
}

Properties

Name Type Required Description
id string false No description
theme string true Currently supports Birthday, Boy, Celebration, Christmas, General, and Girl.
amount number true Value must be between $1.00 and $1,000.00.
taxable boolean false No description
sender ContactEntity true No description
recipient ContactEntity true No description
message string false Limited to 200 characters.

ContactEntity

{
  "name": "string",
  "email": "user@example.com"
}

Properties

Name Type Required Description
name string false No description
email string(email) false No description

OrderItemDigital

{
  "id": "string",
  "variantId": 0,
  "productId": 0,
  "sku": "string",
  "name": "string",
  "url": "http://example.com",
  "quantity": 0,
  "isTaxable": true,
  "imageUrl": "http://example.com",
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "discountAmount": 0,
  "couponAmount": 0,
  "listPrice": 0,
  "salePrice": 0,
  "extendedListPrice": 0,
  "extendedSalePrice": 0,
  "downloadFileUrls": [
    "string"
  ],
  "downloadPageUrl": "string",
  "downloadSize": "string"
}

Properties

Name Type Required Description
allOf BaseItem false No description
downloadFileUrls [string] false URLs to download all product files.
downloadPageUrl string(url) false The URL for the combined downloads page.
downloadSize string false Combined download size, in human-readable style. E.g.: 30MB.

ItemDigital

{
  "id": "string",
  "variantId": 0,
  "productId": 0,
  "sku": "string",
  "name": "string",
  "url": "http://example.com",
  "quantity": 0,
  "isTaxable": true,
  "imageUrl": "http://example.com",
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "discountAmount": 0,
  "couponAmount": 0,
  "listPrice": 0,
  "salePrice": 0,
  "extendedListPrice": 0,
  "extendedSalePrice": 0,
  "downloadFileUrls": [
    "string"
  ],
  "downloadPageUrl": "string",
  "downloadSize": "string"
}

Properties

Name Type Required Description
allOf BaseItem false No description
downloadFileUrls [string] false URLs to download all product files.
downloadPageUrl string(url) false The URL for the combined downloads page.
downloadSize string false Combined download size, in human-readable style. E.g.: 30MB.

ItemPhysical

{
  "id": "string",
  "variantId": 0,
  "productId": 0,
  "sku": "string",
  "name": "string",
  "url": "http://example.com",
  "quantity": 0,
  "isTaxable": true,
  "imageUrl": "http://example.com",
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "discountAmount": 0,
  "couponAmount": 0,
  "listPrice": 0,
  "salePrice": 0,
  "extendedListPrice": 0,
  "extendedSalePrice": 0,
  "isShippingRequired": true,
  "giftWrapping": {
    "name": "string",
    "message": "string",
    "amount": 0
  }
}

Properties

Name Type Required Description
allOf BaseItem false No description
isShippingRequired boolean false Whether this item requires shipping to a physical address.
giftWrapping GiftWrapping false A BigCommerce GiftWrapping object.

BaseItem

{
  "id": "string",
  "variantId": 0,
  "productId": 0,
  "sku": "string",
  "name": "string",
  "url": "http://example.com",
  "quantity": 0,
  "isTaxable": true,
  "imageUrl": "http://example.com",
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "discountAmount": 0,
  "couponAmount": 0,
  "listPrice": 0,
  "salePrice": 0,
  "extendedListPrice": 0,
  "extendedSalePrice": 0
}

Properties

Name Type Required Description
id string false The line-item ID.
variantId number false ID of the variant.
productId number false ID of the product.
sku string false SKU of the variant.
name string false The item’s product name.
url string(uri) false The product URL.
quantity number true Quantity of this item.
isTaxable boolean false Whether the item is taxable.
imageUrl string(uri) false URL of an image of this item, accessible on the internet.
discounts AppliedDiscount false List of discounts applied to this item, as an array of AppliedDiscount objects.
discountAmount number(float) false The total value of all discounts applied to this item (excluding coupon).
couponAmount number false The total value of all coupons applied to this item.
listPrice number false Item’s list price, as quoted by the manufacturer/distributor.
salePrice number false Item’s price after all discounts are applied. (The final price before tax calculation.)
extendedListPrice number false Item’s list price multiplied by the quantity.
extendedSalePrice number false Item’s sale price multiplied by the quantity.

Tax

{
  "itemId": "string",
  "name": "string",
  "amount": 0,
  "percentage": 0
}

Properties

Name Type Required Description
itemId string false No description
name string false Name of the tax.
amount number false No description
percentage number false No description

AppliedCoupon

{
  "id": "string",
  "code": "string",
  "name": "string",
  "couponType": "string",
  "discountedAmount": 0
}

Properties

Name Type Required Description
id string false The coupon ID.
code string true No description
name string false The coupon name, as specified by the merchant.
couponType string false Key name to identify the type of coupon.
discountedAmount number false The discounted amount applied within a given context.

AppliedDiscount

{
  "name": "string",
  "discountedAmount": 0
}

Properties

Name Type Required Description
name string false The name provided by the merchant.
discountedAmount number false The discounted amount applied within a given context.

GiftWrapping

{
  "name": "string",
  "message": "string",
  "amount": 0
}

Properties

Name Type Required Description
name string false No description
message string false No description
amount number(float) false No description

GiftCertificateRequest

{
  "giftCertificateCode": "string"
}

Properties

Name Type Required Description
giftCertificateCode string false No description

CouponCodeRequest

{
  "couponCode": "string"
}

Properties

Name Type Required Description
couponCode string false No description

GiftCertificate

{
  "balance": 0,
  "code": "string",
  "purchaseDate": "2018-02-02"
}

Properties

Name Type Required Description
balance number false No description
code string false No description
purchaseDate string(date) false No description

CheckoutError

{
  "errors": [
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "detail": "string"
    }
  ]
}

Properties

Name Type Required Description
errors [ErrorInner] false No description

ErrorInner

{
  "status": 0,
  "title": "string",
  "type": "string",
  "detail": "string"
}

Properties

Name Type Required Description
status integer false No description
title string false No description
type string false No description
detail string false No description

RequestOrderData

{
  "customerMessage": "string",
  "payment": {
    "name": "string",
    "paymentData": {
      "applePayToken": {},
      "ccNumber": 0,
      "ccCvv": 0,
      "ccName": "string",
      "ccExpiry": {
        "month": 0,
        "year": 0
      },
      "ccType": "string"
    }
  }
}

Properties

Name Type Required Description
customerMessage string false An optional message the customer may associate with this order.
payment object false Payment details that payment providers require to finalize the payment.
name string true Name of the payment provider.
paymentData PaymentData false No description

ResponseOrderData

{
  "meta": {},
  "data": {
    "order": {
      "orderId": 0,
      "cartId": "string",
      "currency": {
        "name": "string",
        "code": "string",
        "symbol": "string"
      },
      "isTaxIncluded": true,
      "baseAmount": 0,
      "discountAmount": 0,
      "orderAmount": 0,
      "coupons": [
        {
          "id": "string",
          "code": "string",
          "name": "string",
          "couponType": "string",
          "discountedAmount": 0
        }
      ],
      "discounts": [
        {
          "name": "string",
          "discountedAmount": 0
        }
      ],
      "lineItems": [
        {
          "physicalItems": [
            {
              "id": "string",
              "variantId": 0,
              "productId": 0,
              "sku": "string",
              "name": "string",
              "url": "http://example.com",
              "quantity": 0,
              "isTaxable": true,
              "imageUrl": "http://example.com",
              "discounts": [
                {
                  "name": "string",
                  "discountedAmount": 0
                }
              ],
              "discountAmount": 0,
              "couponAmount": 0,
              "listPrice": 0,
              "salePrice": 0,
              "extendedListPrice": 0,
              "extendedSalePrice": 0,
              "isShippingRequired": true,
              "giftWrapping": {
                "name": "string",
                "message": "string",
                "amount": 0
              }
            }
          ],
          "digitalItems": [
            {
              "id": "string",
              "variantId": 0,
              "productId": 0,
              "sku": "string",
              "name": "string",
              "url": "http://example.com",
              "quantity": 0,
              "isTaxable": true,
              "imageUrl": "http://example.com",
              "discounts": [
                {
                  "name": "string",
                  "discountedAmount": 0
                }
              ],
              "discountAmount": 0,
              "couponAmount": 0,
              "listPrice": 0,
              "salePrice": 0,
              "extendedListPrice": 0,
              "extendedSalePrice": 0,
              "downloadFileUrls": [
                "string"
              ],
              "downloadPageUrl": "string",
              "downloadSize": "string"
            }
          ],
          "giftCertificate": [
            {
              "name": "string",
              "quantity": 0,
              "isTaxable": true,
              "amount": 0
            }
          ]
        }
      ],
      "customerId": "string",
      "token": "string",
      "billingAddress": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "street1": "string",
        "street2": "string",
        "city": "string",
        "region": "string",
        "regionCode": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "phone": "string",
        "customFields": [
          {
            "fieldId": "string",
            "fieldValue": "string"
          }
        ]
      },
      "payment": {
        "id": "string",
        "redirectUrl": "string",
        "returnUrl": "string",
        "status": "PAYMENT_STATUS_INITIALIZE",
        "helpText": "string"
      },
      "status": "INCOMPLETE",
      "customerCreated": true,
      "hasDigitalItems": true,
      "isDownloadable": true,
      "isComplete": true
    }
  }
}

Properties

Name Type Required Description
meta object false No description
data object false Response data container for Order endpoints (POST /order and POST /order/{orderId}).
order Order false No description

Order

{
  "orderId": 0,
  "cartId": "string",
  "currency": {
    "name": "string",
    "code": "string",
    "symbol": "string"
  },
  "isTaxIncluded": true,
  "baseAmount": 0,
  "discountAmount": 0,
  "orderAmount": 0,
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "lineItems": [
    {
      "physicalItems": [
        {
          "id": "string",
          "variantId": 0,
          "productId": 0,
          "sku": "string",
          "name": "string",
          "url": "http://example.com",
          "quantity": 0,
          "isTaxable": true,
          "imageUrl": "http://example.com",
          "discounts": [
            {
              "name": "string",
              "discountedAmount": 0
            }
          ],
          "discountAmount": 0,
          "couponAmount": 0,
          "listPrice": 0,
          "salePrice": 0,
          "extendedListPrice": 0,
          "extendedSalePrice": 0,
          "isShippingRequired": true,
          "giftWrapping": {
            "name": "string",
            "message": "string",
            "amount": 0
          }
        }
      ],
      "digitalItems": [
        {
          "id": "string",
          "variantId": 0,
          "productId": 0,
          "sku": "string",
          "name": "string",
          "url": "http://example.com",
          "quantity": 0,
          "isTaxable": true,
          "imageUrl": "http://example.com",
          "discounts": [
            {
              "name": "string",
              "discountedAmount": 0
            }
          ],
          "discountAmount": 0,
          "couponAmount": 0,
          "listPrice": 0,
          "salePrice": 0,
          "extendedListPrice": 0,
          "extendedSalePrice": 0,
          "downloadFileUrls": [
            "string"
          ],
          "downloadPageUrl": "string",
          "downloadSize": "string"
        }
      ],
      "giftCertificate": [
        {
          "name": "string",
          "quantity": 0,
          "isTaxable": true,
          "amount": 0
        }
      ]
    }
  ],
  "customerId": "string",
  "token": "string",
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "street1": "string",
    "street2": "string",
    "city": "string",
    "region": "string",
    "regionCode": "string",
    "country": "string",
    "countryCode": "string",
    "postalCode": "string",
    "phone": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "payment": {
    "id": "string",
    "redirectUrl": "string",
    "returnUrl": "string",
    "status": "PAYMENT_STATUS_INITIALIZE",
    "helpText": "string"
  },
  "status": "INCOMPLETE",
  "customerCreated": true,
  "hasDigitalItems": true,
  "isDownloadable": true,
  "isComplete": true
}

Properties

Name Type Required Description
orderId number false No description
cartId string(UUID) false The Id of cart that was converted to order.
currency Currency false This will always be the same between cart and checkout.
isTaxIncluded boolean false Whether this item is taxable.
baseAmount number false Cost of cart’s contents, before applying discounts.
discountAmount number(float) false Discounted amount.
orderAmount number false Sum of line-items amounts, minus cart-level discounts and coupons. This amount includes taxes (where applicable).
coupons AppliedCoupon false Array of AppliedCoupon objects applied to this cart.
discounts AppliedDiscount false Array of AppliedDiscount objects applied to this cart.
lineItems OrderLineItem false Array of LineItem objects.
customerId string false No description
token string false No description
billingAddress AddressResponse false No description
payment OrderPayment false No description
status string false Order status.
customerCreated boolean false For guest checkouts, this flag will identify whether a new customer account was created for this order, or whether the billing email already existed on the store.
hasDigitalItems boolean false Specifies whether this order has at least one digital item.
isDownloadable boolean false Specifies whether this order is fully paid, so that digital items can be downloaded.
isComplete boolean false Specifies whether this order is complete and ready to be taken to the order confirmation page.

Enumerated Values

Property Value
status INCOMPLETE
status PENDING
status SHIPPED
status PARTIALLY_SHIPPED
status REFUNDED
status CANCELLED
status DECLINED
status AWAITING_PAYMENT
status AWAITING_PICKUP
status AWAITING_SHIPMENT
status COMPLETED
status AWAITING_FULFILLMENT
status MANUAL_VERIFICATION_REQUIRED
status DISPUTED
status PARTIALLY_REFUNDED

OrderPayment

{
  "id": "string",
  "redirectUrl": "string",
  "returnUrl": "string",
  "status": "PAYMENT_STATUS_INITIALIZE",
  "helpText": "string"
}

Properties

Name Type Required Description
id string false The name of the payment module in the BC app.
redirectUrl string false The URL used to redirect to the hosted payment provider’s website.
returnUrl string false The URL used to return from the hosted payment provider’s website.
status string false Possible statuses that the hosted payment can have.
helpText string false Any message that must be shown to the user on the confirmation page for offline payments.

Enumerated Values

Property Value
status PAYMENT_STATUS_INITIALIZE
status PAYMENT_STATUS_ACKNOWLEDGE
status PAYMENT_STATUS_FINALIZE

PaymentData

{
  "applePayToken": {},
  "ccNumber": 0,
  "ccCvv": 0,
  "ccName": "string",
  "ccExpiry": {
    "month": 0,
    "year": 0
  },
  "ccType": "string"
}

Properties

Name Type Required Description
applePayToken object false Opaque Apple Pay payment token. This would normally be e.token from the Apple Pay authorization callback. Pass this only for Apple Pay transactions.
ccNumber number(string) false The credit-card number. Required for credit-card payments.
ccCvv number(string) false The credit-card CVV code. Required for credit-card payments.
ccName string false The credit-card name. Required for credit-card payments.
ccExpiry CreditCardExpiryDate false No description
ccType string false The credit-card type, such as Visa, MasterCard, etc.

CreditCardExpiryDate

{
  "month": 0,
  "year": 0
}

Properties

Name Type Required Description
month number(string) true No description
year number(string) true No description

ShippingOptionEntity

{
  "description": "string",
  "id": "string",
  "imageUrl": "string",
  "price": 0,
  "transitTime": "string"
}

Properties

Name Type Required Description
description string false No description
id string false No description
imageUrl string false No description
price number false No description
transitTime string false An estimate of the arrival time.

AddressRequest

{
  "firstName": "string",
  "lastName": "string",
  "company": "string",
  "street1": "string",
  "street2": "string",
  "city": "string",
  "region": "string",
  "regionCode": "string",
  "country": "string",
  "countryCode": "string",
  "postalCode": "string",
  "phone": "string",
  "customFields": [
    {
      "fieldId": "string",
      "fieldValue": "string"
    }
  ]
}

Properties

Name Type Required Description
firstName string false No description
lastName string false No description
company string false No description
street1 string false No description
street2 string false No description
city string false No description
region string false Represents state or province.
regionCode string false No description
country string true No description
countryCode string false No description
postalCode string false No description
phone string(E.164) false No description
customFields [any] false No description
fieldId string false No description
fieldValue string false This can also be an array for fields that need to support list of values (e.g., a set of check boxes.)

AddressProperties

{
  "firstName": "string",
  "lastName": "string",
  "company": "string",
  "street1": "string",
  "street2": "string",
  "city": "string",
  "region": "string",
  "regionCode": "string",
  "country": "string",
  "countryCode": "string",
  "postalCode": "string",
  "phone": "string",
  "customFields": [
    {
      "fieldId": "string",
      "fieldValue": "string"
    }
  ]
}

Properties

Name Type Required Description
firstName string false No description
lastName string false No description
company string false No description
street1 string false No description
street2 string false No description
city string false No description
region string false Represents state or province.
regionCode string false No description
country string true No description
countryCode string false No description
postalCode string false No description
phone string(E.164) false No description
customFields [any] false No description
fieldId string false No description
fieldValue string false This can also be an array for fields that need to support list of values (e.g., a set of check boxes.)

CreateConsignmentRequest

[
  {
    "shippingAddress": {
      "firstName": "string",
      "lastName": "string",
      "company": "string",
      "street1": "string",
      "street2": "string",
      "city": "string",
      "region": "string",
      "regionCode": "string",
      "country": "string",
      "countryCode": "string",
      "postalCode": "string",
      "phone": "string",
      "customFields": [
        {
          "fieldId": "string",
          "fieldValue": "string"
        }
      ]
    },
    "lineItems": [
      {
        "itemId": "string",
        "quantity": 0
      }
    ]
  }
]

Properties

Name Type Required Description
shippingAddress AddressRequest false No description
lineItems ConsignmentLineItem false No description

UpdateConsignmentRequest

{
  "shippingAddress": {
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "street1": "string",
    "street2": "string",
    "city": "string",
    "region": "string",
    "regionCode": "string",
    "country": "string",
    "countryCode": "string",
    "postalCode": "string",
    "phone": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "lineItems": [
    {
      "itemId": "string",
      "quantity": 0
    }
  ],
  "shippingOptionId": "string"
}

Properties

Name Type Required Description
shippingAddress AddressRequest false No description
lineItems ConsignmentLineItem false No description
shippingOptionId string false No description

ConsignmentLineItem

{
  "itemId": "string",
  "quantity": 0
}

Properties

Name Type Required Description
itemId string true No description
quantity integer true No description