Shipment

You can enable a mini cart view in the following requests to show changes to the cart immediately. Find out more in the Views for Cart modifying operations

Prerequisites

• access_token from Headless API Authentication

• cartId from Create a Cart

• countryId from from Countries

• shippingMethodId from Shipping Methods

• priceGroupId from the cart or from Price Groups

Add shipping information

Request

curl -D- -X POST <base_url>/api/v1/carts/<cartId>/shipping \
        -H 'Authorization: Bearer <ACCESS_TOKEN>'
        -H 'Content-Type: application/json' \
        -d '{
            "priceGroupId": "<priceGroupId>",
            "shippingMethodId": "<shippingMethodId>",
            "shippingAddress": {
                    "attention":"<attention>",
                    "city": "<city>",
                    "companyName":"<companyName>",
                    "countryId": "<countryId>",
                    "email":"<email>",
                    "firstName": "<firstName>",
                    "lastName": "<lastName>",
                    "line1": "<addressLine1>",
                    "line2": "<addressLine2>",
                    "mobileNumber":"<mobileNumber>",
                    "phoneNumber":"<phoneNumber>",
                    "postalCode": "<postalCode>",
                    "state":"<state>",
                },
            }'

Response

{
"success": "true"
}

Error Handling

Error	Description
BadRequest (400)	Missing or incorrect access token; Bad or missing request data; pipeline execution fails; etc.
Unauthorized (401)	The token is expired.
Forbidden (403)	The token does not have access to this endpoint.
NotFound (404)	Cart not found; Country not found; Price group not found.

Error Response Example

{
"errors":
    [
        {
            "error-description": "Country not found.",
            "error": "NotFound"
        }
    ]
}

Related Articles

Error Handling