Create Collection

post/v3/catalogcollection

Request

Base URL
https://sandbox.api.mxmerchant.com/checkout
Auth
HTTP basic
TypeScript
https://skmtc.dev/mxmerchant/apis/checkout-api/docs/v3/catalogcollection/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

idstring required

Catalog Id

echoboolean

Return results

Request body

namestring required

Collection Name

catalogIdinteger required

descriptionstring

Collection Description

merchantIdinteger

Merchant Id

Response

201

idinteger

catalogIdinteger

namestring

descriptionstring

createdstring

isAutomaticboolean

isFeaturedboolean

modifiedstring

productCountinteger

Example response

{
  "id": 136,
  "catalogId": 112226,
  "name": "Collection Name",
  "description": "collection on collection",
  "created": "0001-01-01T00:00:00",
  "modified": "0001-01-01T00:00:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.