Logistics APIs
Creates a new location supply for the specified location
| HTTP method | POST |
| 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 |
| Successful HTTP status code | 201 |
| API resource identifier | 7135, 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.
LocationId
Required/mandatory field
Location identifier
Minimum value: 10000
>{Integer}</LocationId>TransferLeadTime
This field is optional.
>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.
Minimum value: 0
This field is optional.
>{Integer}</HandlingDays>TransitDays
Transit time. The number of days a shipment takes to move from the source location to the destination location.
Minimum value: 0
This field is optional.
>{Integer}</TransitDays>LocationId
Required/mandatory field
Location identifier
Minimum value: 10000
": "{Integer}"TransferLeadTime
This field is optional.
": {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.
Minimum value: 0
This field is optional.
": "{Integer}",TransitDays
Transit time. The number of days a shipment takes to move from the source location to the destination location.
Minimum value: 0
This field is optional.
": "{Integer}"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.
LocationSupplyId
Location supply identifier
>{Integer}</LocationSupplyId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>UpdatedAt
Date and time when intercompany-relationship was updated
>{Datetime}</UpdatedAt>Status
Status of distribution sourcing rule
Possible domain values can be found here
>{Integer}</Status>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>LocationId
Location identifier
>{Integer}</LocationId>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>Name
Name of warehouse location
>{String}</Name>LocationLink
Location reference
>{String}</LocationLink>CompanyId
Company identifier
>{Integer}</CompanyId>Name
Name of company
>{String}</Name>Database
Abbreviation/code to identify the company
>{String}</Database>CompanyLink
Company reference
>{String}</CompanyLink>Supplier
The supplier that will be used when creating distribution orders towards this source location
>SupplierId
RamBase supplier identifier
>{Integer}</SupplierId>Name
Name of supplier (name of company or surname/familyname/lastname of a person)
>{String}</Name>SupplierLink
Supplier reference
>{String}</SupplierLink>Customer
The customer that will be used for receiving distribution orders
>CustomerId
Customer identifier
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>CustomerLink
Customer reference
>{String}</CustomerLink>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>TransitDays
Transit time. The number of days a shipment takes to move from the source location to the destination location.
>{Integer}</TransitDays>LocationSupplyId
Location supply identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",UpdatedAt
Date and time when intercompany-relationship was updated
": "{Datetime}",Status
Status of distribution sourcing rule
Possible domain values can be found here
": "{Integer}",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}",LocationId
Location identifier
": "{Integer}",ShortName
Unique abbreviation/short name of the location
": "{String}",Name
Name of warehouse location
": "{String}",LocationLink
Location reference
": "{String}"CompanyId
Company identifier
": "{Integer}",Name
Name of company
": "{String}",Database
Abbreviation/code to identify the company
": "{String}",CompanyLink
Company reference
": "{String}"Supplier
The supplier that will be used when creating distribution orders towards this source location
": {SupplierId
RamBase supplier identifier
": "{Integer}",Name
Name of supplier (name of company or surname/familyname/lastname of a person)
": "{String}",SupplierLink
Supplier reference
": "{String}"Customer
The customer that will be used for receiving distribution orders
": {CustomerId
Customer identifier
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",CustomerLink
Customer reference
": "{String}"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}",TransitDays
Transit time. The number of days a shipment takes to move from the source location to the destination location.
": "{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 101015 HTTP 404 | Permission not found |
| Error 100865 HTTP 404 | Customer not found |
| Error 110242 HTTP 400 | It is not allowed to change address of customer which is classified for 'Distribution'. Address is syncronized with addresss in related location. |
| Error 101000 HTTP 400 | Can not change country on customers with open transaction documents |
| Error 100942 HTTP 400 | External reference should be unique |
| Error 100943 HTTP 400 | Postcode is not valid |
| Error 100944 HTTP 400 | Mismatch between post code and city |
| Error 100948 HTTP 400 | Can not deactivate customers with open transaction documents |
| Error 100949 HTTP 400 | Can not delete customers with open transaction documents |
| Error 108670 HTTP 400 | Discount percentage must be a number between 0 and 100 |