API

Logistics APIs

POST logistics/shipments/{shipmentId}/packages

Add a new package to provided shipment

HTTP method POST
URI https://api.rambase.net/logistics/shipments/{shipmentId}/packages
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {shipmentId} Shipment identifier
Long, minimum 1000000
Successful HTTP status code 201
API resource identifier 2735, version 7

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
<Package
Package

This field is optional.

>
2
     <Weight
Weight

Weight of this package. Measurement unit is specified in the location arthive

This field is optional.

>{Decimal}</Weight>
3
     <Comment
Comment

Comment for this package

This field is optional.

>{String}</Comment>
4
     <Tracking
Tracking

This field is optional.

>
5
          <TrackingNumber
TrackingNumber

Tracking number for this package

This field is optional.

>{String}</TrackingNumber>
6
     </Tracking>
7
     <Freight
Freight

This field is optional.

>
8
          <NetPrice
NetPrice

The freigth price for this package

This field is optional.

>{Decimal}</NetPrice>
9
          <Cost
Cost

Freight costs of this package

This field is optional.

>{Decimal}</Cost>
10
     </Freight>
11
     <Dimensions
Dimensions

This field is optional.

>
12
          <Height
Height

Height of this package. Measurement unit is configured in the location archive.

This field is optional.

>{Decimal}</Height>
13
          <Length
Length

Length of this package. Measurement unit is configured in the location arhive

This field is optional.

>{Decimal}</Length>
14
          <Width
Width

Width of this package. Measurement unit is specified in location archive.

This field is optional.

>{Decimal}</Width>
15
          <Volume
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.

This field is optional.

>{Decimal}</Volume>
16
     </Dimensions>
17
</Package>
1
{
2
     "package
Package

This field is optional.

": {
3
          "weight
Weight

Weight of this package. Measurement unit is specified in the location arthive

This field is optional.

": "{Decimal}",
4
          "comment
Comment

Comment for this package

This field is optional.

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

This field is optional.

": {
6
               "trackingNumber
TrackingNumber

Tracking number for this package

This field is optional.

": "{String}"
7
          },
8
          "freight
Freight

This field is optional.

": {
9
               "netPrice
NetPrice

The freigth price for this package

This field is optional.

": "{Decimal}",
10
               "cost
Cost

Freight costs of this package

This field is optional.

": "{Decimal}"
11
          },
12
          "dimensions
Dimensions

This field is optional.

": {
13
               "height
Height

Height of this package. Measurement unit is configured in the location archive.

This field is optional.

": "{Decimal}",
14
               "length
Length

Length of this package. Measurement unit is configured in the location arhive

This field is optional.

": "{Decimal}",
15
               "width
Width

Width of this package. Measurement unit is specified in location archive.

This field is optional.

": "{Decimal}",
16
               "volume
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.

This field is optional.

": "{Decimal}"
17
          }
18
     }
19
}

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.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

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.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Package>
2
     <PackageId
PackageId

Package identifier

>{Integer}</PackageId>
3
     <Weight
Weight

Weight of this package. Measurement unit is specified in the location arthive

>{Decimal}</Weight>
4
     <Comment
Comment

Comment for this package

>{String}</Comment>
5
     <Tracking>
6
          <TrackingNumber
TrackingNumber

Tracking number for this package

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

Three character code following the ISO 4217 standard

>{String}</Currency>
11
          <NetPrice
NetPrice

The freigth price for this package

>{Decimal}</NetPrice>
12
          <Cost
Cost

Freight costs of this package

>{Decimal}</Cost>
13
     </Freight>
14
     <Dimensions>
15
          <Height
Height

Height of this package. Measurement unit is configured in the location archive.

>{Decimal}</Height>
16
          <Length
Length

Length of this package. Measurement unit is configured in the location arhive

>{Decimal}</Length>
17
          <Width
Width

Width of this package. Measurement unit is specified in location archive.

>{Decimal}</Width>
18
          <Volume
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>
19
     </Dimensions>
20
</Package>
1
{
2
     "package": {
3
          "packageId
PackageId

Package identifier

": "{Integer}",
4
          "weight
Weight

Weight of this package. Measurement unit is specified in the location arthive

": "{Decimal}",
5
          "comment
Comment

Comment for this package

": "{String}",
6
          "tracking": {
7
               "trackingNumber
TrackingNumber

Tracking number for this package

": "{String}",
8
               "trackingUri
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}"
9
          },
10
          "freight": {
11
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
12
               "netPrice
NetPrice

The freigth price for this package

": "{Decimal}",
13
               "cost
Cost

Freight costs of this package

": "{Decimal}"
14
          },
15
          "dimensions": {
16
               "height
Height

Height of this package. Measurement unit is configured in the location archive.

": "{Decimal}",
17
               "length
Length

Length of this package. Measurement unit is configured in the location arhive

": "{Decimal}",
18
               "width
Width

Width of this package. Measurement unit is specified in location archive.

": "{Decimal}",
19
               "volume
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}"
20
          }
21
     }
22
}

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 100027 HTTP 400 Missing mandatory parameter {0}
Error 101420 HTTP 404 Setting definition not found
Error 101686 HTTP 400 End of tracking number series has been reached