Logistics APIs
List of goods transfers
HTTP method | GET |
URI | https://api.rambase.net/logistics/goods-transfers |
Supported formats | Xml, Html, Json (ex. $format=json) |
Maximum page size ($top) | 80 |
Successful HTTP status code | 200 |
API resource identifier | 594, version 17 |
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.
InfoNotification() Named filter | Goods transfers with notifications of category I (Information) |
InTransfer() Named filter | Goods transfers in transfer (status 4). |
MyGoodsTransfers() Named filter | Goods transfers assigned to the current user |
PendingPickingQueue() Named filter | Goods transfers in pending to be added to picking queue (status 0 or status 2). |
PendingShipping() Named filter | Goods transfers pending shipping (status 3). |
Assignee Integer | The user who has been assigned to work with this object. Available macros: currentUser() |
ContainingNotificationTypeId Integer | Notification type identifier. |
CreatedAt Datetime | Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
Currency String | Three character code following the ISO 4217 standard. |
DeliveryTermPlace String | A named place, which, together with the content of Delivery terms, determines where and when the costs, responsibility and risk for a shipment are transferred from the seller to the buye. |
DeliveryTerms String | Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).. |
GoodsReceptionId Integer | Goods reception identifier. |
GoodsTransferId Integer | Goods transfer identifier. |
ManufacturerId Integer | Manufacturer identifier. |
ManufacturerShortName String | Shortname/code of the manufacturer. |
ProductId Integer | Product identifier. |
ProductName String | Name of the product. |
ProductType String | Type of product. |
Quantity Decimal | Quantity to be transferred. |
ShippingDate Date | Date of shipment departure. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
ShippingServiceId Integer | Shipping service identifier. |
Status Integer | Status of goods transfer. |
TransferFromShortName String | Unique abbreviation/short name of the location. |
Read more about filters and sorting on how to use sortable parameters
Assignee Integer | The user who has been assigned to work with this object. |
ContainingNotificationTypeId Integer | Notification type identifier |
CreatedAt Datetime | Date and time of creation |
Currency String | Three character code following the ISO 4217 standard |
DeliveryTermPlace String | A named place, which, together with the content of Delivery terms, determines where and when the costs, responsibility and risk for a shipment are transferred from the seller to the buye |
DeliveryTerms String | Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). |
GoodsReceptionId Integer | Goods reception identifier |
GoodsTransferId Integer | Goods transfer identifier |
ManufacturerId Integer | Manufacturer identifier |
ManufacturerShortName String | Shortname/code of the manufacturer |
ProductId Integer | Product identifier |
ProductName String | Name of the product |
ProductType String | Type of product |
Quantity Decimal | Quantity to be transferred |
ShippingDate Date | Date of shipment departure |
ShippingServiceId Integer | Shipping service identifier |
Status Integer | Status of goods transfer |
TransferFromShortName String | Unique abbreviation/short name of the location |
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.
GoodsTransferId
Goods transfer identifier
>{Integer}</GoodsTransferId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Quantity
Quantity to be transferred
>{Decimal}</Quantity>ShippingDate
Date of shipment departure
>{Date}</ShippingDate>LocationId
Location identifier
>{Integer}</LocationId>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>LocationLink
Location reference
>{String}</LocationLink>LocationId
Location identifier
>{Integer}</LocationId>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>LocationLink
Location reference
>{String}</LocationLink>GoodsReceptionItemId
Item-/line-number of the goods reception
>{Integer}</GoodsReceptionItemId>ProductDescription
Description of the product, it's by default copied from product
>{String}</ProductDescription>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>NetPrice
Final price per unit after deducting all discounts etc.
>{Decimal}</NetPrice>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>ManufacturerId
Manufacturer identifier
>{Integer}</ManufacturerId>ShortName
Shortname/code of the manufacturer
>{String}</ShortName>ManufacturerLink
Manufacturer reference
>{String}</ManufacturerLink>GoodsReceptionItemLink
Goods reception item reference
>{String}</GoodsReceptionItemLink>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>NetAmount
Final item amount after deducting all discounts etc.
>{Decimal}</NetAmount>GoodsTransferLink
Goods transfer reference
>{String}</GoodsTransferLink>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>GoodsTransferId
Goods transfer identifier
": "{Integer}",Status
Status of goods transfer
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Quantity
Quantity to be transferred
": "{Decimal}",ShippingDate
Date of shipment departure
": "{Date}",LocationId
Location identifier
": "{Integer}",ShortName
Unique abbreviation/short name of the location
": "{String}",LocationLink
Location reference
": "{String}"LocationId
Location identifier
": "{Integer}",ShortName
Unique abbreviation/short name of the location
": "{String}",LocationLink
Location reference
": "{String}"GoodsReceptionItemId
Item-/line-number of the goods reception
": "{Integer}",ProductDescription
Description of the product, it's by default copied from product
": "{String}",Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",NetPrice
Final price per unit after deducting all discounts etc.
": "{Decimal}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",ProductLink
Product reference
": "{String}"ManufacturerId
Manufacturer identifier
": "{Integer}",ShortName
Shortname/code of the manufacturer
": "{String}",ManufacturerLink
Manufacturer reference
": "{String}"GoodsReceptionItemLink
Goods reception item reference
": "{String}"Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",NetAmount
Final item amount after deducting all discounts etc.
": "{Decimal}"GoodsTransferLink
Goods transfer 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 100147 HTTP 404 | Notification type not found |
Error 100053 HTTP 403 | You have only admittance to your own suppliers |