API

Product APIs

POST product/products/{productId}/replenishment-configurations

Creates a new stock location replenishment configuration

HTTP method POST
URI https://api.rambase.net/product/products/{productId}/replenishment-configurations
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productId} Product identifier
Integer, minimum 10000
Successful HTTP status code 201
API resource identifier 5019, 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.

Format:
1
<ReplenishmentConfiguration>
2
     <ReplenishmentPoint
ReplenishmentPoint

Required/mandatory field

The minimum quantity of the specified product that should be present at the specified stock location

Minimum value: 0

>
{Decimal}</ReplenishmentPoint>
3
     <ReplenishmentQuantity
ReplenishmentQuantity

The quantity of the specified product that should be reordered to the specified stock location

Minimum value: 0

This field is optional.

>
{Decimal}</ReplenishmentQuantity>
4
     <StockLocation>
5
          <StockLocationId
StockLocationId

Required/mandatory field

Stock location identifier

Minimum value: 100000

>
{Integer}</StockLocationId>
6
     </StockLocation>
7
</ReplenishmentConfiguration>
1
{
2
     "replenishmentConfiguration": {
3
          "replenishmentPoint
ReplenishmentPoint

Required/mandatory field

The minimum quantity of the specified product that should be present at the specified stock location

Minimum value: 0

":
"{Decimal}",
4
          "replenishmentQuantity
ReplenishmentQuantity

The quantity of the specified product that should be reordered to the specified stock location

Minimum value: 0

This field is optional.

":
"{Decimal}",
5
          "stockLocation": {
6
               "stockLocationId
StockLocationId

Required/mandatory field

Stock location identifier

Minimum value: 100000

":
"{Integer}"
7
          }
8
     }
9
}

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.
$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.

Format:
1
<ReplenishmentConfiguration>
2
     <ReplenishmentConfigurationId
ReplenishmentConfigurationId

Stock location replinishment configuration identifier

>
{Integer}</ReplenishmentConfigurationId>
3
     <CreatedAt
CreatedAt

Date and time of creation

>
{Datetime}</CreatedAt>
4
     <ReplenishmentPoint
ReplenishmentPoint

The minimum quantity of the specified product that should be present at the specified stock location

>
{Decimal}</ReplenishmentPoint>
5
     <ReplenishmentQuantity
ReplenishmentQuantity

The quantity of the specified product that should be reordered to the specified stock location

>
{Decimal}</ReplenishmentQuantity>
6
     <StockLocation>
7
          <StockLocationId
StockLocationId

Stock location identifier

>
{Integer}</StockLocationId>
8
          <Label
Label

Name of current- and parent stock locations, including seperator for location

>
{String}</Label>
9
          <Location>
10
               <LocationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

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

Location reference

>
{String}</LocationLink>
13
          </Location>
14
          <StockLocationLink
StockLocationLink

Stock location reference

>
{String}</StockLocationLink>
15
     </StockLocation>
16
     <ReplenishmentConfigurationLink
ReplenishmentConfigurationLink

Stock location replenishment reference

>
{String}</ReplenishmentConfigurationLink>
17
</ReplenishmentConfiguration>
1
{
2
     "replenishmentConfiguration": {
3
          "replenishmentConfigurationId
ReplenishmentConfigurationId

Stock location replinishment configuration identifier

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

Date and time of creation

":
"{Datetime}",
5
          "replenishmentPoint
ReplenishmentPoint

The minimum quantity of the specified product that should be present at the specified stock location

":
"{Decimal}",
6
          "replenishmentQuantity
ReplenishmentQuantity

The quantity of the specified product that should be reordered to the specified stock location

":
"{Decimal}",
7
          "stockLocation": {
8
               "stockLocationId
StockLocationId

Stock location identifier

":
"{Integer}",
9
               "label
Label

Name of current- and parent stock locations, including seperator for location

":
"{String}",
10
               "location": {
11
                    "locationId
LocationId

Location identifier

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

Unique abbreviation/short name of the location

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

Location reference

":
"{String}"
14
               },
15
               "stockLocationLink
StockLocationLink

Stock location reference

":
"{String}"
16
          },
17
          "replenishmentConfigurationLink
ReplenishmentConfigurationLink

Stock location replenishment reference

":
"{String}"
18
     }
19
}

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 106864 HTTP 400 Reorderpoint must be higher than 0
Error 106865 HTTP 400 Reorder quantity must higher than 0
Error 104377 HTTP 400 Missing mandatory parameter location id
Error 100089 HTTP 404 Product {0} not found
Error 106866 HTTP 400 This product is already added to this stock location