Create Shipping
Path:
POST /api-cart/ship-to/cart/{cartID}
Once the digital shopping cart is finalized, the next step is to add the shipping details. Users can go ahead to select the shipping carrier and add the associated shipping details, through this endpoint.
x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox" }
application/json
application/json
Type: path
Name: cartId
Required: true
Type: body
Name: Shipping details
Required: true
Path
https://{baseurl}/api-cart/ship-to/cart/5e99d75cfcef0314e06b64b8
Body:
{"billTo": ["5e99dba9fcef0314e06b64fd"],"address": {"address1":"10400 NE 4th St ","city":"Bellevue","state":"WA","country": "United States","zipCode":"98004","kind":"shipping","name":{"first":"John","last":"Smith"},"email": "[email protected]","phone": {"number": "123-992-9404","kind": "Mobile"}},"shipToType": "SHIP_TO_ADDRESS","shipMethod": {"shipMethodId": 10002,"cost": {"currency": "USD","amount": 10}},"storeId": "store123456789","pickupPerson": {"name": {"first": "John","last": "Smith"},"email": "[email protected]","phone": {"number": "8087769338","kind": "Mobile"}},"altPickupPerson": {"name": {"first": "Jane","last": "Smith"},"email": "[email protected]","phone": {"number": "8087769338","kind": "Mobile"}}}
Response Code: 200
Message: OK
Description: You will see this message when the shipping details are successfully created.
Sample
{"shipMethod": {"cost": {"currency": "USD","amount": 10},"shipMethodId": "10002"},"address": {"phone": {"number": "123-992-9404","kind": "Mobile"},"name": {"first": "John","last": "Smith"},"address1": "10400 NE 4th St ","city": "Bellevue","state": "WA","country": "United States","zipCode": "98004","kind": "shipping","email": "[email protected]"},"pickupPerson": {"name": {"first": "John","last": "Smith"},"phone": {"number": "8087769338","kind": "Mobile"},"email": "[email protected]"},"altPickupPerson": {"name": {"first": "Jane","last": "Smith"},"phone": {"number": "8087769338","kind": "Mobile"},"email": "[email protected]"},"billTo": ["5e99dba9fcef0314e06b64fd"],"_id": "5e99dd58fcef0314e06b64fe","shipToType": "SHIP_TO_ADDRESS","storeId": "store123456789","cartId": "5e99d75cfcef0314e06b64b8","shipToId": 16,"createdAt": "2020-04-17T16:46:16.352Z","updatedAt": "2020-04-17T16:46:16.352Z"}
Last updated - July 2020