Shipping Groups

Manage shipping groups

Retrieving shipping groups

get

Retrieves a list of shipping groups for a specified site.

Authorizations

oAuth2

OAuth2clientCredentialsRequired

Token URL:

Available scopes:

• : Needed to manage shipping settings.
• : Needed to read shipping settings.

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

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

sitestringRequired

Site 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

400

Request syntactically incorrect. Details of the error are included in the response payload.

application/json

401

Unauthorized

application/json

500

Some server side error occurred.

application/json

get

/shipping/{tenant}/{site}/groups

HTTPcURLJavaScriptPython

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

This endpoint requires the following scopes:

• : Needed to manage shipping settings.

Authorizations

oAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

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

sitestringRequired

Site 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

application/json

Shipping groups can be used for customer grouping with use customer group relations.

idstringRequired

Delivery group unique identifier.

descriptionone ofOptional

stringOptional

String value in the specified language.

Example: FedEx 2Day

or

Responses

201

Resource successfully created.

application/json

400

Request syntactically incorrect. Details of the error are included in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match required scopes.

application/json

409

Creation failed because there was a conflict with another resource. Details of the error are included in the response payload.

application/json

500

Some server side error occurred.

application/json

post

/shipping/{tenant}/{site}/groups

HTTPcURLJavaScriptPython

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."
  }
}

Group create payload with description as a mapGroup create payload with description as a string

{
  "id": "group1"
}

Retrieving a shipping group

get

Retrieves the specified shipping group details.

Authorizations

oAuth2

OAuth2clientCredentialsRequired

Token URL:

Available scopes:

• : Needed to manage shipping settings.
• : Needed to read shipping settings.

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

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

sitestringRequired

Site 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 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

400

Request syntactically incorrect. Details of the error are included in the response payload.

application/json

401

Unauthorized

application/json

404

The requested resource does not exist.

application/json

500

Some server side error occurred.

application/json

get

/shipping/{tenant}/{site}/groups/{groupId}

HTTPcURLJavaScriptPython

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

This endpoint requires the following scopes:

• : Needed to manage shipping settings.

Authorizations

oAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

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

sitestringRequired

Site 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 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

application/json

Shipping groups can be used for customer grouping with use customer group relations.

idstringRequired

Delivery group unique identifier.

descriptionone ofOptional

stringOptional

String value in the specified language.

Example: FedEx 2Day

or

Responses

200

Resource successfully updated.

No content

400

Request syntactically incorrect. Details of the error are included in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match required scopes.

application/json

404

The requested resource does not exist.

application/json

500

Some server side error occurred.

application/json

put

/shipping/{tenant}/{site}/groups/{groupId}

HTTPcURLJavaScriptPython

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."
  }
}

Group update payload with description as a mapGroup update payload with description as a string

No content

Deleting a shipping group

delete

Deletes the specified shipping group.

Required scopes

This endpoint requires the following scopes:

• : Needed to manage shipping settings.

Authorizations

oAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

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

sitestringRequired

Site 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 unique identifier.

Responses

204

Resource successfully deleted.

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match required scopes.

application/json

500

Some server side error occurred.

application/json

delete

/shipping/{tenant}/{site}/groups/{groupId}

HTTPcURLJavaScriptPython

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

No content