API

Logistics APIs

PUT logistics/departing-waybills/{departingWaybillId}

Updates a departing waybill

HTTP method PUT
URI https://api.rambase.net/logistics/departing-waybills/{departingWaybillId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {departingWaybillId} Departing waybill identifier
Integer, minimum 10000
Successful HTTP status code 200
API resource identifier 3645, version 3

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

This field is optional.

>
2
     <Note
Note

Note or remark for this departing waybill

This field is optional.

>
{String}</Note>
3
     <Totals
Totals

This field is optional.

>
4
          <Packages
Packages

Accumulated number of packages from the shipments that are assigned to this departing waybill.

Minimum value: 0

This field is optional.

>
{Integer}</Packages>
5
          <Weight
Weight

Accumulated gross weight from the shipments that are assigned to this departing waybill

Minimum value: 0

This field is optional.

>
{Decimal}</Weight>
6
     </Totals>
7
</DepartingWaybill>
1
{
2
     "departingWaybill
DepartingWaybill

This field is optional.

":
{
3
          "note
Note

Note or remark for this departing waybill

This field is optional.

":
"{String}",
4
          "totals
Totals

This field is optional.

":
{
5
               "packages
Packages

Accumulated number of packages from the shipments that are assigned to this departing waybill.

Minimum value: 0

This field is optional.

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

Accumulated gross weight from the shipments that are assigned to this departing waybill

Minimum value: 0

This field is optional.

":
"{Decimal}"
7
          }
8
     }
9
}

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 100027 HTTP 400 Missing mandatory parameter {0}
Error 101079 HTTP 400 Mismatch in size of revision parameters