Create a full catalog

Request

POST https://api.nexway.store/catalogs/createFullCatalog

Request body

The request body takes a complete FullCatalog resource, containing the following writable properties:

{
    "catalog": {
        "createDate": "date-time",
        "customerId": "string",
        "dbVersion": "int64",
        "endDate": "string",
        "id": "string",
        "name": "string",
        "running": "boolean",
        "singleUse": "boolean",
        "startDate": "string",
        "status": "string",
        "type": "string",
        "updateDate": "date-time"
    },
    "discounts": [
        {
            "catalogId": "string",
            "customerId": "string"
        }
    ],
    "locale": "string",
    "products": [
        {
            "catalogId": "string",
            "customerId": "string",
            "parentId": "string"
        }
    ],
    "recommendations": [
        {
            "catalogId": "string",
            "customerId": "string"
        }
    ],
    "storeId": "string"
}

Properties

Name Type Description Additional
catalog object AbstractCatalog Optional
catalog.createDate date-time Optional
catalog.customerId string Optional
catalog.dbVersion int64 Optional
catalog.endDate string Optional
catalog.id string Optional
catalog.name string Optional
catalog.running boolean Optional
catalog.singleUse boolean Optional
catalog.startDate string Optional
catalog.status string

Possible values are:

  • ENABLED
  • DISABLED
Optional
catalog.type string

Possible values are:

  • INTERNAL
  • FULL_REMOTE
  • PRICING_REMOTE
  • VARIANT_PRICING_REMOTE
  • SIGNED
Optional
catalog.updateDate date-time Optional
discounts[] array Optional
discounts[].catalogId string Optional
discounts[].customerId string Optional
locale string Optional
products[] array Optional
products[].catalogId string Optional
products[].customerId string Optional
products[].parentId string Optional
recommendations[] array Optional
recommendations[].catalogId string Optional
recommendations[].customerId string Optional
storeId string Optional

Authorisation

This request requires the use of one of following authorisation methods: OAuth2.

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
201 Created

Success

Success
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

500 Internal Server Error

Failure

Example

{
    "catalog": {
        "endDate": "yyyy-MM-dd'T'HH:mm:ss'Z'",
        "startDate": "yyyy-MM-dd'T'HH:mm:ss'Z'"
    }
}

Explore this API

fullCatalog

fullCatalog

Request Content-Type
Response Content-Type

Choose an authorisation method:

Access Token Access token to be used for request
Try it out!