j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Create a shipment for a basket.
Operation ID: createShipmentForBasketCreates a new shipment for a basket.
The created shipment is initialized with values provided in the body document and can be updated with further data API calls. Considered from the body are the following properties if specified:
- the ID
- the shipping address
- the shipping method
- gift boolean flag
- gift message
- custom properties
curl "https://{shortCode}.api.commercecloud.salesforce.com/checkout/shopper-baskets/v1/organizations/{organizationId}/baskets/{basketId}/shipments?siteId=RefArch" \
-X POST \
-H "content-type: application/json" \
-d '{
"shipmentId": "me2",
"shippingMethod": {
"id": "001"
},
"shippingAddress": {
"firstName": "Stephanie",
"lastName": "Miller",
"address1": "385 Prospect Valley Road",
"city": "Woburn",
"postalCode": "01801",
"stateCode": "MA",
"countryCode": "US"
}
}'An identifier for the organization the request is being made by
f_ecom_zzxy_prd
The ID of the basket to be modified.
The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites
RefArch
A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter Accept-Language following RFC 2616 & RFC 1766. This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
en-US
{
"shipmentId": "me2",
"shippingMethod": {
"id": "001"
},
"shippingAddress": {
"firstName": "Stephanie",
"lastName": "Miller",
"address1": "385 Prospect Valley Road",
"city": "Woburn",
"postalCode": "01801",
"stateCode": "MA",
"countryCode": "US"
}
}
The total tax on products in the shipment, including item-level price adjustments but not including service charges such as shipping. If the Discount Taxation preference is set to Tax Products and Shipping Only Based on Adjusted Price, this amount also includes prorated order-level price adjustments. It is read only.
4.95
The total tax on shipping charges in the shipment, including shipping price adjustments. It is read only.
0.3
A flag indicating whether the shipment is a gift. It is read only.
true
The gift message.
Happy Birthday
The total tax on products in the shipment, not including price adjustments or service charges such as shipping. It is read only.
4.95
The total price of all products in the shipment, including item-level adjustments, but not including order-level adjustments or shipping charges. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
99
The total price of all products in the shipment including item-level adjustments and prorated order-level adjustments, but not including shipping charges. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
99
The order-specific ID of the shipment. The default value is 'me'.
The shipment number of this shipment. This number is automatically generated. It is read only.
The total price of all products in the shipment including item-level adjustments, shipping charges, and tax. It is read only.
39.99
The shipping address.
Document representing a shipping method.
{
"id": "003"
}
The shipping status of the shipment.
- not_shipped
- shipped
shipped
The total price of all shipping charges in the shipment, including shipping adjustments. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
5.99
The total tax on shipping charges in the shipment, not including shipping price adjustments. It is read only.
0.3
The total tax on the shipment, including item-level price adjustments and service charges such as shipping. If the Discount Taxation preference is set to Tax Products and Shipping Only Based on Adjusted Price, this amount also includes prorated order-level price adjustments. It is read only.
1.8
The tracking number of the shipment.
1Z204E380338943508
This type supports additional properties passed along with the defined properties of this API.
To indicate that the properties were defined and expected to be handled as additional properties, they are expected to be prefixed with a c_.
The type will reject any property that does not fit this pattern, only allowing additional properties beginning with the known prefix.
Success, the response body contains the basket with added shipment.
{
"adjustedMerchandizeTotalTax": 30,
"adjustedShippingTotalTax": 0.8,
"agentBasket": false,
"basketId": "a10ff320829cb0eef93ca5310a",
"billingAddress": {
"address1": "104 Presidential Way",
"city": "Woburn",
"countryCode": "US",
"firstName": "Stephanie",
"fullName": "Stephanie Miller",
"id": "bfea663fd3de75d5be3ec02702",
"lastName": "Miller",
"postalCode": "01801",
"stateCode": "MA"
},
"channelType": "storefront",
"couponItems": [
{
"code": "5ties",
"couponItemId": "cc6ef43f207bf64099288aec36",
"statusCode": "no_applicable_promotion",
"valid": true
}
],
"creationDate": "2019-10-17T08:29:55.340Z",
"currency": "USD",
"customerInfo": {
"customerId": "beQeANXJNsd0xcINsB6cSrobQa",
"email": "shopper@salesforce-test.com"
},
"lastModified": "2019-10-17T08:29:55.698Z",
"merchandizeTotalTax": 30,
"orderTotal": 646.76,
"paymentInstruments": [
{
"amount": 0,
"paymentCard": {
"cardType": "Visa",
"creditCardExpired": false
},
"paymentInstrumentId": "b7679bea661819b2de78b9de7d",
"paymentMethodId": "CREDIT_CARD"
}
],
"productItems": [
{
"adjustedTax": 30,
"basePrice": 199.99,
"bonusProductLineItem": false,
"gift": false,
"itemId": "3d4e28425ce0b3a65b0ac4e163",
"itemText": "Green Umbrella - Sustained Edition",
"optionItems": [
{
"adjustedTax": 0,
"basePrice": 0,
"bonusProductLineItem": false,
"gift": false,
"itemId": "ff9452ed11fcf5c80f9143a8f1",
"itemText": "We will plant a tree for your order.",
"optionId": "plantATree",
"optionValueId": "000",
"price": 0,
"priceAfterItemDiscount": 0,
"priceAfterOrderDiscount": 0,
"productId": "000",
"productName": "Plant a tree.",
"quantity": 3,
"shipmentId": "me",
"tax": 0,
"taxBasis": 0,
"taxClassId": "standard",
"taxRate": 0.05
}
],
"price": 599.97,
"priceAfterItemDiscount": 599.97,
"priceAfterOrderDiscount": 599.97,
"productId": "green-umbrella",
"productName": "Green Umbrella - Sustained Edition",
"quantity": 3,
"shipmentId": "me",
"tax": 30,
"taxBasis": 599.97,
"taxClassId": "standard",
"taxRate": 0.05
}
],
"productSubTotal": 599.97,
"productTotal": 599.97,
"shipments": [
{
"adjustedMerchandizeTotalTax": 30,
"adjustedShippingTotalTax": 0.8,
"gift": false,
"merchandizeTotalTax": 30,
"productSubTotal": 599.97,
"productTotal": 599.97,
"shipmentId": "me",
"shipmentTotal": 646.76,
"shippingAddress": {
"address1": "4911 Lincoln Street",
"city": "IDANHA",
"countryCode": "US",
"firstName": "Ward J",
"fullName": "Ward J Adamek",
"id": "b3e1269a2c1d0ad56694206741",
"lastName": "Adamek"
},
"shippingMethod": {
"description": "Order received in 2 business days",
"id": "002",
"name": "2-Day Express",
"price": 20.99
},
"shippingStatus": "not_shipped",
"shippingTotal": 20.99,
"shippingTotalTax": 1.05,
"taxTotal": 36.05
},
{
"adjustedMerchandizeTotalTax": 35,
"adjustedShippingTotalTax": 0.8,
"gift": false,
"merchandizeTotalTax": 35,
"productSubTotal": 599.97,
"productTotal": 599.97,
"shipmentId": "me2",
"shipmentTotal": 646.76,
"shippingAddress": {
"address1": "385 Prospect Valley Road",
"city": "Woburn",
"stateCode": "MA",
"countryCode": "US",
"firstName": "Stephanie",
"fullName": "Stephanie Miller",
"id": "84f06786daa68ae33af7e21ec6",
"lastName": "Miller"
},
"shippingMethod": {
"description": "Order received in 2 business days",
"id": "001",
"name": "2-Day Express",
"price": 15.99
},
"shippingStatus": "not_shipped",
"shippingTotal": 15.99,
"shippingTotalTax": 0.8,
"taxTotal": 35
}
],
"shippingItems": [
{
"adjustedTax": 1.05,
"basePrice": 20.99,
"itemId": "d5ed0e58b8f8b5efe8d617a630",
"itemText": "Shipping",
"price": 20.99,
"priceAfterItemDiscount": 20.99,
"shipmentId": "me",
"tax": 1.05,
"taxBasis": 20.99,
"taxClassId": "standard",
"taxRate": 0.05
},
{
"adjustedTax": 0.8,
"basePrice": 15.99,
"itemId": "6fea9966277c94e06b482a5c43",
"itemText": "Shipping",
"price": 15.99,
"priceAfterItemDiscount": 15.99,
"shipmentId": "me",
"tax": 0.8,
"taxBasis": 15.99,
"taxClassId": "standard",
"taxRate": 0.05
}
],
"shippingTotal": 36.98,
"shippingTotalTax": 1.35,
"taxation": "net",
"taxTotal": 36.35
}
The total tax on products in the shipment, including item-level price adjustments but not including service charges such as shipping. If the Discount Taxation preference is set to Tax Products and Shipping Only Based on Adjusted Price, this amount also includes prorated order-level price adjustments. It is read only.
4.95
The total tax on shipping charges in the shipment, including shipping price adjustments. It is read only.
0.3
Is the basket created by an agent? It is read only.
true
The unique identifier for the basket. It is read only.
e78aa5646a8efebdd9cdd38be7
The billing address.
The bonus discount line items.
The sales channel. It is read only.
- storefront
- callcenter
- marketplace
- dss
- store
- facebookads
- subscriptions
- onlinereservation
- customerservicecenter
- instagramcommerce
- tiktok
- snapchat
- youtube
storefront
The coupon items.
[{
"code": "10_percent_off"
}]
The timestamp when the basket was created. It is read only.
2015-05-19T15:23:18.000Z
A three letter uppercase currency code conforming to the ISO 4217 standard, or the string N/A indicating that a currency is not applicable.
USD
The customer information, if the customer is logged in.
The gift certificate line items.
[{
"amount": 1,
"recipientEmail": "miller@salesforce-test.com",
"shipmentId": "me"
}]
The expiration datetime of the inventory reservation. It is read only.
2015-05-19T15:30:18.000Z
The timestamp when the basket was last modified. It is read only.
2015-05-19T15:25:18.000Z
The total products tax in the purchase currency. Merchandise total price represents the sum of the product prices before services (such as shipping) or adjustments from promotions have been added. It is read only.
4.95
The order-level price adjustments.
[{
"appliedDiscount": {
"amount": 15,
"type": "amount"
},
"itemText": "AgentOrderAdjustment",
"reasonCode": "override manual promo"
}]
The total price, including products, shipping and tax. It is read only.
110.24
The payment instruments list.
[{
"amount": 0,
"paymentCard": {
"holder": "Miller",
"cardType": "Visa"
},
"paymentMethodId": "CREDIT_CARD"
}]
The product items.
[{
"quantity": 1
}]
The total price of all products including item-level adjustments, but not including order-level adjustments or shipping charges. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
99
The total price of all products including adjustments, but not including shipping charges. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
88
The shipments.
[{
"shipmentId": "me2",
"shippingMethod": {
"id": "001"
},
"shippingAddress": {
"firstName": "Stephanie",
"lastName": "Miller",
"address1": "385 Prospect Valley Road",
"city": "Woburn",
"postalCode": "01801",
"stateCode": "MA",
"countryCode": "US"
}
}]
The shipping items.
The total price of all shipping charges, including shipping adjustments. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
5.99
The total tax on all shipping charges, not including shipping adjustments. It is read only.
0.3
The source code assigned to the basket. It is read only.
OUTDOOR1
The total tax amount. It is read only.
5.25
The taxation policy (gross or net). It is read only.
- gross
- net
net
This type supports additional properties passed along with the defined properties of this API.
To indicate that the properties were defined and expected to be handled as additional properties, they are expected to be prefixed with a c_.
The type will reject any property that does not fit this pattern, only allowing additional properties beginning with the known prefix.