Skip to main content
GET
/
v1
/
shippingMethods
Query Shipping Methods
curl --request GET \
  --url https://api.jtl-cloud.com/erp/v1/shippingMethods \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'
[
  {
    "Id": 123,
    "Name": "<string>",
    "Priority": 123,
    "GrossPrice": 123,
    "ExtraWeight": 123,
    "IsAmazonPrime": true
  }
]

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

​
x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

​
x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Response

Returns all shipping methods.

​
Id
integer<int32>
required

Unique ID to identify a shipping method.

​
Name
string
required

Name of the shipping method.

​
Priority
integer<int32>
required

The priority of the shipping method.

​
GrossPrice
number<decimal>
required

Gross price of the shipping method.

​
ExtraWeight
number<decimal>
required

Extra weight for each parcel created with the shipping method.

​
IsAmazonPrime
boolean
required

Indicates if seller-fulfilled Amazon Prime should be applied to the shipping method.