List, get or save shipping service providers. It is also possible to list all shipping service provider plugins.
/rest/orders/shipping/shipping_service_providers
Field | Type | Description |
---|---|---|
updatedAtBefore | String |
Filter that restricts the search result to shipping providers 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 shipping providers that were updated after a specific date. Possible formats: yyyy-mm-dd or yyyy-mm-dd hh:mm:ss |
with | String |
The name of an relation to the shipping provider. The following parameter is available: ownShippingServiceProviders. |
Field | Type | Description |
---|---|---|
page | Int |
Current page of the response |
totalsCount | Int |
The total number of entries in the response |
isLastPage | Bool |
Flag that indicates if the page shown is the last page of the response |
lastPageNumber | Int |
The last page number |
firstOnPage | Int |
The index of the first item of the current page result |
lastOnPage | Int |
The index of the last item of the current page result |
itemsPerPage | Int |
The requested amount of items per result page |
entries | ShippingServiceProvider[] |
List of ShippingServiceProvider |
id | Int |
The ID of the shipping service provider |
name | String |
The name of the shipping service provider |
pluginId | Int |
The optional ID of the plugin when the shipping service provider is registered as a plugin |
createdAt | String|\Carbon |
The time the shipping service provider was created |
updatedAt | String|\Carbon |
The time the shipping service provider was updated |
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 service provider. The ID of the shipping service provider must be specified.
/rest/orders/shipping/shipping_service_providers/{shipping_service_provider_id}
Field | Type | Description |
---|---|---|
id | Int |
The ID of the shipping service provider |
name | String |
The name of the shipping service provider |
pluginId | Int |
The optional ID of the plugin when the shipping service provider is registered as a plugin |
createdAt | String|\Carbon |
The time the shipping service provider was created |
updatedAt | String|\Carbon |
The time the shipping service provider was updated |
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. |
Saves a shipping service provider. The name of the shipping service provider must be specified.
/rest/orders/shipping/shipping_service_providers
Field | Type | Description |
---|---|---|
id | Int |
The ID of the shipping service provider |
name | String |
The name of the shipping service provider |
pluginId | Int |
The optional ID of the plugin when the shipping service provider is registered as a plugin |
createdAt | String|\Carbon |
The time the shipping service provider was created |
updatedAt | String|\Carbon |
The time the shipping service provider was updated |
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/shipping_service_providers/plugins
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. |