Product

Upsert a product

Upsert a product

put/unstable/product

Request

  • Base URL
    https://api.authentified.co
  • Auth
    API key in header X-Authentified-API-Key

Request body

idstring required

The Unique Identifier of the product in your system

titlestring required

Title of the product

handlestring required

A slug identifying the product in kebab-case format

status'ACTIVE' | 'DRAFT' | 'ARCHIVED' required

The status of the product

categorystring

Category of the product

descriptionstring

Description of the product

vendorstring

The vendor of the product

tagsstring[]

Tags associated with the product

createdAtstring date-time

The date and time when the product was created in your system

updatedAtstring date-time

The date and time when the product was updated in your system

Example request

{
  "id": "458291",
  "title": "Silk Wrap Dress",
  "handle": "silk-wrap-dress",
  "status": "ACTIVE",
  "category": "Dresses",
  "description": "A beautiful silk wrap dress perfect for summer.",
  "vendor": "Sportsgirl",
  "tags": [
    "summer",
    "dress",
    "onsale",
    "nodiscount"
  ],
  "createdAt": "2023-10-01T12:12:00Z",
  "updatedAt": "2023-10-01T18:38:00Z"
}

Response

Product updated successfully

idstring required

The Unique Identifier of the product in your system

titlestring required

Title of the product

handlestring required

A slug identifying the product in kebab-case format

status'ACTIVE' | 'DRAFT' | 'ARCHIVED' required

The status of the product

categorystring

Category of the product

descriptionstring

Description of the product

vendorstring

The vendor of the product

tagsstring[]

Tags associated with the product

createdAtstring date-time

The date and time when the product was created in your system

updatedAtstring date-time

The date and time when the product was updated in your system

Example response

{
  "id": "458291",
  "title": "Silk Wrap Dress",
  "handle": "silk-wrap-dress",
  "status": "ACTIVE",
  "category": "Dresses",
  "description": "A beautiful silk wrap dress perfect for summer.",
  "vendor": "Sportsgirl",
  "tags": [
    "summer",
    "dress",
    "onsale",
    "nodiscount"
  ],
  "createdAt": "2023-10-01T12:12:00Z",
  "updatedAt": "2023-10-01T18:38:00Z"
}

Changes

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