Logistics APIs

PUT logistics/shipments/{shipmentId}/packages/{packageId}

Update provided package of shipment

HTTP method	PUT
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	2734, version 9

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:

<Package

Package

This field is optional.

<Weight

Weight

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

This field is optional.

>{Decimal}</Weight>

<Comment

Comment

Comment for this package

This field is optional.

>{String}</Comment>

<Tracking

Tracking

This field is optional.

<TrackingNumber

TrackingNumber

Tracking number for this package

This field is optional.

>{String}</TrackingNumber>

<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

This field is optional.

>{String}</TrackingUri>

                                             </Tracking>
                                    

<Freight

Freight

This field is optional.

<NetPrice

NetPrice

The freigth price for this package

This field is optional.

>{Decimal}</NetPrice>

<Cost

Cost

Freight costs of this package

This field is optional.

>{Decimal}</Cost>

                                             </Freight>
                                    

<Dimensions

Dimensions

This field is optional.

<Height

Height

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

This field is optional.

>{Decimal}</Height>

<Length

Length

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

This field is optional.

>{Decimal}</Length>

<Width

Width

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

This field is optional.

>{Decimal}</Width>

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

                                             </Dimensions>
                                    

                                        </Package>
                                    

{

"package

Package

This field is optional.

": {

"weight

Weight

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

This field is optional.

": "{Decimal}",

"comment

Comment

Comment for this package

This field is optional.

": "{String}",

"tracking

Tracking

This field is optional.

": {

"trackingNumber

TrackingNumber

Tracking number for this package

This field is optional.

": "{String}",

"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

This field is optional.

": "{String}"

},

"freight

Freight

This field is optional.

": {

"netPrice

NetPrice

The freigth price for this package

This field is optional.

": "{Decimal}",

"cost

Cost

Freight costs of this package

This field is optional.

": "{Decimal}"

},

"dimensions

Dimensions

This field is optional.

": {

"height

Height

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

This field is optional.

": "{Decimal}",

"length

Length

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

This field is optional.

": "{Decimal}",

"width

Width

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

This field is optional.

": "{Decimal}",

"volume

Volume

This field is optional.

": "{Decimal}"

}

}

}

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:

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