Logistics APIs
Create new arriving waybill
| HTTP method | POST |
| URI | https://api.rambase.net/logistics/arriving-waybills |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 3618, 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.
CarrierId
Required/mandatory field
Carrier identifier
Minimum value: 1000
>{Integer}</CarrierId>Tracking
This field is optional.
>TrackingNumber
Tracking number for this arriving waybill
This field is optional.
>{String}</TrackingNumber>Sender
The sender of the arriving waybill. Can be a customer or a supplier.
This field is optional.
>ObjectId
Identifier of the object
This field is optional.
>{Integer}</ObjectId>ObjectType
Type of object
This field is optional.
>{String}</ObjectType>CarrierId
Required/mandatory field
Carrier identifier
Minimum value: 1000
": "{Integer}"Tracking
This field is optional.
": {TrackingNumber
Tracking number for this arriving waybill
This field is optional.
": "{String}"Sender
The sender of the arriving waybill. Can be a customer or a supplier.
This field is optional.
": {ObjectId
Identifier of the object
This field is optional.
": "{Integer}",ObjectType
Type of object
This field is optional.
": "{String}"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. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $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.
ArrivingWaybillId
Arriving waybill identifier
>{Integer}</ArrivingWaybillId>Note
Note or remark for this arriving waybill
>{String}</Note>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>RegistrationDate
Date of the arrival og the shipment
>{Date}</RegistrationDate>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
Possible domain values can be found here
>{String}</WeightUnit>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
Possible domain values can be found here
>{String}</LengthUnit>StockLocation
Stock location where a consignment belonging to an arriving waybill is temporary stored before is unpacked and goods receptions are created.
>StockLocationId
Stock location identifier
>{Integer}</StockLocationId>Label
Name of current- and parent stock locations, including seperator for location
>{String}</Label>StockLocationLink
Stock location identifier
>{String}</StockLocationLink>CreatedBy
The user that created this object
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>CarrierId
Carrier identifier
>{Integer}</CarrierId>Name
Name of carrier
>{String}</Name>CarrierLink
Carrier reference
>{String}</CarrierLink>TrackingNumber
Tracking number for this arriving waybill
>{String}</TrackingNumber>Sender
The sender of the arriving waybill. Can be a customer or a supplier.
>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>Name
Name retrieved from the object
>{String}</Name>ObjectLink
API reference to the object
>{String}</ObjectLink>LocationId
Location identifier
>{Integer}</LocationId>Name
Name of location
>{String}</Name>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>AddressId
Location address identifier
>{Integer}</AddressId>LocationLink
Location reference
>{String}</LocationLink>Packages
Number of packages belonging to this arriving waybill
>{Integer}</Packages>Weight
The gross weight of the consignment this arriving waybill presents
>{Decimal}</Weight>Length
The length of the consignment
>{Decimal}</Length>Width
The width of the consignment
>{Decimal}</Width>Height
The height of the consignment
>{Decimal}</Height>Volume
The volume of the consignment. Is calculated from lenght, width and height - but can be overridden by the user.
>{Decimal}</Volume>Area
The area an incoming consignment will use. This is calculated from length and width, but can be overridden by the user.
>{Decimal}</Area>EstimatedDepartureAt
This is a date which is supplied by the vendor and is the day they expect to ship this consignment
>{Datetime}</EstimatedDepartureAt>ActualDepartureAt
This is a date which is supplied by the vendor or the forwarder, and is the day the consignment is handed over to forwarder.
>{Datetime}</ActualDepartureAt>EstimatedArrivalAt
This is a date which is supplied by the vendor or the forwarder, and is the day the consignment is estimated to arrive at warehouse
>{Datetime}</EstimatedArrivalAt>ActualArrivalAt
This is the actual time of when the consignment were received at the warehouse, and will be auatomatically set when the WBI is changed to ST:3
>{Datetime}</ActualArrivalAt>ReportDate
Date when this arriving waybill were printed on the goods journal
>{Date}</ReportDate>ShipFromCountryCode
Two-character code (ISO 3166) identifying the country this consignment was shipped from.
>{String}</ShipFromCountryCode>ShipToCountryCode
Two-character code (ISO 3166) identifying the country where this consignment is received
>{String}</ShipToCountryCode>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.
Possible domain values can be found here
>{String}</TransportMethod>ImportDeclarationId
Import declaration identifier. Customs authorites sequal number for import declaration of goods that have been a part of bonded warehouse.
>{String}</ImportDeclarationId>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.
>{String}</CarriersGoodsNumber>WarehouseOwnersGoodsNumber
Warehouse owners goods number for bonded warehouse. Consist of 'year + bonded warehouse code +location code + day number (day of the year) + number of consignment today '. Is sent to carrier to confirm that goods have been received to bonded warehouse.
>{String}</WarehouseOwnersGoodsNumber>EmployeeId
Employee identifier
>{Integer}</EmployeeId>FirstName
First name of employee
>{String}</FirstName>LastName
Last name of employee
>{String}</LastName>EmployeeLink
Employee reference
>{String}</EmployeeLink>ArrivingWaybillId
Arriving waybill identifier
": "{Integer}",Status
Status of arriving waybill
Possible domain values can be found here
": "{Integer}",Note
Note or remark for this arriving waybill
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",RegistrationDate
Date of the arrival og the shipment
": "{Date}",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
Possible domain values can be found here
": "{String}",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
Possible domain values can be found here
": "{String}",StockLocation
Stock location where a consignment belonging to an arriving waybill is temporary stored before is unpacked and goods receptions are created.
": {StockLocationId
Stock location identifier
": "{Integer}",Label
Name of current- and parent stock locations, including seperator for location
": "{String}",StockLocationLink
Stock location identifier
": "{String}"CreatedBy
The user that created this object
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"CarrierId
Carrier identifier
": "{Integer}",Name
Name of carrier
": "{String}",CarrierLink
Carrier reference
": "{String}"TrackingNumber
Tracking number for this arriving waybill
": "{String}"Sender
The sender of the arriving waybill. Can be a customer or a supplier.
": {ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",Name
Name retrieved from the object
": "{String}",ObjectLink
API reference to the object
": "{String}"LocationId
Location identifier
": "{Integer}",Name
Name of location
": "{String}",ShortName
Unique abbreviation/short name of the location
": "{String}",AddressId
Location address identifier
": "{Integer}"LocationLink
Location reference
": "{String}"Packages
Number of packages belonging to this arriving waybill
": "{Integer}",Weight
The gross weight of the consignment this arriving waybill presents
": "{Decimal}",Length
The length of the consignment
": "{Decimal}",Width
The width of the consignment
": "{Decimal}",Height
The height of the consignment
": "{Decimal}",Volume
The volume of the consignment. Is calculated from lenght, width and height - but can be overridden by the user.
": "{Decimal}",Area
The area an incoming consignment will use. This is calculated from length and width, but can be overridden by the user.
": "{Decimal}"EstimatedDepartureAt
This is a date which is supplied by the vendor and is the day they expect to ship this consignment
": "{Datetime}",ActualDepartureAt
This is a date which is supplied by the vendor or the forwarder, and is the day the consignment is handed over to forwarder.
": "{Datetime}"EstimatedArrivalAt
This is a date which is supplied by the vendor or the forwarder, and is the day the consignment is estimated to arrive at warehouse
": "{Datetime}",ActualArrivalAt
This is the actual time of when the consignment were received at the warehouse, and will be auatomatically set when the WBI is changed to ST:3
": "{Datetime}"ReportDate
Date when this arriving waybill were printed on the goods journal
": "{Date}",ShipFromCountryCode
Two-character code (ISO 3166) identifying the country this consignment was shipped from.
": "{String}",ShipToCountryCode
Two-character code (ISO 3166) identifying the country where this consignment is received
": "{String}",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.
Possible domain values can be found here
": "{String}",ImportDeclarationId
Import declaration identifier. Customs authorites sequal number for import declaration of goods that have been a part of bonded warehouse.
": "{String}",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.
": "{String}",WarehouseOwnersGoodsNumber
Warehouse owners goods number for bonded warehouse. Consist of 'year + bonded warehouse code +location code + day number (day of the year) + number of consignment today '. Is sent to carrier to confirm that goods have been received to bonded warehouse.
": "{String}"EmployeeId
Employee identifier
": "{Integer}",FirstName
First name of employee
": "{String}",LastName
Last name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"
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) |
| Error 109268 HTTP 400 | Shipping address can't be updated when there are SOAITEMs pending goods reception linked to the WBI |
| Error 109269 HTTP 400 | Shipping address can't be updated when there are goods receptions linked to the WBI |