Create a Product

post/v3/catalogproduct

Request

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

Query parameters

idstring required

Catalog Id

echoboolean

Return data

Request body

clientNumberinteger required

Client number

namestring required

Product name

supplierstring

taxCodestring

Product tax code

activeboolean

taxableboolean

Enable your product to be tax

descriptionstring

Product description

Response

201

idinteger

namestring

clientNumberstring

descriptionstring

taxCodestring

activeboolean

modifiedstring

createdstring

deletedboolean

taxableboolean

availableCountinteger

quantitySoldinteger

displayImageDefaultboolean

Example response

{
  "id": 886652,
  "name": "Test Product",
  "clientNumber": "1",
  "description": "Test Product Description",
  "taxCode": "Tax Code",
  "active": true,
  "modified": "2020-10-06T14:31:03.49Z",
  "created": "2020-10-06T14:31:03.49Z",
  "taxable": true,
  "displayImageDefault": true
}

Changes

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