CommunitySupport PortalYouTubeStart a free trial

Shipping Groups

Manage shipping groups

Retrieving shipping groups

get

Retrieves a list of shipping groups for the specified site.

Required scopes

No specific scopes 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.

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}/groups HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "group1",
    "description": {
      "en": "This is the description for the group group1.",
      "de": "Dies ist die Beschreibung für die Gruppe group1."
    }
  },
  {
    "id": "group2",
    "description": {
      "en": "This is the description for the group group2.",
      "de": "Dies ist die Beschreibung für die Gruppe group2."
    }
  }
]

Creating a shipping group

post

Creates a new shipping group for the specified site.

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.

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 groups can be used for customer grouping with use customer group relations.

idstringRequired

Delivery group's unique identifier.

descriptionone ofOptional
stringOptional

String value in the specified language.

Example: FedEx 2Day
or
Responses
201

Resource successfully created.

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

{
  "id": "group1",
  "description": {
    "en": "This is the description for the group group1.",
    "de": "Dies ist die Beschreibung für die Gruppe group1."
  }
}
{
  "id": "group1"
}

Retrieving a shipping group

get

Retrieves the specified shipping group's details.

Required scopes

No specific scopes 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.

groupIdstringRequired

Delivery group's unique identifier.

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}/groups/{groupId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "group1",
  "description": {
    "en": "This is the description for the group group1.",
    "de": "Dies ist die Beschreibung für die Gruppe group1."
  }
}

Updating a shipping group

put

Fully updates the specified shipping group.

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.

groupIdstringRequired

Delivery group'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 groups can be used for customer grouping with use customer group relations.

idstringRequired

Delivery group's unique identifier.

descriptionone ofOptional
stringOptional

String value in the specified language.

Example: FedEx 2Day
or
Responses
200

Resource successfully updated.

put
PUT /shipping/{tenant}/{site}/groups/{groupId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 141

{
  "id": "group1",
  "description": {
    "en": "This is the description for the group group1.",
    "de": "Dies ist die Beschreibung für die Gruppe group1."
  }
}
No content

Deleting a shipping group

delete

Deletes the specified shipping group.

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.

groupIdstringRequired

Delivery group's unique identifier.

Responses
204

Resource successfully deleted.

delete
DELETE /shipping/{tenant}/{site}/groups/{groupId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content
PreviousShipping ZonesNextSites

Was this helpful?