Logistics APIs
List of all shipments
| HTTP method | GET |
| URI | https://api.rambase.net/logistics/shipments |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 2445, version 12 |
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.
| InQueue() Named filter | All shipments pending shipping |
| ShippedToday() Named filter | Shipments shipped today |
| CarrierId Integer | Carrier identifier. |
| ContentType String | Type of content. |
| FirstName String | First name of the customer/supplier. |
| LocationShortName String | Unique abbreviation/short name of the location. |
| Name String | Name of the customer/supplier, or last name if it is a person.. |
| Priority Integer | Priority of the shipment. |
| ShippingServiceId Integer | Shipping service identifier. |
| ShippingServiceName String | Name of shipping service. |
| Status Integer | Status of shipment. |
Read more about filters and sorting on how to use sortable parameters
| CarrierId Integer | Carrier identifier |
| FirstName String | First name of the customer/supplier |
| LocationShortName String | Unique abbreviation/short name of the location |
| Name String | Name of the customer/supplier, or last name if it is a person. |
| Priority Integer | Priority of the shipment |
| ShippingServiceId Integer | Shipping service identifier |
| ShippingServiceName String | Name of shipping service |
| Status Integer | Status of shipment |
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.
Database
Company code/database the object belongs to
>{String}</Database>ShipmentId
Shipment identifier
>{Long}</ShipmentId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>ContentType
Type of content
Possible domain values can be found here
>{String}</ContentType>ShippingDate
Date of which the shipment is ready/prepared to be shipped. Note that this may not be the date the shipment physically left the warehouse. Departing waybill holds this date.
>{Date}</ShippingDate>Priority
Priority of the shipment
Possible domain values can be found here
>{Integer}</Priority>Weight
Total weight in weightunit
>{Decimal}</Weight>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>Name
Name of the customer/supplier, or last name if it is a person.
>{String}</Name>FirstName
First name of the customer/supplier
>{String}</FirstName>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ObjectLink
API reference to the object
>{String}</ObjectLink>ShippingServiceId
Shipping service identifier
>{Integer}</ShippingServiceId>Name
Name of shipping service
>{String}</Name>CarrierId
Carrier identifier
>{Integer}</CarrierId>Name
Name of carrier
>{String}</Name>CarrierLink
Carrier reference
>{String}</CarrierLink>ShippingServiceLink
Shipping service reference
>{String}</ShippingServiceLink>DepartingWaybillId
Departing waybill identifier
>{Integer}</DepartingWaybillId>DepartingWaybillLink
Departing waybill reference
>{String}</DepartingWaybillLink>ShipmentLink
Shipment reference
>{String}</ShipmentLink>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>Database
Company code/database the object belongs to
": "{String}",ShipmentId
Shipment identifier
": "{Long}",CreatedAt
Date and time of creation
": "{Datetime}",Status
Status of shipment
Possible domain values can be found here
": "{Integer}",ContentType
Type of content
Possible domain values can be found here
": "{String}",ShippingDate
Date of which the shipment is ready/prepared to be shipped. Note that this may not be the date the shipment physically left the warehouse. Departing waybill holds this date.
": "{Date}",Priority
Priority of the shipment
Possible domain values can be found here
": "{Integer}",Weight
Total weight in weightunit
": "{Decimal}",ShortName
Unique abbreviation/short name of the location
": "{String}"ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",Name
Name of the customer/supplier, or last name if it is a person.
": "{String}",FirstName
First name of the customer/supplier
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",ObjectLink
API reference to the object
": "{String}"ShippingServiceId
Shipping service identifier
": "{Integer}",Name
Name of shipping service
": "{String}",CarrierId
Carrier identifier
": "{Integer}",Name
Name of carrier
": "{String}",CarrierLink
Carrier reference
": "{String}"ShippingServiceLink
Shipping service reference
": "{String}"DepartingWaybillId
Departing waybill identifier
": "{Integer}",DepartingWaybillLink
Departing waybill reference
": "{String}"ShipmentLink
Shipment 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 101013 HTTP 404 | Sub-module not found |
| Error 102018 HTTP 403 | You need permission {0}. Duties with this permission: {1} |