Liste les transporteurs
Retourne une liste paginée de vos transporteurs, triée par date de création par défaut. Chaque transporteur est référencé depuis une commande via carrier_id. Les paramètres filters, order, limit, offset et fields permettent d'affiner la réponse.
Parameters
Header Parameters
[Authentication] Required API key, in the form {prefix}.{secret}.
"a1b2c3d4.xK9pR2mVn6QwErTyUiOpAsDfGhJkLzXcVbNmQwErTyU""^[a-zA-Z0-9]{8}\\.[A-Za-z0-9_-]+$"Query Parameters
Subset of carrier fields to return. Comma-separated string or repeated query parameter.
"id""carrier_id""shop_id""name""is_active""created_at""updated_at""data_source_id"Maximum number of records to return
10Number of records to skip
0Sorting criteria, array of objects with field and type properties. Use lowercase asc / desc for type.
Two encodings are accepted in the query string:
- JSON, one parameter per criterion:
?order={"field":"created_at","type":"desc"} - Bracket notation:
?order[0][field]=created_at&order[0][type]=desc
{
"field": "created_at",
"type": "desc"
}Filter criteria, array of objects with field, operator and values properties. All filters are combined with AND logic (see orFilters for OR logic).
Two encodings are accepted in the query string:
- JSON, one parameter per filter:
?filters={"field":"amount","operator":"GREATER_THAN","values":100}&filters={"field":"id_customer","operator":"EQUALS","values":42} - Bracket notation:
?filters[0][field]=amount&filters[0][operator]=GREATER_THAN&filters[0][values]=100
values accepts a single value, an array, or a comma-separated string (useful for IN, NOT_IN, BETWEEN, NOT_BETWEEN). value (singular) is also accepted for single-value operators.
Available operators: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH, LESS_THAN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, IN, NOT_IN, LIKE, BETWEEN, NOT_BETWEEN
{
"field": "status",
"operator": "EQUALS",
"values": "active"
}Same shape, operators and encodings as filters, but the criteria are combined with OR logic between them. When both are provided, the resulting condition is: (filters AND ...) AND (orFilters OR ...).
{
"field": "status",
"operator": "EQUALS",
"values": "active"
}{
"field": "status",
"operator": "EQUALS",
"values": "pending"
}Responses
Paginated listing response.
Liste les transporteurs Retourne une liste paginée de vos transporteurs, triée par date de création par défaut. Chaque transporteur est référencé depuis une commande via carrier_id. Les paramètres filters, order, limit, offset et fields permettent d'affiner la réponse. GET /v1/orders-carriers listOrdersCarriers Orders carriers spm-api-key [Authentication] Required API key, in the form {prefix}.{secret}. fields Subset of carrier fields to return. Comma-separated string or repeated query parameter. limit Maximum number of records to return offset Number of records to skip order Sorting criteria, array of objects with field and type properties. Use lowercase asc / desc for type. Two encodings are accepted in the query string: - JSON, one parameter per criterion: ?order={"field":"created_at","type":"desc"} - Bracket notation: ?order[0][field]=created_at&order[0][type]=desc filters Filter criteria, array of objects with field, operator and values properties. All filters are combined with AND logic (see orFilters for OR logic). Two encodings are accepted in the query string: - JSON, one parameter per filter: ?filters={"field":"amount","operator":"GREATER_THAN","values":100}&filters={"field":"id_customer","operator":"EQUALS","values":42} - Bracket notation: ?filters[0][field]=amount&filters[0][operator]=GREATER_THAN&filters[0][values]=100 values accepts a single value, an array, or a comma-separated string (useful for IN, NOT_IN, BETWEEN, NOT_BETWEEN). value (singular) is also accepted for single-value operators. Available operators: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH, LESS_THAN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, IN, NOT_IN, LIKE, BETWEEN, NOT_BETWEEN orFilters Same shape, operators and encodings as filters, but the criteria are combined with OR logic between them. When both are provided, the resulting condition is: (filters AND ...) AND (orFilters OR ...). Paginated listing response. Client error - Invalid request or authentication issues Server error - Internal processing failure