Logistics APIs
Ger tracking number
| HTTP method | GET |
| URI | https://api.rambase.net/logistics/tracking-number-series/{trackingNumberSeriesId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {trackingNumberSeriesId} |
Tracking number series identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 4134, version 15 |
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.
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.
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
| $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 |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $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. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
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. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
TrackingNumberSeriesId
Tracking number series identifier
>{Integer}</TrackingNumberSeriesId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Type
Tells if this serial of tracking number is to be allocated to each package ("PACKAGE") or for at total shipment ("SHIPMENT")
Possible domain values can be found here
>{String}</Type>Description
Tracking number series description
>{String}</Description>TrackingUri
URL to shipping providers tracking system
>{String}</TrackingUri>Modulus
The number by which a logarithm to one base is multiplied to give the corresponding logarithm to another base
Possible domain values can be found here
>{String}</Modulus>Prefix
Prefix when creating the tracking number
>{String}</Prefix>Suffix
To be used as suffix when creating the tracking number
>{String}</Suffix>RoleId
Role identifier
>{Integer}</RoleId>Name
Name of the role
>{String}</Name>RoleLink
Role reference
>{String}</RoleLink>StartTrackingNumber
First tracking number in the series
>{Long}</StartTrackingNumber>EndTrackingNumber
Last tracking number in the series
>{Long}</EndTrackingNumber>WarningTrackingNumber
When this tracking number is reached, a warning will be sent to users that belongs to a specific role
>{Long}</WarningTrackingNumber>CurrentTrackingNumber
The tracking number that will be used for next package/shipment
>{Long}</CurrentTrackingNumber>StartTrackingNumber
First tracking number in next range of tracking numbers, which will be activated when the current range of tracking number series is ended
>{Long}</StartTrackingNumber>EndTrackingNumber
Last tracking number in next range of tracking numbers, which will be activated when the current range of tracking number series is ended
>{Long}</EndTrackingNumber>WarningTrackingNumber
Warning tracking number in next range of tracking numbers, which will be activated when the current range of tracking number series is ended
>{Long}</WarningTrackingNumber>TrackingNumberSeriesId
Tracking number series identifier
": "{Integer}",Status
Status of tracking number
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Type
Tells if this serial of tracking number is to be allocated to each package ("PACKAGE") or for at total shipment ("SHIPMENT")
Possible domain values can be found here
": "{String}",Description
Tracking number series description
": "{String}",TrackingUri
URL to shipping providers tracking system
": "{String}",Modulus
The number by which a logarithm to one base is multiplied to give the corresponding logarithm to another base
Possible domain values can be found here
": "{String}",Prefix
Prefix when creating the tracking number
": "{String}",Suffix
To be used as suffix when creating the tracking number
": "{String}",RoleId
Role identifier
": "{Integer}",Name
Name of the role
": "{String}",RoleLink
Role reference
": "{String}"StartTrackingNumber
First tracking number in the series
": "{Long}",EndTrackingNumber
Last tracking number in the series
": "{Long}",WarningTrackingNumber
When this tracking number is reached, a warning will be sent to users that belongs to a specific role
": "{Long}",CurrentTrackingNumber
The tracking number that will be used for next package/shipment
": "{Long}"StartTrackingNumber
First tracking number in next range of tracking numbers, which will be activated when the current range of tracking number series is ended
": "{Long}",EndTrackingNumber
Last tracking number in next range of tracking numbers, which will be activated when the current range of tracking number series is ended
": "{Long}",WarningTrackingNumber
Warning tracking number in next range of tracking numbers, which will be activated when the current range of tracking number series is ended
": "{Long}"
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 101606 HTTP 404 | Module not found |