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
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
subTotal | object | true | none | The 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. |
➥ currency | string | true | none | The three letter currency code as defined in ISO 4217. |
➥ value | integer(int64) | true | none | Monetary value as an integral number of the currency fractional unit e.g for USD: cents |
totalDiscounts | object | true | none | The total price of discounts applied to this Order. The value must be greater than or equal to 0. |
➥ currency | string | true | none | The three letter currency code as defined in ISO 4217. |
➥ value | integer(int64) | true | none | Monetary value as an integral number of the currency fractional unit e.g for USD: cents |
totalPrice | object | true | none | The 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. |
➥ currency | string | true | none | The three letter currency code as defined in ISO 4217. |
➥ value | integer(int64) | true | none | Monetary value as an integral number of the currency fractional unit e.g for USD: cents |
totalShipping | object | true | none | The total shipping costs for this Order. The value must be greater than or equal to 0. |
➥ currency | string | true | none | The three letter currency code as defined in ISO 4217. |
➥ value | integer(int64) | true | none | Monetary value as an integral number of the currency fractional unit e.g for USD: cents |
totalTax | object | true | none | The 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. |
➥ currency | string | true | none | The three letter currency code as defined in ISO 4217. |
➥ value | integer(int64) | true | none | Monetary value as an integral number of the currency fractional unit e.g for USD: cents |
discountCode | string | false | none | Discount code applied to this Order. |
items | [object] | false | none | The list of items to be purchased in this Order. |
➥ Order Item | object | false | none | An item that the Buyer wants to purchase with a Bread product. |
➥➥ name | string | true | none | The name of the item to be purchased. |
➥➥ category | string | false | none | The category of the product under which the item is listed. |
➥➥ quantity | integer | true | none | The number of items to be purchased. The value must be greater than 0. |
➥➥ unitPrice | object | true | none | The price per unit of item. The value must be greater than or equal to 0. |
➥➥➥ currency | string | true | none | The three letter currency code as defined in ISO 4217. |
➥➥➥ value | integer(int64) | true | none | Monetary value as an integral number of the currency fractional unit e.g for USD: cents |
➥➥ unitTax | object | true | none | The tax per unit of item. The value must be greater than or equal to 0. |
➥➥➥ currency | string | true | none | The three letter currency code as defined in ISO 4217. |
➥➥➥ value | integer(int64) | true | none | Monetary value as an integral number of the currency fractional unit e.g for USD: cents |
➥➥ sku | string | false | none | The unique SKU number of the item. |
➥➥ itemUrl | string | false | none | The URL for referencing further details about the item. |
➥➥ imageUrl | string | false | none | The URL for the item image. |
➥➥ description | string | false | none | A longer descrption of the item. |
➥➥ shippingCost | object | true | none | The cost of shipping all units of this item. The value must be greater than or equal to 0. |
➥➥➥ currency | string | true | none | The three letter currency code as defined in ISO 4217. |
➥➥➥ value | integer(int64) | true | none | Monetary value as an integral number of the currency fractional unit e.g for USD: cents |
➥➥ shippingProvider | string | false | none | The provider that will be used to ship the item. |
➥➥ shippingDescription | string | false | none | The description of the shipping method (e.g. standard, express). |
➥➥ shippingTrackingNumber | string | false | none | The tracking number that is provided by a shipping provider. |
➥➥ shippingTrackingUrl | string | false | none | The URL for referencing futher details about the shipping. |