Shipments
A shipment lists the shipments created by a purchase.
Read Shipments For Purchase
Retrieve the shipments associated with a purchase.
Workflow
- Start with purchase
GETthe link with rel: shipmentsGETthe link with rel: element- Render the response
Response Fields
Type: shipments.shipment
| Name | Description | Type |
|---|---|---|
status | Indicates the status of the shipment. | object |
code | The status code. | string |
Read Shipment Line Items
Retrieve the shipment line items associated with a shipment.
Workflow
- Start with shipment
GETthe link with rel: lineitems- Render the response
Read Shipment Line Item
Read a shipment line item.
Workflow
- Start with shipment-line-items
GETthe link with rel: element- Render the response
Response Fields
Type: shipments.line-item
| Name | Description | Type |
|---|---|---|
name | The name. | string |
quantity | The quantity. | integer |
Read Shipment Line Item Options
Retrieve the options associated with a shipment line item.
Workflow
- Start with shipment-line-item
GETthe link with rel: options- Render the response
Read Shipment Line Item Option
Read a shipment line item option.
Workflow
- Start with shipment-line-item-options
GETthe link with rel: element- Render the response
Response Fields
Type: shipments.option
| Name | Description | Type |
|---|---|---|
name | The name. | string |
display-name | The display name. | string |
Read Shipment Line Item Option Value
Retrieve the option value associated with a shipment line item.
Workflow
- Start with shipment-line-item-option
GETthe link with rel: value- Render the response
Response Fields
Type: shipments.value
| Name | Description | Type |
|---|---|---|
name | The name. | string |
display-name | The display name. | string |
Read Shipping Address For Shipment
Retrieve the shipment address associated with a shipment.
Workflow
- Start with shipment
GETthe link with rel: destination- Render the response
Response Fields
Type: addresses.address
| Name | Description | Type |
|---|---|---|
name | The customer name. | object |
given-name | The person’s given name. | string |
family-name | The person’s family name. | string |
address | The customer address. Address field names are based on the v.card specification. For more information on this specification, see v.card. | object |
street-address | The street address. | string |
extended-address | Extra field for address information. This field is optional. | string |
locality | The city name. | string |
region | The region name. A region typically corresponds to a province or a state of a country. | string |
postal-code | Postal code or zip code. | string |
country-name | The country name. | string |
phone-number | Phone number | string |
organization | The organization | string |
Read Shipping Option For Shipment
Retrieve the shipment options associated with a shipment.
Workflow
- Start with shipment
GETthe link with rel: shippingoption- Render the response
Response Fields
Type: shipmentdetails.shipping-option
| Name | Description | Type |
|---|---|---|
name | Name of the shipping option. | string |
display-name | The localized name of the carrier, intended for display in the client application. | string |
carrier | Name of the carrier. | string |
cost | The shipping costs for shipping the item(s) to the selected shipping address. | array |
currency | The currency the cost is in. | string |
amount | The decimal value of the cost. | decimal |
display | Formatted currency string that can be displayed on the client application. | string |