Logistics APIs
List of arriving waybills
| HTTP method | GET |
| URI | https://api.rambase.net/logistics/arriving-waybills |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 528, version 33 |
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.
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.
| $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] |
| $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 |
| $expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
| $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. |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
| $pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
| $filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
| $orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
| $inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
| MyArrivingWaybills() Named filter | Arriving waybills created by the current user. |
| MyOpenWaybills() Named filter | Open arriving waybills created by the current user. |
| NotProcessed() Named filter | Arriving waybills that are not processed |
| WaitingForCustoms() Named filter | Arriving waybills waiting for customs documents. |
| ActualArrivalAt Datetime | 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. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| ActualDepartureAt Datetime | This is a date which is supplied by the vendor or the forwarder, and is the day the consignment is handed over to forwarder. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| ArrivingWaybillId Integer | Arriving waybill identifier. |
| CarrierName String | Name of carrier. |
| CreatedById Integer | The user that created this object. Available macros: currentUser() |
| EstimatedArrivalAt Datetime | 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. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| EstimatedDepartureAt Datetime | This is a date which is supplied by the vendor and is the day they expect to ship this consignment. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| ImportDeclarationId String | Import declaration identifier. Customs authorites sequal number for import declaration of goods that have been a part of bonded warehouse. |
| LocationShortName String | Unique abbreviation/short name of the location. |
| Name String | Name of supplier (name of company or surname/familyname/lastname of a person). |
| ResponsibleId Integer | Employee identifier. Available macros: currentUser() |
| Status Integer | Status of arriving waybill. |
| TrackingNumber String | Tracking number for this arriving waybill. |
Read more about filters and sorting on how to use sortable parameters
| ActualArrivalAt Datetime | 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 |
| ActualDepartureAt Datetime | This is a date which is supplied by the vendor or the forwarder, and is the day the consignment is handed over to forwarder. |
| ArrivingWaybillId Integer | Arriving waybill identifier |
| CarrierName String | Name of carrier |
| CreatedById Integer | The user that created this object |
| EstimatedArrivalAt Datetime | 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 |
| EstimatedDepartureAt Datetime | This is a date which is supplied by the vendor and is the day they expect to ship this consignment |
| ImportDeclarationId String | Import declaration identifier. Customs authorites sequal number for import declaration of goods that have been a part of bonded warehouse. |
| LocationShortName String | Unique abbreviation/short name of the location |
| ResponsibleId Integer | Employee identifier |
| Status Integer | Status of arriving waybill |
| TrackingNumber String | Tracking number for this arriving waybill |
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.
ArrivingWaybillId
Arriving waybill identifier
>{Integer}</ArrivingWaybillId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>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>LocationLink
Location reference
>{String}</LocationLink>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>ArrivingWaybillLink
Arriving waybill reference
>{String}</ArrivingWaybillLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>ArrivingWaybillId
Arriving waybill identifier
": "{Integer}",Status
Status of arriving waybill
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",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}",LocationLink
Location reference
": "{String}"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}"ArrivingWaybillLink
Arriving waybill reference
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 101814 HTTP 404 | Employee not found |