Logistics APIs
Package details for provided identifier
| HTTP method | GET |
| URI | https://api.rambase.net/logistics/shipments/{shipmentId}/packages/{packageId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {shipmentId} |
Shipment identifier
Long, minimum 1000000 |
| - URI parameter {packageId} |
Package identifier
Integer, minimum 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 2716, version 10 |
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.
| $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.
PackageId
Package identifier
>{Integer}</PackageId>Weight
Weight of this package. Measurement unit is specified in the location arthive
>{Decimal}</Weight>Comment
Comment for this package
>{String}</Comment>TrackingNumber
Tracking number for this package
>{String}</TrackingNumber>TrackingUri
Tracking uri for the package. The uri is generated based on set-up in the archive of tracking number series, and might include the tracking number
>{String}</TrackingUri>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>NetPrice
The freigth price for this package
>{Decimal}</NetPrice>Cost
Freight costs of this package
>{Decimal}</Cost>Height
Height of this package. Measurement unit is configured in the location archive.
>{Decimal}</Height>Length
Length of this package. Measurement unit is configured in the location arhive
>{Decimal}</Length>Width
Width of this package. Measurement unit is specified in location archive.
>{Decimal}</Width>Volume
Volume of this package. The volume is not necessarily simply the product of length, width and height, this only applies for cuboid packages. Therefore the system only proposes this simple calculation if length, width and height are filled and the volume is still empty; but as soon as already a value exists there, it will not be changed automatical any more, for it could have been especially entered for this package.
>{Decimal}</Volume>PackageId
Package identifier
": "{Integer}",Weight
Weight of this package. Measurement unit is specified in the location arthive
": "{Decimal}",Comment
Comment for this package
": "{String}",TrackingNumber
Tracking number for this package
": "{String}",TrackingUri
Tracking uri for the package. The uri is generated based on set-up in the archive of tracking number series, and might include the tracking number
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",NetPrice
The freigth price for this package
": "{Decimal}",Cost
Freight costs of this package
": "{Decimal}"Height
Height of this package. Measurement unit is configured in the location archive.
": "{Decimal}",Length
Length of this package. Measurement unit is configured in the location arhive
": "{Decimal}",Width
Width of this package. Measurement unit is specified in location archive.
": "{Decimal}",Volume
Volume of this package. The volume is not necessarily simply the product of length, width and height, this only applies for cuboid packages. Therefore the system only proposes this simple calculation if length, width and height are filled and the volume is still empty; but as soon as already a value exists there, it will not be changed automatical any more, for it could have been especially entered for this package.
": "{Decimal}"
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 101013 HTTP 404 | Sub-module not found |
| Error 101420 HTTP 404 | Setting definition not found |