API

Logistics APIs

GET logistics/locations/{locationId}/location-supplies

Returns the full list of location-supplies for the given location.

HTTP method GET
URI https://api.rambase.net/logistics/locations/{locationId}/location-supplies
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {locationId} Location identifier
Integer, minimum 10000
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 7133, version 15

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
1

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.

Active() Named filter Active location
CustomerId Integer Customer identifier.
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
HandlingDays Integer Internal handling time. The number of days required by the source location, from when a distribution order is received until it is ready for shipment.
SourceCompanyId Integer Company identifier.
SourceLocationId Integer Location identifier.
Status Integer Status of distribution sourcing rule.
SupplierId Integer RamBase supplier identifier.
SupplierName String Name of supplier (name of company or surname/familyname/lastname of a person).
TransitDays Integer Transit time. The number of days a shipment takes to move from the source location to the destination location.

Read more about filters and sorting on how to use sortable parameters

CustomerId Integer Customer identifier
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
HandlingDays Integer Internal handling time. The number of days required by the source location, from when a distribution order is received until it is ready for shipment.
SourceCompanyId Integer Company identifier
SourceLocationId Integer Location identifier
Status Integer Status of distribution sourcing rule
SupplierId Integer RamBase supplier identifier
SupplierName String Name of supplier (name of company or surname/familyname/lastname of a person)
TransitDays Integer Transit time. The number of days a shipment takes to move from the source location to the destination 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.

Format:
1
<LocationSupplies>
2
     <LocationSupply>
3
          <LocationSupplyId
LocationSupplyId

Location supply identifier

>{Integer}</LocationSupplyId>
4
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
          <UpdatedAt
UpdatedAt

Date and time when intercompany-relationship was updated

>{Datetime}</UpdatedAt>
6
          <Status
Status

Status of distribution sourcing rule

Possible domain values can be found here

>{Integer}</Status>
7
          <IsBiDirectional
IsBiDirectional

Bidirectional connection. Indicates whether distribution orders can be created in both directions between the locations. If true, orders can be created from either location to the other. If false, orders can only be created from this location to the source location.

>{Boolean}</IsBiDirectional>
8
          <Source>
9
               <Location>
10
                    <LocationId
LocationId

Location identifier

>{Integer}</LocationId>
11
                    <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
12
                    <Name
Name

Name of warehouse location

>{String}</Name>
13
                    <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
14
               </Location>
15
               <Company>
16
                    <CompanyId
CompanyId

Company identifier

>{Integer}</CompanyId>
17
                    <Name
Name

Name of company

>{String}</Name>
18
                    <Database
Database

Abbreviation/code to identify the company

>{String}</Database>
19
                    <CompanyLink
CompanyLink

Company reference

>{String}</CompanyLink>
20
               </Company>
21
          </Source>
22
          <Supplier
Supplier

The supplier that will be used when creating distribution orders towards this source location

>
23
               <SupplierId
SupplierId

RamBase supplier identifier

>{Integer}</SupplierId>
24
               <Name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

>{String}</Name>
25
               <SupplierLink
SupplierLink

Supplier reference

>{String}</SupplierLink>
26
          </Supplier>
27
          <Customer
Customer

The customer that will be used for receiving distribution orders

>
28
               <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
29
               <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>{String}</Name>
30
               <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
31
          </Customer>
32
          <TransferLeadTime>
33
               <HandlingDays
HandlingDays

Internal handling time. The number of days required by the source location, from when a distribution order is received until it is ready for shipment.

>{Integer}</HandlingDays>
34
               <TransitDays
TransitDays

Transit time. The number of days a shipment takes to move from the source location to the destination location.

>{Integer}</TransitDays>
35
          </TransferLeadTime>
36
          <LocationSupplyLink
LocationSupplyLink

Intercompany relationship reference

>{String}</LocationSupplyLink>
37
     </LocationSupply>
38
     <Paging
Paging

Detailed paging information for this list.

>
39
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
40
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
41
          <Page
Page

Page index

>{Integer}</Page>
42
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
43
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
44
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
45
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
46
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
47
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
48
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
49
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
50
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
51
     </Paging>
52
</LocationSupplies>
1
{
2
     "locationSupplies": [
3
          {
4
               "locationSupplyId
LocationSupplyId

Location supply identifier

": "{Integer}",
5
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
               "updatedAt
UpdatedAt

Date and time when intercompany-relationship was updated

": "{Datetime}",
7
               "status
Status

Status of distribution sourcing rule

Possible domain values can be found here

": "{Integer}",
8
               "isBiDirectional
IsBiDirectional

Bidirectional connection. Indicates whether distribution orders can be created in both directions between the locations. If true, orders can be created from either location to the other. If false, orders can only be created from this location to the source location.

": "{Boolean}",
9
               "source": {
10
                    "location": {
11
                         "locationId
LocationId

Location identifier

": "{Integer}",
12
                         "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}",
13
                         "name
Name

Name of warehouse location

": "{String}",
14
                         "locationLink
LocationLink

Location reference

": "{String}"
15
                    },
16
                    "company": {
17
                         "companyId
CompanyId

Company identifier

": "{Integer}",
18
                         "name
Name

Name of company

": "{String}",
19
                         "database
Database

Abbreviation/code to identify the company

": "{String}",
20
                         "companyLink
CompanyLink

Company reference

": "{String}"
21
                    }
22
               },
23
               "supplier
Supplier

The supplier that will be used when creating distribution orders towards this source location

": {
24
                    "supplierId
SupplierId

RamBase supplier identifier

": "{Integer}",
25
                    "name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

": "{String}",
26
                    "supplierLink
SupplierLink

Supplier reference

": "{String}"
27
               },
28
               "customer
Customer

The customer that will be used for receiving distribution orders

": {
29
                    "customerId
CustomerId

Customer identifier

": "{Integer}",
30
                    "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

": "{String}",
31
                    "customerLink
CustomerLink

Customer reference

": "{String}"
32
               },
33
               "transferLeadTime": {
34
                    "handlingDays
HandlingDays

Internal handling time. The number of days required by the source location, from when a distribution order is received until it is ready for shipment.

": "{Integer}",
35
                    "transitDays
TransitDays

Transit time. The number of days a shipment takes to move from the source location to the destination location.

": "{Integer}"
36
               },
37
               "locationSupplyLink
LocationSupplyLink

Intercompany relationship reference

": "{String}"
38
          }
39
     ],
40
     "paging
Paging

Detailed paging information for this list.

": {
41
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
42
          "position
Position

Position of the first element in the list

": "{Integer}",
43
          "page
Page

Page index

": "{Integer}",
44
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
45
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
46
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
47
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
48
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
49
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
50
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
51
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
52
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
53
     }
54
}

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 100140 HTTP 404 Company not found