List grouped methods

Lists the shipping methods grouped by type for the given items/weight.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Country code of the address where the package is being sent.

string

Province code of the address where the package is being sent. May be empty when the order address has no province code; country-wide methods are then listed regardless of it.

string
enum

Locale used to resolve localized carrier resources such as the DropOff parcel-locator URL (shopUrl). Defaults to "es" when omitted.

Allowed:
string

The customer's local calendar day, as YYYY-MM-DD. The pickup days of the PickUp methods (pickUpDates) are counted from it, so a customer whose day differs from the server's UTC day (west of UTC in the evening, east of it after midnight) is offered the days they expect. Defaults to the server's UTC day; ignored when more than one day away from it.

boolean

Indicates if the operation includes a change (exchange). Default: false.

boolean

Indicates if the operation includes a return. Default: true.

itemIds
array of strings

Selected purchase item identifiers in circular mode or repair item identifiers in repair mode. Reasons are resolved from the saved items.

itemIds
orders
array of objects

Selected order line item identifiers and their reason identifiers for price rule evaluation.

orders
categories
array of objects

Selected category identifiers and their reason identifiers for price rule evaluation.

categories
products
array of objects

Selected product identifiers and their reason identifiers for price rule evaluation.

products
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json