A shipment that relates to a Shipping Method thus allowing part shipment.
| Property | Description | Required | Data Type |
|---|---|---|---|
| shipment_id | Unique identifier of the shipment | True | String |
| shipping_method_id | A reference to the Shipping Method object. | True | String |
| carrier_label_base_64 | Base 64 content of an outbound carrier label to be used on the SmartSlip. | False | String |
| return_label_base_64 | Base 64 content of an inbound returns carrier label to be used on the SmartSlip. | False | String |
| title | The salutation of the person product(s) being shipped to. | False | String |
| first_name | The first name of the person product(s) being shipped to. | False | String |
| last_name | The last name of the person product(s) being shipped to. | False | String |
| is_gift | True/False value indicating whether the products in the shipment, is a gift. | False | Bool |
| gift_message | Gift message, used in conjunction with 'is_gift'. | False | String |
| address1 | The street address of the shipping address. | False | String |
| address2 | An optional additional field for the street address of the shipping address. | False | String |
| address3 | An optional additional field for the street address of the shipping address. | False | String |
| address4 | An optional additional field for the street address of the shipping address. | False | String |
| city | The City of the shipping address. | False | String |
| country | The name of the Country of the shipping address. | False | String |
| zip_postalcode | The zip or postal code of the shipping address. | False | String |
| phone | The phone number at the shipping address. | False | String |
| country_code | The two-letter code for the country of the shipping address. | False | String |
| shipment_required_date | The date of when the shipment is required to be delivered. ISO 8601 format required: '2017-10-25T11: 34:26+00:00' | False | String |
| shipment_date | The date of the Shipment delivery. ISO 8601 format required: '2017-10-25T11: 34:26+00:00' | False | String |
| document_type_id | Property to determine document template layout | False | String |
| invoice | Contains financial figures | False | Invoice |
| custom_1 | A Custom Field for additional data. | False | String |
| custom_2 | A Custom Field for additional data. | False | String |
| custom_3 | A Custom Field for additional data. | False | String |
| custom_4 | A Custom Field for additional data. | False | String |
| custom_5 | A Custom Field for additional data. | False | String |
| custom_6 | A Custom Field for additional data. | False | String |
| custom_7 | A Custom Field for additional data. | False | String |
| custom_8 | A Custom Field for additional data. | False | String |
| custom_9 | A Custom Field for additional data. | False | String |
| custom_10 | A Custom Field for additional data. | False | String |
| custom_11 | A Custom Field for additional data. | False | String |
| custom_12 | A Custom Field for additional data. | False | String |
| custom_13 | A Custom Field for additional data. | False | String |
| custom_14 | A Custom Field for additional data. | False | String |
| custom_15 | A Custom Field for additional data. | False | String |
| custom_16 | A Custom Field for additional data. | False | String |
| custom_17 | A Custom Field for additional data. | False | String |
| custom_18 | A Custom Field for additional data. | False | String |
| custom_19 | A Custom Field for additional data. | False | String |
| custom_20 | A Custom Field for additional data. | False | String |