Shipments

A shipment lists the shipments created by a purchase.

Read Shipments For Purchase

Retrieve the shipments associated with a purchase.

Workflow

1. Start with purchase
2. GET the link with rel: shipments
3. GET the link with rel: element
4. 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

1. Start with shipment
2. GET the link with rel: lineitems
3. Render the response

Read Shipment Line Item

Read a shipment line item.

Workflow

1. Start with shipment-line-items
2. GET the link with rel: element
3. 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

1. Start with shipment-line-item
2. GET the link with rel: options
3. Render the response

Read Shipment Line Item Option

Read a shipment line item option.

Workflow

1. Start with shipment-line-item-options
2. GET the link with rel: element
3. 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

1. Start with shipment-line-item-option
2. GET the link with rel: value
3. 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

1. Start with shipment
2. GET the link with rel: destination
3. 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	Street address line 1.	string
street-address-2	Street address line 2. This field is optional.	string
street-address-3	Street address line 3. 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

1. Start with shipment
2. GET the link with rel: shippingoption
3. 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