Shipmentdetails
The shipmentdetails resource defines how and where the physical goods you’re purchasing are shipped. The where you’re shipping
is the shipping address, while the how are the shipping options (i.e. Canada Post, FedEx, etc) available for your store.
Read Order Destination Info
Retrieves the order’s destinationinfo, which contains links to:
- A selector for choosing the order’s shipping address: Select Shipping Address
- The shipping address currently selected for the order: Read Order Shipping Address
- The delivery the destinationinfo belongs to: Read Order Delivery
Workflow
- Start with delivery
GETthe link with rel: destinationinfo- Render the response
Response Fields
Type: controls.info
| Name | Description | Type |
|---|---|---|
name | The info object’s name. | string |
Read Order Shipping Address
Retrieve the shipping address that is currently selected for the order.
Workflow
- Start with destination-info
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 |
Select Shipping Address
Uses a Selector to select a shipping address to use for the order.
Workflow
- Start with destination-info
GETthe link with rel: selectorGETthe link with rel: choiceGETthe link with rel: chosenGETthe link with rel: descriptionPOSTthe choice using the link with rel: selectaction
Read Order Shipping Address Form
Retrieve the address form to create a new shipping address for the order.
Workflow
- Start with destination-info
GETthe link with rel: addressform- 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 |
Add Shipping Address From Delivery
Create a shipping address from the delivery.
Workflow
- Start with delivery
GETthe link with rel: destinationinfoGETthe link with rel: addressform- Fill out the form
POSTthe form using the link with rel: createaddressaction
Request 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 Order Shipping Option Info
Retrieves the order’s shippingoptioninfo, which contains links to:
- A selector for choosing the order’s shipping option: Select Shipping Choice
- The shipping option selected for the order: Read Order Shipping Option
- The delivery the shipping option belongs to: Read Order Delivery
Workflow
- Start with delivery
GETthe link with rel: shippingoptioninfo- Render the response
Response Fields
Type: controls.info
| Name | Description | Type |
|---|---|---|
name | The info object’s name. | string |
Read Order Shipping Option
Retrieves the shipping option that is currently selected for the order. The shipping option is how the order will be shipped, i.e. (FedEx, Canada Post, etc). If a shipping option has not been selected for the order, the shipping option link will not appear on the shippingoptioninfo. For information on how to select the shippingoption, see Select Shipping Choice
Workflow
- Start with shipping-option-info
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 |
Select Shipping Option
Uses a Selector to choose the shipping option for the order. The shipping option is how the order will be shipped, i.e. (FedEx, Canada Post, etc). The shipping options available for your shipment depend on which shipping regions and shipping options are configured for your store. Check with your store’s administrator for more information on these options.
Workflow
- Start with shipping-option-info
GETthe link with rel: selectorGETthe link with rel: choiceGETthe link with rel: chosenGETthe link with rel: descriptionPOSTthe choice using the link with rel: selectaction
Read Destination Needinfo From Order
Read the needinfo link for the shipping address. If this link appears on the order, it means the shipping address has not been selected or created for the order. Needinfo links can appear on the order, the purchase form, and the delivery.
Workflow
- Start with order
GETthe link with rel: needinfo- Render the response
Response Fields
Type: controls.info
| Name | Description | Type |
|---|---|---|
name | The info object’s name. | string |
Read Destination Needinfo From Delivery
Read the needinfo link for the shipping address from the delivery. Needinfo links can appear on the order, the purchase form, and the delivery.
Workflow
- Start with delivery
GETthe link with rel: needinfo- Render the response
Response Fields
Type: controls.info
| Name | Description | Type |
|---|---|---|
name | The info object’s name. | string |
Read Destination Needinfo From Purchaseform
Read the needinfo link for the shipping address from the purchase form. Needinfo links can appear on the order, the purchase form, and the delivery.
Workflow
- Start with create-purchase-form
GETthe link with rel: needinfo- Render the response
Response Fields
Type: controls.info
| Name | Description | Type |
|---|---|---|
name | The info object’s name. | string |
Read Shippingoption Needinfo From Order
Read the needinfo for the shipping option from the order. This needinfo appears when a shipping option has not been selected for the order. Needinfo links can appear on the order, the purchase form, and the delivery.
Workflow
- Start with order
GETthe link with rel: needinfo- Render the response
Response Fields
Type: controls.info
| Name | Description | Type |
|---|---|---|
name | The info object’s name. | string |
Read Shippingoption Needinfo From Delivery
Read the needinfo for the shipping option from the order. This needinfo appears when a shipping option has not been selected for the order. Needinfo links can appear on the order, the purchase form, and the delivery.
Workflow
- Start with delivery
GETthe link with rel: needinfo- Render the response
Response Fields
Type: controls.info
| Name | Description | Type |
|---|---|---|
name | The info object’s name. | string |
Read Shippingoption Needinfo From Purchaseform
Read the needinfo for the shipping option from the purchaseform. This needinfo appears when a shipping option has not been selected for the order. Needinfo links can appear on the order, the purchase form, and the delivery.
Workflow
- Start with create-purchase-form
GETthe link with rel: needinfo- Render the response
Response Fields
Type: controls.info
| Name | Description | Type |
|---|---|---|
name | The info object’s name. | string |