Sign in

v1

latestOpenAPI 3.0.12026-08-0688138402.2 KB
Carriers, products & services

List all products

Returns a list of shipping products and services.

Only products available for the user are returned.

The codes of the products and services are required when creating a shipment.

get/products

Query parameters

idinteger

ID for the product to be included in the filter.

product_codestring
Example:GLSDK_SD

Code for the product to be included in the filter.

sender_country_codestring
Example:DK

Country code (ISO Alpha-2) of the sender country to be included in the filter.

receiver_country_codestring
Example:DK

Country code (ISO Alpha-2) of the receiver country to be included in the filter.

carrier_codestring
Example:gls

Carrier code to be included in the filter.

per_pageinteger

For pagination. Defines how many entries are returned per page.

pageinteger

For pagination. Defines which page the results are fetched from.

Response

Successful.

codestring

Product code used when referring to the specific product.

idinteger

ID of the product. Only used in older version of the Shipmondo API.

namestring

Name of the product.

availableboolean

Is the product available to book on either own agreements or Shipmondo's agreement?

own_agreement_availableboolean

Is the product available to book on own agreements?

customs_declaration_requiredboolean

Does the product require customs information to book?

service_point_availableboolean

Can the product be booked with a service point?

service_point_requiredboolean

Is service point required to book this product?

expected_transit_timestring

The expected transit time of the product.

sender_country_codestring

ISO 3166-1 alpha-2 country code that the product is sent from.

receiver_country_codestring

ISO 3166-1 alpha-2 country code that the product is sent to.

required_fieldsstring

Comma-separated string indicating fields that are required to book a shipment with the product.

optional_fieldsstring

Comma-separated string indicating fields that are optional to book a shipment with the product.

required_parcel_fieldsstring

Comma-separated string indicating fields that are required (for the objects in the "parcels" array) when booking a shipment with the product.

optional_parcel_fieldsstring

Comma-separated string indicating fields that are optional (for the objects in the "parcels" array) when booking a shipment with the product.

allowed_incotermsstring[]

Array of allowed Incoterms for the specific product. If empty all Incoterms are allowed.

Example response

[
  {
    "code": "GLSDK_SD",
    "id": 19,
    "name": "Shop Delivery",
    "available_customer_numbers": [
      {
        "customer_number": "898B91"
      }
    ],
    "expected_transit_time": "1-2 days",
    "sender_country_code": "DK",
    "receiver_country_code": "DK",
    "required_fields": "receiver_mobile,service_point_id",
    "optional_fields": "delivery_instruction,pickup_date",
    "required_parcel_fields": "quantity,weight",
    "optional_parcel_fields": "height,length,width",
    "carrier": {
      "id": 7,
      "code": "gls",
      "name": "GLS Denmark"
    },
    "destination_country": {
      "code": "DK",
      "name": "Denmark"
    },
    "available_services": [
      {
        "code": "EMAIL_NT",
        "id": 21,
        "name": "Email notification",
        "required_fields": "receiver_email",
        "optional_fields": "delivery_instruction"
      }
    ],
    "required_services": [
      {
        "code": "EMAIL_NT",
        "id": 21,
        "name": "Email notification",
        "required_fields": "receiver_email",
        "optional_fields": "delivery_instruction",
        "note": "Email notification is required"
      }
    ],
    "weight_intervals": [
      {
        "to_weight": 1000,
        "description": "0-1kg"
      }
    ],
    "ta_weight_intervals": [
      {
        "to_weight": 1000,
        "description": "0-1kg"
      }
    ]
  }
]