IBM Store Inventory Management APIs

Preview

IBM Store Inventory Management APIs

+ Day(s) remaining in the trial

Overview

The IBM Store Inventory Management solution allows retailers to manage inventory within a store by recording the location and movement of inventory within a store from receipt to the outbound order processing, as well as manage counts and assign disposition of inventory thereby improving overall inventory accuracy.

Security

Keys

Pick a key to use with this API. Make sure you are logged in with your IBM id for your keys to be populated in the dropdown below. By selecting a key, it will be pre-filled for each endpoint in the Documentation section that can be used with the built-in testing. If you want to change which key to use for a particular endpoint, you can do so at the endpoint in the Documentation section.
You can manage your API keys in the <MyAPIs> section. API keys authenticate you to your subscription, so make sure to keep them secret. Do not share the X-IBM-Client-Secret portion of any API key in publicly accessible places such as GitHub, or client-side code.



Manage your keys
 

Documentation

IBM Store Inventory Management APIs:

Count Program

Creates a count program

POST   /{tenantId}/v1/count-programs

			https://sim.watsoncommerce.ibm.com/{tenantId}/v1/count-programs
		
Keys
Path and Query parameters

tenantId

URL , required

Tenant identifier

Request code
Request model

endDate

DATE , optional

End date of the count program, if the program is seasonal. End date cannot be lesser than start date and cannot be a past date. It is an optional field. By default, count programs are not seasonal and hence always enabled.

excludeLocationCriteria

ARRAY , optional

Array of location zone/type combinations which resolve the locations that need to be excluded. It is an optional field. If not provided, no location is excluded.

exclusionDaysWeek

ARRAY , optional

Days of the week which should be excluded for creating count request and tasks for this program. Possible values are 'SUN,MON,TUE,WED,THU,FRI,SAT'. Cannot contain all the possible 7 days. It is an optional field. By default, all days of the week are considered.

frequencyDays

DECIMAL , optional

Number of days for which the count request for this program will run. Value cannot be less than 1. It is a mandatory field.

includeLocationCriteria

ARRAY , optional

Array of location zone/type combinations which resolve the locations that need to be included. It is an optional field. If not provided, all locations are included.

recounting

STRING , optional

How recounting should be done. It is an optional field. By default, recounting would be done only on variance in the first count. ALWAYS_RECOUNT is not supported yet

serialScanning

STRING , optional

Whether scanning of serial is required. It is an optional field. By default, serial scanning would be done only on recounting.

startDate

DATE , optional

Start date of the count program, if the program is seasonal. For 'POST', start date cannot be past date. It is an optional field. By default, count programs are not seasonal and hence always enabled.

type

STRING , optional

Type of count program. It is an optional field, defaults to 'CYCLE'.

varianceThreshold

DECIMAL , optional

Whether recounting should be done only if variance crosses a threshold. Value should be >=0 && <=100. Applicable only when recounting is set to 'RECOUNT_ON_VARIANCE'. It is an optional field. For e.g. value of 10 means recounting should be done if actual count differs from systeminc count by 10% or more. If not provided, recounting is done on any slightest variance.

velocityCode

STRING , optional

Velocity code of the items which need to be included. It is an optional field. If not provided, all items are considered.

locationType

STRING , optional

zone

STRING , optional

locationType

STRING , optional

zone

STRING , optional

Request example
{
  "endDate": date,
  "excludeLocationCriteria": [{
    "locationType": string,
    "zone": string
  }],
  "exclusionDaysWeek": [],
  "frequencyDays": decimal,
  "includeLocationCriteria": [{
    "locationType": string,
    "zone": string
  }],
  "recounting": [NO_RECOUNT, RECOUNT_ON_VARIANCE, ALWAYS_RECOUNT],
  "serialScanning": [NOT_MANDATORY, MANDATORY_RECOUNT, MANDATORY_ALWAYS],
  "startDate": date,
  "type": [CYCLE, PHYSICAL],
  "varianceThreshold": decimal,
  "velocityCode": string
}
Response model

200

successful operation

Body

countProgramId

STRING , optional

createdByUserId

STRING , optional

createdTimestamp

DATETIME , optional

endDate

DATE , optional

excludeLocationCriteria [countProgramLocations]

ARRAY , optional

exclusionDaysWeek

ARRAY , optional

frequencyDays

DECIMAL , optional

includeLocationCriteria [countProgramLocations]

ARRAY , optional

recounting

STRING , optional

serialScanning

STRING , optional

startDate

DATE , optional

type

STRING , optional

varianceThreshold

DECIMAL , optional

velocityCode

STRING , optional

locationType

STRING , optional

zone

STRING , optional

locationType

STRING , optional

zone

STRING , optional

Response example

200

successful operation

								{
  "countProgramId" : string,
  "createdByUserId" : string,
  "createdTimestamp" : datetime,
  "endDate" : date,
  "excludeLocationCriteria" : [{
    "locationType" : string,
    "zone" : string
  }],
  "exclusionDaysWeek" : [string],
  "frequencyDays" : decimal,
  "includeLocationCriteria" : [{
    "locationType" : string,
    "zone" : string
  }],
  "recounting" : string,
  "serialScanning" : string,
  "startDate" : date,
  "type" : string,
  "varianceThreshold" : decimal,
  "velocityCode" : string
}
							
Deletes a count program

DELETE   /{tenantId}/v1/count-programs/{countProgramId}

			https://sim.watsoncommerce.ibm.com/{tenantId}/v1/count-programs/{countProgramId}
		
Keys
Path and Query parameters

countProgramId

URL , required

Count Program identifier

tenantId

URL , required

Tenant identifier

Request code
Response model

200

successful operation

Response example

200

successful operation

Gets a count program by ID

GET   /{tenantId}/v1/count-programs/{countProgramId}

			https://sim.watsoncommerce.ibm.com/{tenantId}/v1/count-programs/{countProgramId}
		
Keys
Path and Query parameters

countProgramId

URL , required

Count Program identifier

tenantId

URL , required

Tenant identifier

Request code
Response model

200

successful operation

Body

endDate

DATE , optional

End date of the count program, if the program is seasonal. End date cannot be lesser than start date and cannot be a past date. It is an optional field. By default, count programs are not seasonal and hence always enabled.

excludeLocationCriteria [countProgramLocations]

ARRAY , optional

Array of location zone/type combinations which resolve the locations that need to be excluded. It is an optional field. If not provided, no location is excluded.

exclusionDaysWeek

ARRAY , optional

Days of the week which should be excluded for creating count request and tasks for this program. Possible values are 'SUN,MON,TUE,WED,THU,FRI,SAT'. Cannot contain all the possible 7 days. It is an optional field. By default, all days of the week are considered.

frequencyDays

DECIMAL , optional

Number of days for which the count request for this program will run. Value cannot be less than 1. It is a mandatory field.

includeLocationCriteria [countProgramLocations]

ARRAY , optional

Array of location zone/type combinations which resolve the locations that need to be included. It is an optional field. If not provided, all locations are included.

recounting

STRING , optional

How recounting should be done. It is an optional field. By default, recounting would be done only on variance in the first count. ALWAYS_RECOUNT is not supported yet

serialScanning

STRING , optional

Whether scanning of serial is required. It is an optional field. By default, serial scanning would be done only on recounting.

startDate

DATE , optional

Start date of the count program, if the program is seasonal. For 'POST', start date cannot be past date. It is an optional field. By default, count programs are not seasonal and hence always enabled.

type

STRING , optional

Type of count program. It is an optional field, defaults to 'CYCLE'.

varianceThreshold

DECIMAL , optional

Whether recounting should be done only if variance crosses a threshold. Value should be >=0 && <=100. Applicable only when recounting is set to 'RECOUNT_ON_VARIANCE'. It is an optional field. For e.g. value of 10 means recounting should be done if actual count differs from systeminc count by 10% or more. If not provided, recounting is done on any slightest variance.

velocityCode

STRING , optional

Velocity code of the items which need to be included. It is an optional field. If not provided, all items are considered.

locationType

STRING , optional

zone

STRING , optional

locationType

STRING , optional

zone

STRING , optional

Response example

200

successful operation

								{
  "endDate" : date,
  "excludeLocationCriteria" : [{
    "locationType" : string,
    "zone" : string
  }],
  "exclusionDaysWeek" : [string],
  "frequencyDays" : decimal,
  "includeLocationCriteria" : [{
    "locationType" : string,
    "zone" : string
  }],
  "recounting" : [NO_RECOUNT, RECOUNT_ON_VARIANCE, ALWAYS_RECOUNT],
  "serialScanning" : [NOT_MANDATORY, MANDATORY_RECOUNT, MANDATORY_ALWAYS],
  "startDate" : date,
  "type" : [CYCLE, PHYSICAL],
  "varianceThreshold" : decimal,
  "velocityCode" : string
}
							
Gets all the count programs generated for a tenant

GET   /{tenantId}/v1/count-programs

			https://sim.watsoncommerce.ibm.com/{tenantId}/v1/count-programs
		
Keys
Path and Query parameters

tenantId

URL , required

Tenant identifier

Request code
Response model

200

successful operation

Response example

200

successful operation

Updates a count program

PUT   /{tenantId}/v1/count-programs/{countProgramId}

			https://sim.watsoncommerce.ibm.com/{tenantId}/v1/count-programs/{countProgramId}
		
Keys
Path and Query parameters

countProgramId

URL , required

Count Program identifier

tenantId

URL , required

Tenant identifier

Request code
Request model

endDate

DATE , optional

End date of the count program, if the program is seasonal. End date cannot be lesser than start date and cannot be a past date. It is an optional field. By default, count programs are not seasonal and hence always enabled.

excludeLocationCriteria

ARRAY , optional

Array of location zone/type combinations which resolve the locations that need to be excluded. It is an optional field. If not provided, no location is excluded.

exclusionDaysWeek

ARRAY , optional

Days of the week which should be excluded for creating count request and tasks for this program. Possible values are 'SUN,MON,TUE,WED,THU,FRI,SAT'. Cannot contain all the possible 7 days. It is an optional field. By default, all days of the week are considered.

frequencyDays

DECIMAL , optional

Number of days for which the count request for this program will run. Value cannot be less than 1. It is a mandatory field.

includeLocationCriteria

ARRAY , optional

Array of location zone/type combinations which resolve the locations that need to be included. It is an optional field. If not provided, all locations are included.

recounting

STRING , optional

How recounting should be done. It is an optional field. By default, recounting would be done only on variance in the first count. ALWAYS_RECOUNT is not supported yet

serialScanning

STRING , optional

Whether scanning of serial is required. It is an optional field. By default, serial scanning would be done only on recounting.

startDate

DATE , optional

Start date of the count program, if the program is seasonal. For 'POST', start date cannot be past date. It is an optional field. By default, count programs are not seasonal and hence always enabled.

type

STRING , optional

Type of count program. It is an optional field, defaults to 'CYCLE'.

varianceThreshold

DECIMAL , optional

Whether recounting should be done only if variance crosses a threshold. Value should be >=0 && <=100. Applicable only when recounting is set to 'RECOUNT_ON_VARIANCE'. It is an optional field. For e.g. value of 10 means recounting should be done if actual count differs from systeminc count by 10% or more. If not provided, recounting is done on any slightest variance.

velocityCode

STRING , optional

Velocity code of the items which need to be included. It is an optional field. If not provided, all items are considered.

locationType

STRING , optional

zone

STRING , optional

locationType

STRING , optional

zone

STRING , optional

Request example
{
  "endDate": date,
  "excludeLocationCriteria": [{
    "locationType": string,
    "zone": string
  }],
  "exclusionDaysWeek": [],
  "frequencyDays": decimal,
  "includeLocationCriteria": [{
    "locationType": string,
    "zone": string
  }],
  "recounting": [NO_RECOUNT, RECOUNT_ON_VARIANCE, ALWAYS_RECOUNT],
  "serialScanning": [NOT_MANDATORY, MANDATORY_RECOUNT, MANDATORY_ALWAYS],
  "startDate": date,
  "type": [CYCLE, PHYSICAL],
  "varianceThreshold": decimal,
  "velocityCode": string
}
Response model

200

successful operation

Body

countProgramId

STRING , optional

createdByUserId

STRING , optional

createdTimestamp

DATETIME , optional

endDate

DATE , optional

excludeLocationCriteria [countProgramLocations]

ARRAY , optional

exclusionDaysWeek

ARRAY , optional

frequencyDays

DECIMAL , optional

includeLocationCriteria [countProgramLocations]

ARRAY , optional

recounting

STRING , optional

serialScanning

STRING , optional

startDate

DATE , optional

type

STRING , optional

varianceThreshold

DECIMAL , optional

velocityCode

STRING , optional

locationType

STRING , optional

zone

STRING , optional

locationType

STRING , optional

zone

STRING , optional

Response example

200

successful operation

								{
  "countProgramId" : string,
  "createdByUserId" : string,
  "createdTimestamp" : datetime,
  "endDate" : date,
  "excludeLocationCriteria" : [{
    "locationType" : string,
    "zone" : string
  }],
  "exclusionDaysWeek" : [string],
  "frequencyDays" : decimal,
  "includeLocationCriteria" : [{
    "locationType" : string,
    "zone" : string
  }],
  "recounting" : string,
  "serialScanning" : string,
  "startDate" : date,
  "type" : string,
  "varianceThreshold" : decimal,
  "velocityCode" : string
}
							

Loading content...

Resources