OrderItem
| Parameter | Type | Description |
|---|---|---|
| id | integer | Our unique item identifier. |
| sku | string | Your item stock keeping unit. |
| title | string | Your product title. |
| quantity | integer | Quantity of item on order. |
| item_amount | float | Price per item unit sold. |
| shipping_amount | float | Shipping fee for all units of the item. |
| item_weight | float | Weight per item unit. |
| item_weight_unit | string | Unique weight units. Permitted values: 'mg’, 'kg’ 'kg’, 'oz’, 'lb’. |
Address
| Parameter | Type | Description |
|---|---|---|
| name | string | Name associated with the address. In the context of a shipping address, this would be the recipient’s name; the billing name in the context of a billing address REQUIRED |
| line_1 | string | Line 1 of the address OPTIONAL |
| line_2 | string | Line 2 of the address OPTIONAL |
| line_3 | string | Line 3 of the address OPTIONAL |
| city | string | City or town of the address OPTIONAL |
| county | string | Country of the address OPTIONAL |
| district | string | Address district OPTIONAL |
| state | string | State of the address OPTIONAL |
| postcode | string | Address post code OPTIONAL |
| country | string | Country of the address OPTIONAL |
Channel
| Parameter | Type | Description |
|---|---|---|
| id | integer | Our unique channel identifier |
| name | string | Full channel name |
| type | string | Our channel type. |
| country | string | ISO country codes. |
| currency | string | ISO currency codes. |
User
| Parameter | Type | Description |
|---|---|---|
| id | integer | Our unique user identifier |
| name | string | User’s full-name |
| string | User’s e-mail address | |
| active | boolean | Indicates whether the user is active on the client |
| username | string | Unique username identifier |