Skip to main content
GET
Query Shipping Methods

Authorizations

Authorization
string
header
required

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

Headers

x-companyid
string

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

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

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.