updateInventoryConfiguration
put
/ccadmin/v1/merchant/inventoryConfiguration
Updates inventory configuration.
Request
Supported Media Types
- application/json
Body Parameter
Root Schema : updateInventoryConfiguration_request
{
"preorderBackorderEnabled":false
}
- preorderBackorderEnabled
-
Type:
boolean
If enabled, allows order to be placed as backordered/preordered. It is recommended to carefully decide to enable or disable the flag at first place. Resetting the flag will lead to inconsistent behavior.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : updateInventoryConfiguration_response
- preorderBackorderEnabled
-
Type:
boolean
If enabled, allows order to be placed as backordered/preordered. It is recommended to carefully decide to enable or disable the flag at first place. Resetting the flag will lead to inconsistent behavior.
Example application/json
{
"preorderBackorderEnabled":false
}
Default Response
The error response
Body
Root Schema : errorModel
Type:
object
- devMessage
-
Type:
string
An optional non-localized message containing technical information for developers - errorCode
-
Type:
string
The numerical code identifying the error - errors
-
Type:
array
errorsAdditional Properties Allowed:An optional list of errors if multiple errors were encountered - message
-
Type:
string
The localized message describing the error - moreInfo
-
Type:
string
An optional non-localized message with more information - o:errorPath
-
Type:
string
An optional machine readable description of where the error occurred - status
-
Type:
string
The HTTP status code - type
-
Type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Nested Schema : items
Type:
object
- devMessage
-
Type:
string
An optional non-localized message containing technical information for developers - errorCode
-
Type:
string
The numerical code identifying the error - message
-
Type:
string
The localized message describing the error - moreInfo
-
Type:
string
An optional non-localized message with more information - o:errorPath
-
Type:
string
An optional machine readable description of where the error occurred - status
-
Type:
string
The HTTP status code
Examples
Sample Request:
{"preorderBackorderEnabled": false}
Sample Response Payload returned by endpoint:
{"preorderBackorderEnabled": false}