API

Logistics APIs

PUT logistics/arriving-waybills/{arrivingWaybillId}

Updates an arriving waybill

HTTP method PUT
URI https://api.rambase.net/logistics/arriving-waybills/{arrivingWaybillId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {arrivingWaybillId} Arriving waybill identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 3612, version 14

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

This field is optional.

>
2
     <Note
Note

Note or remark for this arriving waybill

This field is optional.

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

Unit used for measuring weight on the consignment in this arriving waybill. Will default to weightmeasureunit from location, but can be overwritten in each arriving waybill

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. Will default to lengthunit from location, but can be overwritten in each arriving waybill

Applicable domain values can be found here

This field is optional.

>{String}</LengthUnit>
5
     <Carrier
Carrier

This field is optional.

>
6
          <CarrierId
CarrierId

Carrier identifier

Minimum value: 1000

This field is optional.

>{Integer}</CarrierId>
7
     </Carrier>
8
     <Tracking
Tracking

This field is optional.

>
9
          <TrackingNumber
TrackingNumber

Tracking number for this arriving waybill

This field is optional.

>{String}</TrackingNumber>
10
     </Tracking>
11
     <Sender
Sender

The sender of the arriving waybill. Can be a customer or a supplier.

This field is optional.

>
12
          <ObjectId
ObjectId

Identifier of the object

This field is optional.

>{Integer}</ObjectId>
13
          <ObjectType
ObjectType

Type of object

This field is optional.

>{String}</ObjectType>
14
     </Sender>
15
     <Location
Location

This field is optional.

>
16
          <LocationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

>{Integer}</LocationId>
17
     </Location>
18
     <Totals
Totals

This field is optional.

>
19
          <Packages
Packages

Number of packages belonging to this arriving waybill

This field is optional.

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

The gross weight of the consignment this arriving waybill presents

This field is optional.

>{Decimal}</Weight>
21
          <Length
Length

The length of the consignment

This field is optional.

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

The width of the consignment

This field is optional.

>{Decimal}</Width>
23
          <Height
Height

The height of the consignment

This field is optional.

>{Decimal}</Height>
24
          <Volume
Volume

The volume of the consignment. Is calculated from lenght, width and height - but can be overridden by the user.

This field is optional.

>{Decimal}</Volume>
25
          <Area
Area

The area an incoming consignment will use. This is calculated from length and width, but can be overridden by the user.

This field is optional.

>{Decimal}</Area>
26
     </Totals>
27
     <Customs
Customs

This field is optional.

>
28
          <ShipFromCountryCode
ShipFromCountryCode

Two-character code (ISO 3166) identifying the country this consignment was shipped from.

This field is optional.

>{String}</ShipFromCountryCode>
29
          <ShipToCountryCode
ShipToCountryCode

Two-character code (ISO 3166) identifying the country where this consignment is received

This field is optional.

>{String}</ShipToCountryCode>
30
          <TransportMethod
TransportMethod

A code for which transport (vehicle, aircraft, or ship) that was used when the goods were crossing the border - i.e. plane, train, car, car on ferry and so on.

Applicable domain values can be found here

This field is optional.

>{String}</TransportMethod>
31
          <ImportDeclarationId
ImportDeclarationId

Import declaration identifier. Customs authorites sequal number for import declaration of goods that have been a part of bonded warehouse.

This field is optional.

>{String}</ImportDeclarationId>
32
          <BondedWarehouse
BondedWarehouse

This field is optional.

>
33
               <CarriersGoodsNumber
CarriersGoodsNumber

Carriers goods number for bonded warehouse. This allow the carrier to transport this goods domestic, -from the border to the owner of a bonded warehouse.

This field is optional.

>{String}</CarriersGoodsNumber>
34
          </BondedWarehouse>
35
     </Customs>
36
</ArrivingWaybill>
1
{
2
     "arrivingWaybill
ArrivingWaybill

This field is optional.

": {
3
          "note
Note

Note or remark for this arriving waybill

This field is optional.

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

Unit used for measuring weight on the consignment in this arriving waybill. Will default to weightmeasureunit from location, but can be overwritten in each arriving waybill

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. Will default to lengthunit from location, but can be overwritten in each arriving waybill

Applicable domain values can be found here

This field is optional.

": "{String}",
6
          "carrier
Carrier

This field is optional.

": {
7
               "carrierId
CarrierId

Carrier identifier

Minimum value: 1000

This field is optional.

": "{Integer}"
8
          },
9
          "tracking
Tracking

This field is optional.

": {
10
               "trackingNumber
TrackingNumber

Tracking number for this arriving waybill

This field is optional.

": "{String}"
11
          },
12
          "sender
Sender

The sender of the arriving waybill. Can be a customer or a supplier.

This field is optional.

": {
13
               "objectId
ObjectId

Identifier of the object

This field is optional.

": "{Integer}",
14
               "objectType
ObjectType

Type of object

This field is optional.

": "{String}"
15
          },
16
          "location
Location

This field is optional.

": {
17
               "locationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
18
          },
19
          "totals
Totals

This field is optional.

": {
20
               "packages
Packages

Number of packages belonging to this arriving waybill

This field is optional.

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

The gross weight of the consignment this arriving waybill presents

This field is optional.

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

The length of the consignment

This field is optional.

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

The width of the consignment

This field is optional.

": "{Decimal}",
24
               "height
Height

The height of the consignment

This field is optional.

": "{Decimal}",
25
               "volume
Volume

The volume of the consignment. Is calculated from lenght, width and height - but can be overridden by the user.

This field is optional.

": "{Decimal}",
26
               "area
Area

The area an incoming consignment will use. This is calculated from length and width, but can be overridden by the user.

This field is optional.

": "{Decimal}"
27
          },
28
          "customs
Customs

This field is optional.

": {
29
               "shipFromCountryCode
ShipFromCountryCode

Two-character code (ISO 3166) identifying the country this consignment was shipped from.

This field is optional.

": "{String}",
30
               "shipToCountryCode
ShipToCountryCode

Two-character code (ISO 3166) identifying the country where this consignment is received

This field is optional.

": "{String}",
31
               "transportMethod
TransportMethod

A code for which transport (vehicle, aircraft, or ship) that was used when the goods were crossing the border - i.e. plane, train, car, car on ferry and so on.

Applicable domain values can be found here

This field is optional.

": "{String}",
32
               "importDeclarationId
ImportDeclarationId

Import declaration identifier. Customs authorites sequal number for import declaration of goods that have been a part of bonded warehouse.

This field is optional.

": "{String}",
33
               "bondedWarehouse
BondedWarehouse

This field is optional.

": {
34
                    "carriersGoodsNumber
CarriersGoodsNumber

Carriers goods number for bonded warehouse. This allow the carrier to transport this goods domestic, -from the border to the owner of a bonded warehouse.

This field is optional.

": "{String}"
35
               }
36
          }
37
     }
38
}

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 101015 HTTP 404 Permission not found
Error 100141 HTTP 404 Country not found
Error 104869 HTTP 404 Default account not found
Error 104500 HTTP 400 Carrier need to be active (status 4)