Jump to

• Request
• Response

createInventory

post

/ccadmin/v1/inventories

Create inventory information.

Request

Supported Media Types

• application/json

Query Parameters

• showTranslations(optional): string
  show translations, boolean true or false; default false

Body ()

Inventory request object.

Root Schema : createInventory_request

Type: object

Show Source

• availabilityDate(optional): string
  Availability date. Date format is an ISO standard such as yyyy-MM-dd.
• backorderLevel(optional): integer
  Backorder level of the variant.
• backorderThreshold(optional): integer
  Backorder threshold of the variant.
• id: string
  ID of the inventory record.
• locationId(optional): string
  ID of the location for which the inventory information is being created.
• preorderLevel(optional): integer
  Preorder level of the variant.
• preorderThreshold(optional): integer
  Preorder threshold of the variant.
• stockLevel(optional): string
  Stock level of the variant.
• stockThreshold(optional): string
  Stock threshold of the variant.
• type(optional): string
  Inventory type, either variant or product, defaults to variant

{
    "properties":{
        "preorderThreshold":{
            "description":"Preorder threshold of the variant.",
            "type":"integer"
        },
        "backorderLevel":{
            "description":"Backorder level of the variant.",
            "type":"integer"
        },
        "preorderLevel":{
            "description":"Preorder level of the variant.",
            "type":"integer"
        },
        "locationId":{
            "description":"ID of the location for which the inventory information is being created.",
            "type":"string"
        },
        "availabilityDate":{
            "description":"Availability date. Date format is an ISO standard such as yyyy-MM-dd.",
            "type":"string"
        },
        "backorderThreshold":{
            "description":"Backorder threshold of the variant.",
            "type":"integer"
        },
        "id":{
            "description":"ID of the inventory record.",
            "type":"string"
        },
        "stockThreshold":{
            "description":"Stock threshold of the variant.",
            "type":"string"
        },
        "type":{
            "description":"Inventory type, either variant or product, defaults to variant",
            "type":"string"
        },
        "stockLevel":{
            "description":"Stock level of the variant.",
            "type":"string"
        }
    },
    "required":[
        "id"
    ],
    "example":{
        "preorderThreshold":0,
        "backorderLevel":0,
        "preorderLevel":0,
        "locationId":"loc1",
        "availabilityDate":null,
        "backorderThreshold":0,
        "id":"sku123",
        "stockThreshold":"10",
        "type":"variant",
        "stockLevel":"120"
    }
}

Example:

{
    "preorderThreshold":0,
    "backorderLevel":0,
    "preorderLevel":0,
    "locationId":"loc1",
    "availabilityDate":null,
    "backorderThreshold":0,
    "id":"sku123",
    "stockThreshold":"10",
    "type":"variant",
    "stockLevel":"120"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

When locationId is not passed in the request body, a flat response will be returned with inventory properties appearing at the top of the response object. When locationId is passed in the request body, the response will change to include a 'locationInventoryInfo' JSON object that contains location specific inventory information.

Body ()

Root Schema : createInventory_response

Type: object

Show Source

• availabilityDate(optional): string
  Availability date of variant. Date format is an ISO standard such as yyyy-MM-dd.
• availabilityStatus(optional): integer
  Availability status/ available count of the variant.
• availabilityStatusMsg(optional): string
  Availability status message of the variant.
• availableToPromise(optional): string
  Available to promise.
• backorderLevel(optional): integer
  Backorder level of the variant.
• backorderThreshold(optional): integer
  Backorder threshold of the variant.
• displayName(optional): string
  Display name of the variant.
• inventoryId(optional): string
  Inventory id of the variant.
• locationId(optional): string
  Location id.
• locationInventoryInfo(optional): array locationInventoryInfo
• preorderLevel(optional): integer
  Preorder level of the variant.
• preorderThreshold(optional): integer
  Preorder threshold of the variant.
• skuId(optional): string
  SKU id of the variant.
• skuNumber(optional): string
  SKU number of the variant.
• stockLevel(optional): integer
  Stock level of the variant.
• stockThreshold(optional): integer
  Stock threshold of the variant.

{
    "properties":{
        "preorderThreshold":{
            "description":"Preorder threshold of the variant.",
            "type":"integer"
        },
        "backorderLevel":{
            "description":"Backorder level of the variant.",
            "type":"integer"
        },
        "displayName":{
            "description":"Display name of the variant.",
            "type":"string"
        },
        "availabilityDate":{
            "description":"Availability date of variant. Date format is an ISO standard such as yyyy-MM-dd.",
            "type":"string"
        },
        "availabilityStatusMsg":{
            "description":"Availability status message of the variant.",
            "type":"string"
        },
        "stockThreshold":{
            "description":"Stock threshold of the variant.",
            "type":"integer"
        },
        "stockLevel":{
            "description":"Stock level of the variant.",
            "type":"integer"
        },
        "availableToPromise":{
            "description":"Available to promise.",
            "type":"string"
        },
        "skuNumber":{
            "description":"SKU number of the variant.",
            "type":"string"
        },
        "preorderLevel":{
            "description":"Preorder level of the variant.",
            "type":"integer"
        },
        "locationId":{
            "description":"Location id.",
            "type":"string"
        },
        "inventoryId":{
            "description":"Inventory id of the variant.",
            "type":"string"
        },
        "backorderThreshold":{
            "description":"Backorder threshold of the variant.",
            "type":"integer"
        },
        "availabilityStatus":{
            "description":"Availability status/ available count of the variant.",
            "type":"integer"
        },
        "locationInventoryInfo":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "preorderThreshold":{
                        "description":"Preorder threshold of the variant.",
                        "type":"integer"
                    },
                    "backorderLevel":{
                        "description":"Backorder level of the variant.",
                        "type":"integer"
                    },
                    "displayName":{
                        "description":"Display name of the variant.",
                        "type":"string"
                    },
                    "availabilityDate":{
                        "description":"Availability date of variant. Date format is an ISO standard such as yyyy-MM-dd.",
                        "type":"string"
                    },
                    "availabilityStatusMsg":{
                        "description":"Availability status message of the variant.",
                        "type":"string"
                    },
                    "stockThreshold":{
                        "description":"Stock threshold of the variant.",
                        "type":"integer"
                    },
                    "stockLevel":{
                        "description":"Stock level of the variant.",
                        "type":"integer"
                    },
                    "availableToPromise":{
                        "description":"Available to promise.",
                        "type":"string"
                    },
                    "skuNumber":{
                        "description":"SKU number of the variant.",
                        "type":"string"
                    },
                    "preorderLevel":{
                        "description":"Preorder level of the variant.",
                        "type":"integer"
                    },
                    "locationId":{
                        "description":"Location id.",
                        "type":"string"
                    },
                    "inventoryId":{
                        "description":"Inventory id of the variant.",
                        "type":"string"
                    },
                    "backorderThreshold":{
                        "description":"Backorder threshold of the variant.",
                        "type":"integer"
                    },
                    "availabilityStatus":{
                        "description":"Availability status/ available count of the variant.",
                        "type":"integer"
                    }
                }
            }
        },
        "skuId":{
            "description":"SKU id of the variant.",
            "type":"string"
        }
    }
}

Nested Schema : locationInventoryInfo

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "preorderThreshold":{
                "description":"Preorder threshold of the variant.",
                "type":"integer"
            },
            "backorderLevel":{
                "description":"Backorder level of the variant.",
                "type":"integer"
            },
            "displayName":{
                "description":"Display name of the variant.",
                "type":"string"
            },
            "availabilityDate":{
                "description":"Availability date of variant. Date format is an ISO standard such as yyyy-MM-dd.",
                "type":"string"
            },
            "availabilityStatusMsg":{
                "description":"Availability status message of the variant.",
                "type":"string"
            },
            "stockThreshold":{
                "description":"Stock threshold of the variant.",
                "type":"integer"
            },
            "stockLevel":{
                "description":"Stock level of the variant.",
                "type":"integer"
            },
            "availableToPromise":{
                "description":"Available to promise.",
                "type":"string"
            },
            "skuNumber":{
                "description":"SKU number of the variant.",
                "type":"string"
            },
            "preorderLevel":{
                "description":"Preorder level of the variant.",
                "type":"integer"
            },
            "locationId":{
                "description":"Location id.",
                "type":"string"
            },
            "inventoryId":{
                "description":"Inventory id of the variant.",
                "type":"string"
            },
            "backorderThreshold":{
                "description":"Backorder threshold of the variant.",
                "type":"integer"
            },
            "availabilityStatus":{
                "description":"Availability status/ available count of the variant.",
                "type":"integer"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• availabilityDate(optional): string
  Availability date of variant. Date format is an ISO standard such as yyyy-MM-dd.
• availabilityStatus(optional): integer
  Availability status/ available count of the variant.
• availabilityStatusMsg(optional): string
  Availability status message of the variant.
• availableToPromise(optional): string
  Available to promise.
• backorderLevel(optional): integer
  Backorder level of the variant.
• backorderThreshold(optional): integer
  Backorder threshold of the variant.
• displayName(optional): string
  Display name of the variant.
• inventoryId(optional): string
  Inventory id of the variant.
• locationId(optional): string
  Location id.
• preorderLevel(optional): integer
  Preorder level of the variant.
• preorderThreshold(optional): integer
  Preorder threshold of the variant.
• skuNumber(optional): string
  SKU number of the variant.
• stockLevel(optional): integer
  Stock level of the variant.
• stockThreshold(optional): integer
  Stock threshold of the variant.

{
    "type":"object",
    "properties":{
        "preorderThreshold":{
            "description":"Preorder threshold of the variant.",
            "type":"integer"
        },
        "backorderLevel":{
            "description":"Backorder level of the variant.",
            "type":"integer"
        },
        "displayName":{
            "description":"Display name of the variant.",
            "type":"string"
        },
        "availabilityDate":{
            "description":"Availability date of variant. Date format is an ISO standard such as yyyy-MM-dd.",
            "type":"string"
        },
        "availabilityStatusMsg":{
            "description":"Availability status message of the variant.",
            "type":"string"
        },
        "stockThreshold":{
            "description":"Stock threshold of the variant.",
            "type":"integer"
        },
        "stockLevel":{
            "description":"Stock level of the variant.",
            "type":"integer"
        },
        "availableToPromise":{
            "description":"Available to promise.",
            "type":"string"
        },
        "skuNumber":{
            "description":"SKU number of the variant.",
            "type":"string"
        },
        "preorderLevel":{
            "description":"Preorder level of the variant.",
            "type":"integer"
        },
        "locationId":{
            "description":"Location id.",
            "type":"string"
        },
        "inventoryId":{
            "description":"Inventory id of the variant.",
            "type":"string"
        },
        "backorderThreshold":{
            "description":"Backorder threshold of the variant.",
            "type":"integer"
        },
        "availabilityStatus":{
            "description":"Availability status/ available count of the variant.",
            "type":"integer"
        }
    }
}

Example Response (application/json)

{
    "skuNumber":null,
    "displayName":null,
    "links":[
        {
            "rel":"self",
            "href":"http://www.example.com/inventories/ccadminui/v1/inventories"
        }
    ],
    "locationInventoryInfo":[
        {
            "preorderThreshold":0,
            "backorderLevel":0,
            "displayName":null,
            "availabilityDate":null,
            "availabilityStatusMsg":"inStock",
            "stockThreshold":10,
            "stockLevel":120,
            "availableToPromise":null,
            "skuNumber":null,
            "preorderLevel":0,
            "locationId":"loc1",
            "translations":null,
            "inventoryId":null,
            "backorderThreshold":0,
            "availabilityStatus":1000
        }
    ],
    "skuId":"sku123"
}

Example Response (description)

Example response when locationId is passed in request.

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: Error Code / Description ------------------ ------------------ 25120 / Internal inventory error 25121 / Missing sku id 25122 / Invalid properties map 25123 / Invalid property value 25126 / Inventory record not found 25127 / Location is invalid 25134 / Inventory operation not supported for type 25135 / Invalid type

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top