Delivery Options

Skip to content

/Delivery Options

Delivery Options

This API provides a list of available delivery options, along with the service_id, a description of the option and price where applicable

Operations

Get a list of available delivery options at checkout

Request

Security

ApiKeyAuth

Path

company-slugstringrequired

Bodyapplication/json

package_typestring, <= 50 characters

the package type of the shipment

Example:"Parcel"

shipping_methodstring, <= 350 characters

the shipment method of the shipment, mainly used to match certain rules

Example:"My Mapped Rule"

order_numberstring

the order number of the shipment

Example:"Order-123"

warehouse_idstringrequired

the warehouse external identifier

Example:"company-slug|Warehouse Name"

recipientobject(DestinationRequest)required

packagesArray of objects(PackageRequest)

invoiceobject(InvoiceRequest)

optionsobject(Enhancement)

currencystring, <= 5 characters

the ISO code for the currency

Example:"EUR"

order_valuenumber, >= 0

the value of the order

Example:19.99

rules_package_typestring, <= 50 characters

the rules package type, mainly used to match certain rules

Example:"My Mapped Package Type Rule"

shipping_datestring

the shipping date in ISO format, it is required to get estimated delivery data

Example:"2025-07-28"

custom_field_1string

a custom field to store anything

Example:"My Custom Value 1"

custom_field_2string

a custom field to store anything

Example:"My Custom Value 2"

custom_field_3string

a custom field to store anything

Example:"My Custom Value 3"

custom_field_4string

a custom field to store anything

Example:"My Custom Value 4"

custom_field_5string

a custom field to store anything

Example:"My Custom Value 5"

settingsobject(SettingsRequest)

curl -i -X POST \
  'https://docs.scurri.com/_mock/connect/delivery-options-api/versions/2025.1/openapi/api/2.0.0/company/{company-slug}/delivery_options/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "package_type": "Parcel",
    "shipping_method": "My Mapped Rule",
    "order_number": "Order-123",
    "warehouse_id": "company-slug|Warehouse Name",
    "recipient": {
      "name": "John Doe",
      "first_name": "John",
      "last_name": "Doe",
      "company_name": "The Fake Company",
      "email_address": "the_fake_company@scurri.com",
      "contact_number": "021 123 4567",
      "address": {
        "address1": "123 Fake Street",
        "address2": "6th Floor",
        "address3": "Apartment 2C",
        "city": "Dublin",
        "state": "Dublin 2",
        "postcode": "Y31 XP20",
        "country": "IE",
        "latitude": 0,
        "longitude": 0
      }
    },
    "packages": [
      {
        "width": 12,
        "height": 10,
        "length": 8,
        "weight": 0.5,
        "description": "Toys",
        "items": [
          {
            "weight": 0.5,
            "value": 5.99,
            "name": "Toy",
            "quantity": 1,
            "sku": "SKU123",
            "country_of_origin": "IE",
            "harmonisation_code": "1234567890",
            "taric_condition": "Taric123",
            "vat_rate": "23",
            "import_type": "Gift",
            "fabric_content": "Plastic"
          }
        ]
      }
    ],
    "invoice": {
      "incoterm": "DAP"
    },
    "options": {
      "Signed": "Yes"
    },
    "currency": "EUR",
    "order_value": 19.99,
    "rules_package_type": "My Mapped Package Type Rule",
    "shipping_date": "2025-07-28",
    "custom_field_1": "My Custom Value 1",
    "custom_field_2": "My Custom Value 2",
    "custom_field_3": "My Custom Value 3",
    "custom_field_4": "My Custom Value 4",
    "custom_field_5": "My Custom Value 5",
    "settings": {
      "delivery_type": "ALL"
    }
  }'

Responses

the standard response when the request succeeds

Bodyapplication/json

delivery_optionsArray of objects(DeliveryOptionsGroupResponse)

Response

{
  "delivery_options": [
    { … }
  ]
}