Logistics APIs
Saves information about shiment
| HTTP method | PUT |
| URI | https://api.rambase.net/logistics/shipments/{shipmentId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {shipmentId} |
Shipment identifier
Long, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 2741, 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.
Shipment
This field is optional.
>Priority
Priority of the shipment
Applicable domain values can be found here
This field is optional.
>{Integer}</Priority>WeightUnit
Unit used for measuring weight on the packages in this shipment
Applicable domain values can be found here
This field is optional.
>{String}</WeightUnit>LengthUnit
Unit used for measuring length, width and height of the packages in the shipment.
Applicable domain values can be found here
This field is optional.
>{String}</LengthUnit>ExternalShipmentId
Used to store external shipping IDs. Example from integrations like Consignor or UniFaun
This field is optional.
>{String}</ExternalShipmentId>Tracking
This field is optional.
>TrackingNumber
Carriers tracking number for the whole shipment
This field is optional.
>{String}</TrackingNumber>TrackingUri
Tracking uri for the shipment. The uri is generated from the tracking number series, and might include the tracking number
This field is optional.
>{String}</TrackingUri>ShippingService
This field is optional.
>ShippingServiceId
Shipping service identifier
This field is optional.
>{Integer}</ShippingServiceId>DepartingWaybill
This field is optional.
>DepartingWaybillId
Departing waybill identifier
Minimum value: 10000
This field is optional.
>{Integer}</DepartingWaybillId>Shipment
This field is optional.
": {Priority
Priority of the shipment
Applicable domain values can be found here
This field is optional.
": "{Integer}",WeightUnit
Unit used for measuring weight on the packages in this shipment
Applicable domain values can be found here
This field is optional.
": "{String}",LengthUnit
Unit used for measuring length, width and height of the packages in the shipment.
Applicable domain values can be found here
This field is optional.
": "{String}",ExternalShipmentId
Used to store external shipping IDs. Example from integrations like Consignor or UniFaun
This field is optional.
": "{String}",Tracking
This field is optional.
": {TrackingNumber
Carriers tracking number for the whole shipment
This field is optional.
": "{String}",TrackingUri
Tracking uri for the shipment. The uri is generated from the tracking number series, and might include the tracking number
This field is optional.
": "{String}"ShippingService
This field is optional.
": {ShippingServiceId
Shipping service identifier
This field is optional.
": "{Integer}"DepartingWaybill
This field is optional.
": {DepartingWaybillId
Departing waybill identifier
Minimum value: 10000
This field is optional.
": "{Integer}"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. |
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.
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 102667 HTTP 404 | Customer group not found |
| Error 101454 HTTP 400 | Customer ID is required |
| Error 107900 HTTP 400 | Currency is required |
| Error 102035 HTTP 400 | Effective date is required |
| Error 100345 HTTP 400 | Location is required |
| Error 108514 HTTP 400 | Invalid invoice frequency |
| Error 108635 HTTP 400 | Effective date cannot be later then effective date of any contract item |
| Error 108421 HTTP 400 | The effective date cannot be later than the expiration date |
| Error 108735 HTTP 400 | Expiration date of a contract cannot be earlier then expiration date of any of its quotes |
| Error 108674 HTTP 400 | Termination date cannot be earlier then the effective date |
| Error 108675 HTTP 400 | Termination date cannot be later then the expiration date |
| Error 108672 HTTP 400 | Closing date cannot be earlier then the effective date |
| Error 108673 HTTP 400 | Closing date cannot be later then the expiration date |
| Error 101313 HTTP 400 | Department number is not valid: {0} |
| Error 101320 HTTP 400 | The project number is not valid: {0} |
| Error 101500 HTTP 400 | Project {0} could not be used : Check project FromPeriod and ToPeriod. |
| Error 101501 HTTP 400 | Asset is not allowed on general ledger account {0} |
| Error 101326 HTTP 400 | The asset number is not valid : {0} |
| Error 102486 HTTP 400 | Invalid value for dimension {0} |
| Error 108680 HTTP 400 | Collection date cannot be earlier then the effective date |
| Error 108681 HTTP 400 | Collection date cannot be earlier then the expected delivery date |
| Error 108683 HTTP 400 | Termination date must be earlier then the expiration date |