API

Logistics APIs

POST logistics/tracking-number-series/{trackingNumberSeriesId}/shipping-services

Add an existing shipping service to a specified tracking number

HTTP method POST
URI https://api.rambase.net/logistics/tracking-number-series/{trackingNumberSeriesId}/shipping-services
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {trackingNumberSeriesId} Tracking number series identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 4144, version 2

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
<ShippingService>
2
     <ShippingServiceId
ShippingServiceId

Required/mandatory field

Shipping service identifier

Minimum value: 100000

>{Integer}</ShippingServiceId>
3
</ShippingService>
1
{
2
     "shippingService": {
3
          "shippingServiceId
ShippingServiceId

Required/mandatory field

Shipping service identifier

Minimum value: 100000

": "{Integer}"
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 101344 HTTP 404 Tracking number series was not found
Error 100027 HTTP 400 Missing mandatory parameter {0}
Error 101361 HTTP 400 Shipping service is mandatory for tracking number series
Error 101119 HTTP 404 Shipping service was not found
Error 101376 HTTP 400 ShippingService is not active (status 4)
Error 101516 HTTP 400 Shipping service {0} is already assigned to another tracking number series: {1}