List all shipping profiles or get a shipping profile by the ID. Different shipping methods are saved in a shipping profile.
/rest/orders/shipping/presets
| Field | Type | Description |
|---|---|---|
| columns | String[] |
The attributes to be loaded in the shipping profile |
| parcelServiceName | String |
Filter that restricts the search result to parcel service presets with a specified service name (e.g. 'DHL' for DHL) |
| shippingServiceProvider | String |
Filter that restricts the search result to a shipping service provider |
| with | String |
The name of an relation to the preset. The following parameter is available: parcelServiceRegion, parcelServiceRegionConstraint, parcelServicePresetNames and parcelServiceNames. |
| updatedAtBefore | String |
Filter that restricts the search result to presets that were updated before a specific date. Possible formats: yyyy-mm-dd or yyyy-mm-dd hh:mm:ss |
| updatedAtAfter | String |
Filter that restricts the search result to presets that were updated after a specific date. Possible formats: yyyy-mm-dd or yyyy-mm-dd hh:mm:ss |
List| Field | Type | Description |
|---|---|---|
| id | Int |
The ID of the shipping profile (autoincrement value) |
| parcelServiceId | Int |
The ID of the shipping service provider |
| backendName | String |
The back end name of the shipping profile |
| flag | Int |
The icon of the shipping profile |
| priority | Int |
The priority of the shipping profile |
| category | Int |
The category of the shipping profile |
| useArticlePorto | Int |
Flag that indicates if the extra shipping charge saved in the item data record is used |
| isInsured | Int |
Flag that indicates if the shipping profile is insured |
| isExpress | Int |
Flag that indicates if the shipping profile is used for express delivery |
| isPostident | Int |
Flag that indicates if the shipping profile includes an authority verification |
| isDefaultEnabled | Int |
Flag that indicates if the shipping profile is automatically assigned to new items |
| islandFee | Float |
The extra charge for islands saved in the shipping profile |
| isCod | Int |
Flag that indicates Cash on Delivery |
| supportedMultishop | String[] |
The clients (stores) that are activated for the shipping profile |
| supportedReferrer | String[] |
The order referrers that are activated for the shipping profile |
| subreferrerSupport | String[] |
This field is currently without any function. |
| excludedPaymentMethods | String[] |
The blocked payment methods that are not offered for the shipping profile |
| excludedCustomerGroups | String[] |
The blocked customer groups for the shipping profile. Blocked customer groups cannot select the shipping profile during checkout. |
| shippingGroup | String |
The group of the shipping profile |
| dispatchIdentifier | String |
This field is currently without any function. |
| auctionType | Int |
The eBay listing type for the shipping profile |
| supportedLoyaltyPrograms | String[] |
The loyalty programs that are supported by the shipping profile |
| updatedAt | String |
The date the shipping profile was last updated |
| showDataPrivacyAgreementHint | Int |
|
| transmitPrivacyRule | String |
|
| alternativeEmail | String |
|
| alternativePhone | String |
|
| isParcelBox | Int |
Indicates whether the e.g. paketshop is supported |
| isPostOffice | Int |
Indicates whether the e.g. postfiliale is supported |
| Code | Exception | Description |
|---|---|---|
| 401 | League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 | League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
Gets a shipping profile. The ID of the shipping profile must be specified.
/rest/orders/shipping/presets/{presetId}
| Field | Type | Description |
|---|---|---|
| presetId | Int |
The ID of the shipping profile |
| columns | String[] |
The attributes to be loaded in the shipping profile |
| Field | Type | Description |
|---|---|---|
| id | Int |
The ID of the shipping profile (autoincrement value) |
| parcelServiceId | Int |
The ID of the shipping service provider |
| backendName | String |
The back end name of the shipping profile |
| flag | Int |
The icon of the shipping profile |
| priority | Int |
The priority of the shipping profile |
| category | Int |
The category of the shipping profile |
| useArticlePorto | Int |
Flag that indicates if the extra shipping charge saved in the item data record is used |
| isInsured | Int |
Flag that indicates if the shipping profile is insured |
| isExpress | Int |
Flag that indicates if the shipping profile is used for express delivery |
| isPostident | Int |
Flag that indicates if the shipping profile includes an authority verification |
| isDefaultEnabled | Int |
Flag that indicates if the shipping profile is automatically assigned to new items |
| islandFee | Float |
The extra charge for islands saved in the shipping profile |
| isCod | Int |
Flag that indicates Cash on Delivery |
| supportedMultishop | String[] |
The clients (stores) that are activated for the shipping profile |
| supportedReferrer | String[] |
The order referrers that are activated for the shipping profile |
| subreferrerSupport | String[] |
This field is currently without any function. |
| excludedPaymentMethods | String[] |
The blocked payment methods that are not offered for the shipping profile |
| excludedCustomerGroups | String[] |
The blocked customer groups for the shipping profile. Blocked customer groups cannot select the shipping profile during checkout. |
| shippingGroup | String |
The group of the shipping profile |
| dispatchIdentifier | String |
This field is currently without any function. |
| auctionType | Int |
The eBay listing type for the shipping profile |
| supportedLoyaltyPrograms | String[] |
The loyalty programs that are supported by the shipping profile |
| updatedAt | String |
The date the shipping profile was last updated |
| showDataPrivacyAgreementHint | Int |
|
| transmitPrivacyRule | String |
|
| alternativeEmail | String |
|
| alternativePhone | String |
|
| isParcelBox | Int |
Indicates whether the e.g. paketshop is supported |
| isPostOffice | Int |
Indicates whether the e.g. postfiliale is supported |
| Code | Exception | Description |
|---|---|---|
| 401 | League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 | League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
/rest/orders/shipping/presets/preview/{language?}
| Field | Type | Description |
|---|---|---|
| language | String |
| Code | Exception | Description |
|---|---|---|
| 401 | League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 | League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |