API

Logistics APIs

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

Add an existing location to a specified shipping service

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

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
<ShippingServiceLocation>
2
     <Location
Location

Required/mandatory field

Location allowing shipping service

>
3
          <LocationId
LocationId

Required/mandatory field

Location identifier

Minimum value: 10000

>{Integer}</LocationId>
4
     </Location>
5
     <DepartureTimes
DepartureTimes

This field is optional.

>
6
          <DepartureTime
DepartureTime

This field is optional.

>
7
               <DepartureTimeId
DepartureTimeId

WBO close time identifier

Minimum value: 1

Maximum value: 4

This field is optional.

>{Integer}</DepartureTimeId>
8
               <Time
Time

WBO close time

This field is optional.

>{Time}</Time>
9
          </DepartureTime>
10
     </DepartureTimes>
11
</ShippingServiceLocation>
1
{
2
     "shippingServiceLocation": {
3
          "location
Location

Required/mandatory field

Location allowing shipping service

": {
4
               "locationId
LocationId

Required/mandatory field

Location identifier

Minimum value: 10000

": "{Integer}"
5
          },
6
          "departureTimes
DepartureTimes

This field is optional.

": [
7
               {
8
                    "departureTimeId
DepartureTimeId

WBO close time identifier

Minimum value: 1

Maximum value: 4

This field is optional.

": "{Integer}",
9
                    "time
Time

WBO close time

This field is optional.

": "{Time}"
10
               }
11
          ]
12
     }
13
}

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 100361 HTTP 400 Illegal time format {0}. Use hh:mm
Error 101635 HTTP 404 Location identifier for given Shipping Service not found
Error 101343 HTTP 400 Location is required for shipping service
Error 100199 HTTP 404 Location is not found
Error 105190 HTTP 400 Location {0} is already assigned to this shipping service