List Shipping Options for Cart
Retrieve a list of shipping options for a cart. The cart's ID is set in the required `cart_id` query parameter. The shipping options also be sorted or paginated.
Query Parameters
Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.
The number of items to skip when retrieving a list.
Limit the number of items returned in the list.
The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.
The ID of the cart to retrieve its shipping options.
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Whether the shipping option can be used for returns.
Header Parameters
Publishable API Key created in the Medusa Admin.
Response Body
application/json
application/json
text/plain
application/json
application/json
application/json
application/json
curl -X GET "https://{tenant}.api.myxclade.com/store/shipping-options?cart_id=string" \ -H "x-publishable-api-key: string"{
"shipping_options": [
{
"id": "string",
"name": "string",
"price_type": "flat",
"service_zone_id": "string",
"provider_id": "string",
"provider": {
"id": "string",
"is_enabled": true
},
"type": {
"id": "string",
"label": "string",
"description": "string",
"code": "string"
},
"shipping_profile_id": "string",
"amount": 0,
"data": {},
"prices": [
{
"id": "string",
"currency_code": "usd",
"amount": 0,
"min_quantity": 0,
"max_quantity": 0,
"price_rules": [
{
"id": "string",
"attribute": "string",
"operator": "gt",
"value": "string"
}
]
}
],
"calculated_price": {
"id": "string",
"is_calculated_price_price_list": true,
"is_calculated_price_tax_inclusive": true,
"calculated_amount": 0,
"calculated_amount_with_tax": 0,
"calculated_amount_without_tax": 0,
"is_original_price_price_list": true,
"is_original_price_tax_inclusive": true,
"original_amount": 0,
"currency_code": "string",
"calculated_price": {
"id": "string",
"price_list_id": "string",
"price_list_type": "string",
"min_quantity": 0,
"max_quantity": 0
},
"original_price": {
"id": "string",
"price_list_id": "string",
"price_list_type": "string",
"min_quantity": 0,
"max_quantity": 0
},
"original_amount_with_tax": 0,
"original_amount_without_tax": 0
},
"insufficient_inventory": true,
"service_zone": {
"id": "string",
"fulfillment_set_id": "string",
"fulfillment_set": {
"id": "string",
"type": "string",
"location": {
"id": "string",
"address": {
"id": "string",
"company": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"country_code": "us",
"province": "string",
"postal_code": "string",
"phone": "string",
"metadata": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
}
}
}
}
]
}{
"message": "Discount must be set to dynamic",
"type": "not_allowed"
}"Unauthorized"{
"message": "Entity with id 1 was not found",
"type": "not_found"
}{
"code": "unknown_error",
"message": "The request conflicted with another request. You may retry the request with the provided Idempotency-Key.",
"type": "QueryRunnerAlreadyReleasedError"
}{
"code": "invalid_request_error",
"message": "Discount with code TEST already exists.",
"type": "duplicate_error"
}{
"code": "api_error",
"message": "An error occured while hashing password",
"type": "database_error"
}