Order


The collection of items that the Buyer wants to purchase with a Bread product.

{
  "subTotal": {
    "currency": "USD",
    "value": 50000
  },
  "totalDiscounts": {
    "currency": "USD",
    "value": 50000
  },
  "totalPrice": {
    "currency": "USD",
    "value": 50000
  },
  "totalShipping": {
    "currency": "USD",
    "value": 50000
  },
  "totalTax": {
    "currency": "USD",
    "value": 50000
  },
  "discountCode": "string",
  "items": [
    {
      "name": "Noise Cancelling Headphones Q30",
      "category": "Headphones",
      "quantity": 2,
      "unitPrice": {
        "currency": "USD",
        "value": 50000
      },
      "unitTax": {
        "currency": "USD",
        "value": 50000
      },
      "sku": "string",
      "itemUrl": "string",
      "imageUrl": "string",
      "description": "string",
      "shippingCost": {
        "currency": "USD",
        "value": 50000
      },
      "shippingProvider": "string",
      "shippingDescription": "string",
      "shippingTrackingNumber": "string",
      "shippingTrackingUrl": "string"
    }
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
subTotalobjecttruenoneThe total price of items excluding tax. The value must be greater than or equal to 0. If there are items, subTotal must equal the sum of all items'' unitPrice values accounting for quantities.
➥ currencystringtruenoneThe three letter currency code as defined in ISO 4217.
➥ valueinteger(int64)truenoneMonetary value as an integral number of the currency fractional unit e.g for USD: cents
totalDiscountsobjecttruenoneThe total price of discounts applied to this Order. The value must be greater than or equal to 0.
➥ currencystringtruenoneThe three letter currency code as defined in ISO 4217.
➥ valueinteger(int64)truenoneMonetary value as an integral number of the currency fractional unit e.g for USD: cents
totalPriceobjecttruenoneThe total price of the Order. The value must be greater than 0 and equal to the sum of subTotal, totalShipping and totalTax minus the totalDiscounts.
➥ currencystringtruenoneThe three letter currency code as defined in ISO 4217.
➥ valueinteger(int64)truenoneMonetary value as an integral number of the currency fractional unit e.g for USD: cents
totalShippingobjecttruenoneThe total shipping costs for this Order. The value must be greater than or equal to 0.
➥ currencystringtruenoneThe three letter currency code as defined in ISO 4217.
➥ valueinteger(int64)truenoneMonetary value as an integral number of the currency fractional unit e.g for USD: cents
totalTaxobjecttruenoneThe total amount of tax applied to this Order. The value must be greater than or equal to 0. If there are items, totalTax must equal the sum of all items'' unitTax values accounting for quantities.
➥ currencystringtruenoneThe three letter currency code as defined in ISO 4217.
➥ valueinteger(int64)truenoneMonetary value as an integral number of the currency fractional unit e.g for USD: cents
discountCodestringfalsenoneDiscount code applied to this Order.
items[object]falsenoneThe list of items to be purchased in this Order.
➥ Order ItemobjectfalsenoneAn item that the Buyer wants to purchase with a Bread product.
➥➥ namestringtruenoneThe name of the item to be purchased.
➥➥ categorystringfalsenoneThe category of the product under which the item is listed.
➥➥ quantityintegertruenoneThe number of items to be purchased. The value must be greater than 0.
➥➥ unitPriceobjecttruenoneThe price per unit of item. The value must be greater than or equal to 0.
➥➥➥ currencystringtruenoneThe three letter currency code as defined in ISO 4217.
➥➥➥ valueinteger(int64)truenoneMonetary value as an integral number of the currency fractional unit e.g for USD: cents
➥➥ unitTaxobjecttruenoneThe tax per unit of item. The value must be greater than or equal to 0.
➥➥➥ currencystringtruenoneThe three letter currency code as defined in ISO 4217.
➥➥➥ valueinteger(int64)truenoneMonetary value as an integral number of the currency fractional unit e.g for USD: cents
➥➥ skustringfalsenoneThe unique SKU number of the item.
➥➥ itemUrlstringfalsenoneThe URL for referencing further details about the item.
➥➥ imageUrlstringfalsenoneThe URL for the item image.
➥➥ descriptionstringfalsenoneA longer descrption of the item.
➥➥ shippingCostobjecttruenoneThe cost of shipping all units of this item. The value must be greater than or equal to 0.
➥➥➥ currencystringtruenoneThe three letter currency code as defined in ISO 4217.
➥➥➥ valueinteger(int64)truenoneMonetary value as an integral number of the currency fractional unit e.g for USD: cents
➥➥ shippingProviderstringfalsenoneThe provider that will be used to ship the item.
➥➥ shippingDescriptionstringfalsenoneThe description of the shipping method (e.g. standard, express).
➥➥ shippingTrackingNumberstringfalsenoneThe tracking number that is provided by a shipping provider.
➥➥ shippingTrackingUrlstringfalsenoneThe URL for referencing futher details about the shipping.