API

Logistics APIs

POST logistics/shipping-services/{shippingServiceId}/countries

Add an existing country to the given shipping service

HTTP method POST
URI https://api.rambase.net/logistics/shipping-services/{shippingServiceId}/countries
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {shippingServiceId} Shipping service identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 4090, version 4

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<Country>
2
     <CountryCode
CountryCode

Required/mandatory field

Two-character code (ISO 3166) identifying the country.

>
{String}</CountryCode>
3
</Country>
1
{
2
     "country": {
3
          "countryCode
CountryCode

Required/mandatory field

Two-character code (ISO 3166) identifying the country.

":
"{String}"
4
     }
5
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101119 HTTP 404 Shipping service was not found
Error 101367 HTTP 400 Shipping service has been closed (status 9)
Error 101338 HTTP 400 Countrycode is required for shipping service
Error 100141 HTTP 404 Country not found
Error 105146 HTTP 400 Country code {0} is already assigned to this shipping service