List all returns service providers, get a returns service provider by the ID or save a returns service provider.
/rest/orders/shipping/returns/returns_service_providers
| Field | Type | Description |
|---|---|---|
| isPlugin | Int |
Possible values are 1 (true), 0 (false) |
| pluginId | Int |
The id of the plugin. |
| 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 | ReturnsServiceProvider[] |
List of ReturnsServiceProvider |
| id | Int |
The ID of the returns service provider |
| name | String |
The name of the returns service provider |
| pluginId | Int |
The optional ID of the plugin when the returns service provider is registered as a plugin |
| createdAt | String|\Carbon |
The time the returns service provider was created |
| updatedAt | String|\Carbon |
The time the returns 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/returns/returns_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. |
/rest/orders/shipping/returns/returns_service_providers/{providerId}
| Field | Type | Description |
|---|---|---|
| $providerId | Int |
The returns service provider id. |
| Field | Type | Description |
|---|---|---|
| id | Int |
The ID of the returns service provider |
| name | String |
The name of the returns service provider |
| pluginId | Int |
The optional ID of the plugin when the returns service provider is registered as a plugin |
| createdAt | String|\Carbon |
The time the returns service provider was created |
| updatedAt | String|\Carbon |
The time the returns 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. |