Logistics APIs
List of all tracking numbers
| HTTP method | GET |
| URI | https://api.rambase.net/logistics/tracking-number-series |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 4082, version 13 |
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 |
| $expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select 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. |
| $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. |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
| $pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
| $filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
| $orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
| $inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
| Active() Named filter | Active trucking number series |
| Closed() Named filter | Closed tracking number series |
| PendingReqistration() Named filter | Tracking number which is not yet registered |
| CreatedAt Datetime | Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| Description String | Tracking number series description. |
| Status Integer | Status of tracking number. |
| TrackingNumberSeriesId Integer | Tracking number series identifier. |
| Type String | Tells if this serial of tracking number is to be allocated to each package ("PACKAGE") or for at total shipment ("SHIPMENT"). |
Read more about filters and sorting on how to use sortable parameters
| CreatedAt Datetime | Date and time of creation |
| Status Integer | Status of tracking number |
| TrackingNumberSeriesId Integer | Tracking number series identifier |
| Type String | Tells if this serial of tracking number is to be allocated to each package ("PACKAGE") or for at total shipment ("SHIPMENT") |
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>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>TrackingNumberLink
Tracking number series reference
>{String}</TrackingNumberLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>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}",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}"TrackingNumberLink
Tracking number series reference
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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: