CommunitySupport PortalYouTubeStart a free trial

Shipping Methods

Manage shipping methods

Retrieving shipping methods

get

Retrieves shipping methods for the specified site and shipping zone.

Required scopes

No specific scopes are required.

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$
sitestringRequired

Site’s unique identifier. A site is a specific shop.

If the tenant owns only one shop, the value should be set to main.

zoneIdstringRequired

Shipping zone's unique identifier.

Query parameters
activestringOptional

If set to true, only active methods are returned. If set to false, only the inactive methods are returned. If not specified, both active and inactive methods are returned.

expandstringOptional
  • methods: To return zones with expanded shipping methods.
  • fees: To expand the configured fees for those shipping methods.
Example: methods,fees
Header parameters
Accept-LanguagestringOptional

The Accept-Language request HTTP header defines which languages the client is able to understand, and which locale variant is preferred. It can be a priority list working as a fallback mechanism. If the Accept-Language header is empty, all languages for localized fields are returned in a map format where the key is language code and the value is a translation.

Example: fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7
Responses
200

Resource successfully retrieved.

application/json
get
GET /shipping/{tenant}/{site}/zones/{zoneId}/methods HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "fedex-2dayground",
    "name": "FedEx 2Day",
    "active": true,
    "maxOrderValue": {
      "amount": 5000,
      "currency": "EUR"
    },
    "fees": [
      {
        "minOrderValue": {
          "amount": 0,
          "currency": "EUR"
        },
        "cost": {
          "amount": 10,
          "currency": "EUR"
        }
      },
      {
        "minOrderValue": {
          "amount": 50,
          "currency": "EUR"
        },
        "cost": {
          "amount": 9,
          "currency": "EUR"
        },
        "shippingGroupId": "group1"
      },
      {
        "minOrderValue": {
          "amount": 200,
          "currency": "EUR"
        },
        "cost": {
          "amount": 8,
          "currency": "EUR"
        },
        "shippingGroupId": "group2"
      }
    ]
  },
  {
    "id": "ups-standard",
    "name": "UPS Standard",
    "fees": [
      {
        "minOrderValue": {
          "amount": 0,
          "currency": "EUR"
        },
        "cost": {
          "amount": 5,
          "currency": "EUR"
        }
      },
      {
        "minOrderValue": {
          "amount": 50,
          "currency": "EUR"
        },
        "cost": {
          "amount": 2,
          "currency": "EUR"
        },
        "shippingGroupId": "group3"
      }
    ]
  }
]

Creating a shipping method

post

Creates a new shipping method for the specified site and shipping zone.

Required scopes

  • shipping.shipping_manage

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$
sitestringRequired

Site’s unique identifier. A site is a specific shop.

If the tenant owns only one shop, the value should be set to main.

zoneIdstringRequired

Shipping zone's unique identifier.

Header parameters
Content-LanguagestringOptional

The Content-Language request HTTP header defines language of the payload. When the Content-Language header is empty, all localized fields in a payload should be in a map format, where the key is a language code and the value is a translation.

Example: fr
Body

Shipping methods define the types of deliveries and properties such as delivery fees.

idstringRequired
nameone ofRequired
stringOptional

String value in the specified language.

Example: FedEx 2Day
or
activebooleanOptional

Flag indicating whether the shipping method is active.

shippingTaxCodestringOptional

Shipping method's tax code.

shippingGroupIdstringOptional

Shipping groups unique identifier.

Responses
201

Resource successfully created.

application/json
post
POST /shipping/{tenant}/{site}/zones/{zoneId}/methods HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 430

{
  "id": "fedex-2dayground",
  "name": "FedEx 2Day",
  "active": true,
  "maxOrderValue": {
    "amount": 5000,
    "currency": "EUR"
  },
  "fees": [
    {
      "minOrderValue": {
        "amount": 0,
        "currency": "EUR"
      },
      "cost": {
        "amount": 10,
        "currency": "EUR"
      }
    },
    {
      "minOrderValue": {
        "amount": 50,
        "currency": "EUR"
      },
      "cost": {
        "amount": 9,
        "currency": "EUR"
      },
      "shippingGroupId": "group1"
    },
    {
      "minOrderValue": {
        "amount": 200,
        "currency": "EUR"
      },
      "cost": {
        "amount": 8,
        "currency": "EUR"
      },
      "shippingGroupId": "group2"
    }
  ]
}
{
  "id": "fedex-2dayground"
}

Retrieving a shipping method

get

Retrieves the specified shipping method's details.

Required scopes

No specific scopes are required.

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$
zoneIdstringRequired

Shipping zone's unique identifier.

methodIdstringRequired

Delivery method's unique identifier.

sitestringRequired

Site’s unique identifier. A site is a specific shop.

If the tenant owns only one shop, the value should be set to main.

Header parameters
Accept-LanguagestringOptional

The Accept-Language request HTTP header defines which languages the client is able to understand, and which locale variant is preferred. It can be a priority list working as a fallback mechanism. If the Accept-Language header is empty, all languages for localized fields are returned in a map format where the key is language code and the value is a translation.

Example: fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7
Responses
200

Resource successfully retrieved.

application/json
get
GET /shipping/{tenant}/{site}/zones/{zoneId}/methods/{methodId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "fedex-2dayground",
  "name": "FedEx 2Day",
  "active": true,
  "maxOrderValue": {
    "amount": 5000,
    "currency": "EUR"
  },
  "fees": [
    {
      "minOrderValue": {
        "amount": 0,
        "currency": "EUR"
      },
      "cost": {
        "amount": 10,
        "currency": "EUR"
      }
    },
    {
      "minOrderValue": {
        "amount": 50,
        "currency": "EUR"
      },
      "cost": {
        "amount": 9,
        "currency": "EUR"
      },
      "shippingGroupId": "group1"
    },
    {
      "minOrderValue": {
        "amount": 200,
        "currency": "EUR"
      },
      "cost": {
        "amount": 8,
        "currency": "EUR"
      },
      "shippingGroupId": "group2"
    }
  ]
}

Updating a shipping method

put

Fully updates the specified shipping method.

Required scopes

  • shipping.shipping_manage

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$
zoneIdstringRequired

Shipping zone's unique identifier.

methodIdstringRequired

Delivery method's unique identifier.

sitestringRequired

Site’s unique identifier. A site is a specific shop.

If the tenant owns only one shop, the value should be set to main.

Header parameters
Content-LanguagestringOptional

The Content-Language request HTTP header defines language of the payload. When the Content-Language header is empty, all localized fields in a payload should be in a map format, where the key is a language code and the value is a translation.

Example: fr
Body

Shipping methods define the types of deliveries and properties such as delivery fees.

idstringRequired
nameone ofRequired
stringOptional

String value in the specified language.

Example: FedEx 2Day
or
activebooleanOptional

Flag indicating whether the shipping method is active.

shippingTaxCodestringOptional

Shipping method's tax code.

shippingGroupIdstringOptional

Shipping groups unique identifier.

Responses
200

Resource successfully updated.

put
PUT /shipping/{tenant}/{site}/zones/{zoneId}/methods/{methodId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 430

{
  "id": "fedex-2dayground",
  "name": "FedEx 2Day",
  "active": true,
  "maxOrderValue": {
    "amount": 5000,
    "currency": "EUR"
  },
  "fees": [
    {
      "minOrderValue": {
        "amount": 0,
        "currency": "EUR"
      },
      "cost": {
        "amount": 10,
        "currency": "EUR"
      }
    },
    {
      "minOrderValue": {
        "amount": 50,
        "currency": "EUR"
      },
      "cost": {
        "amount": 9,
        "currency": "EUR"
      },
      "shippingGroupId": "group1"
    },
    {
      "minOrderValue": {
        "amount": 200,
        "currency": "EUR"
      },
      "cost": {
        "amount": 8,
        "currency": "EUR"
      },
      "shippingGroupId": "group2"
    }
  ]
}
No content

Deleting a shipping method

delete

Deletes the specified shipping method.

Required scopes

  • shipping.shipping_manage

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$
zoneIdstringRequired

Shipping zone's unique identifier.

methodIdstringRequired

Delivery method's unique identifier.

sitestringRequired

Site’s unique identifier. A site is a specific shop.

If the tenant owns only one shop, the value should be set to main.

Responses
204

Resource successfully deleted.

delete
DELETE /shipping/{tenant}/{site}/zones/{zoneId}/methods/{methodId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Partially updating a shipping method

patch

Partially updates the specified shipping method.

Required scopes

  • shipping.shipping_manage

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$
zoneIdstringRequired

Shipping zone's unique identifier.

methodIdstringRequired

Delivery method's unique identifier.

sitestringRequired

Site’s unique identifier. A site is a specific shop.

If the tenant owns only one shop, the value should be set to main.

Header parameters
Content-LanguagestringOptional

The Content-Language request HTTP header defines language of the payload. When the Content-Language header is empty, all localized fields in a payload should be in a map format, where the key is a language code and the value is a translation.

Example: fr
Body

Shipping methods define the types of deliveries and properties such as delivery fees.

idstringRequired
nameone ofRequired
stringOptional

String value in the specified language.

Example: FedEx 2Day
or
activebooleanOptional

Flag indicating whether the shipping method is active.

shippingTaxCodestringOptional

Shipping method's tax code.

shippingGroupIdstringOptional

Shipping groups unique identifier.

Responses
200

Resource successfully updated.

patch
PATCH /shipping/{tenant}/{site}/zones/{zoneId}/methods/{methodId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 430

{
  "id": "fedex-2dayground",
  "name": "FedEx 2Day",
  "active": true,
  "maxOrderValue": {
    "amount": 5000,
    "currency": "EUR"
  },
  "fees": [
    {
      "minOrderValue": {
        "amount": 0,
        "currency": "EUR"
      },
      "cost": {
        "amount": 10,
        "currency": "EUR"
      }
    },
    {
      "minOrderValue": {
        "amount": 50,
        "currency": "EUR"
      },
      "cost": {
        "amount": 9,
        "currency": "EUR"
      },
      "shippingGroupId": "group1"
    },
    {
      "minOrderValue": {
        "amount": 200,
        "currency": "EUR"
      },
      "cost": {
        "amount": 8,
        "currency": "EUR"
      },
      "shippingGroupId": "group2"
    }
  ]
}
No content
PreviousShipping CostNextShipping Zones

Was this helpful?