API

Logistics APIs

PUT logistics/shipments/{shipmentId}

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.

Format:
1
<Shipment
Shipment

This field is optional.

>
2
     <Priority
Priority

Priority of the shipment

Applicable domain values can be found here

This field is optional.

>{Integer}</Priority>
3
     <WeightUnit
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>
4
     <LengthUnit
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>
5
     <ExternalShipmentId
ExternalShipmentId

Used to store external shipping IDs. Example from integrations like Consignor or UniFaun

This field is optional.

>{String}</ExternalShipmentId>
6
     <Tracking
Tracking

This field is optional.

>
7
          <TrackingNumber
TrackingNumber

Carriers tracking number for the whole shipment

This field is optional.

>{String}</TrackingNumber>
8
          <TrackingUri
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>
9
     </Tracking>
10
     <ShippingService
ShippingService

This field is optional.

>
11
          <ShippingServiceId
ShippingServiceId

Shipping service identifier

This field is optional.

>{Integer}</ShippingServiceId>
12
     </ShippingService>
13
     <DepartingWaybill
DepartingWaybill

This field is optional.

>
14
          <DepartingWaybillId
DepartingWaybillId

Departing waybill identifier

Minimum value: 10000

This field is optional.

>{Integer}</DepartingWaybillId>
15
     </DepartingWaybill>
16
</Shipment>
1
{
2
     "shipment
Shipment

This field is optional.

": {
3
          "priority
Priority

Priority of the shipment

Applicable domain values can be found here

This field is optional.

": "{Integer}",
4
          "weightUnit
WeightUnit

Unit used for measuring weight on the packages in this shipment

Applicable domain values can be found here

This field is optional.

": "{String}",
5
          "lengthUnit
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}",
6
          "externalShipmentId
ExternalShipmentId

Used to store external shipping IDs. Example from integrations like Consignor or UniFaun

This field is optional.

": "{String}",
7
          "tracking
Tracking

This field is optional.

": {
8
               "trackingNumber
TrackingNumber

Carriers tracking number for the whole shipment

This field is optional.

": "{String}",
9
               "trackingUri
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}"
10
          },
11
          "shippingService
ShippingService

This field is optional.

": {
12
               "shippingServiceId
ShippingServiceId

Shipping service identifier

This field is optional.

": "{Integer}"
13
          },
14
          "departingWaybill
DepartingWaybill

This field is optional.

": {
15
               "departingWaybillId
DepartingWaybillId

Departing waybill identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
16
          }
17
     }
18
}

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.

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 102185 HTTP 400 Missing mandatory parameter for assignment.
Error 102186 HTTP 400 Missing mandatory parameter for assignment id.
Error 100089 HTTP 404 Product {0} not found
Error 101488 HTTP 400 Illegal general ledger account : {0}
Error 105186 HTTP 400 Postings are not allowed on control accounts.
Error 101490 HTTP 400 Illegal Account {0}: This account has been blocked for {1}-documents
Error 101491 HTTP 400 Illegal Account {0}: Check the account's FromPeriod and ToPeriod
Error 101517 HTTP 400 Illegal Account {0}: This account require ICTDB.
Error 102482 HTTP 400 Department is required for general ledger account {0}
Error 102483 HTTP 400 Finance project is required for general ledger account {0}
Error 102484 HTTP 400 Asset is required for general ledger account {0}
Error 102485 HTTP 400 Dimension {0} ({1}) is required for general ledger account {2}
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 109539 HTTP 400 Dimension value {0} could not be used : Check its FromPeriod and ToPeriod.
Error 102486 HTTP 400 Invalid value for dimension {0}
Error 108679 HTTP 400 Expected check-in date cannot be earlier then expected check-out date
Error 108262 HTTP 404 Recurring rate not found
Error 108691 HTTP 400 Recurring rate is not active
Error 108018 HTTP 400 Currency mismatch
Error 108016 HTTP 400 Product id mismatch
Error 108824 HTTP 400 Cannot apply recurring rate as it is not valid for selected period
Error 108671 HTTP 400 The effective date cannot be changed because earlier days have already been invoiced
Error 108684 HTTP 400 The expiration date cannot be changed because later days have already been invoiced
Error 108683 HTTP 400 Termination date must be earlier then the expiration date
Error 109306 HTTP 400 Shipping details can only be updated until an item is shipped