Create Product

Create a new product.

PreviousProduct States NextGet Product

Last updated 2 months ago

Was this helpful?

post

/v1/catalog/products

Body

iconstring · binary

productobject

Json representation of the product

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1/catalog/products' \
  --header 'Content-Type: multipart/form-data'

201

400

403

500

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-02-21T17:12:45.604Z",
      "by": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-02-21T17:12:45.604Z",
            "by": "[Circular Reference]"
          },
          "updated": {
            "at": "2025-02-21T17:12:45.604Z",
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-02-21T17:12:45.604Z",
      "by": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-02-21T17:12:45.604Z",
            "by": "[Circular Reference]"
          },
          "updated": {
            "at": "2025-02-21T17:12:45.604Z",
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "published": {
      "at": "2025-02-21T17:12:45.604Z",
      "by": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-02-21T17:12:45.604Z",
            "by": "[Circular Reference]"
          },
          "updated": {
            "at": "2025-02-21T17:12:45.604Z",
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "pending": {
      "at": "2025-02-21T17:12:45.604Z",
      "by": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-02-21T17:12:45.604Z",
            "by": "[Circular Reference]"
          },
          "updated": {
            "at": "2025-02-21T17:12:45.604Z",
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "unpublished": {
      "at": "2025-02-21T17:12:45.604Z",
      "by": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-02-21T17:12:45.604Z",
            "by": "[Circular Reference]"
          },
          "updated": {
            "at": "2025-02-21T17:12:45.604Z",
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "href": "text",
  "name": "text",
  "shortDescription": "text",
  "longDescription": "text",
  "externalIds": {
    "operations": "text"
  },
  "website": "text",
  "icon": "text",
  "status": "text",
  "vendor": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2025-02-21T17:12:45.604Z",
        "by": "[Circular Reference]"
      },
      "updated": {
        "at": "2025-02-21T17:12:45.604Z",
        "by": "[Circular Reference]"
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "href": "text",
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "type": "Client",
    "status": "Active",
    "serviceLevel": "Express",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "icon": "text",
    "technicalSupportEmail": "hello@example.com",
    "website": "text",
    "description": "text",
    "name": "text",
    "groups": [
      {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-02-21T17:12:45.604Z",
            "by": "[Circular Reference]"
          },
          "updated": {
            "at": "2025-02-21T17:12:45.604Z",
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "description": "text",
        "account": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-02-21T17:12:45.604Z",
              "by": "[Circular Reference]"
            },
            "updated": {
              "at": "2025-02-21T17:12:45.604Z",
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "externalIds": {
            "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "externalId": "text",
          "externalName": "text",
          "type": "Client",
          "status": "Active",
          "serviceLevel": "Express",
          "address": {
            "addressLine1": "text",
            "addressLine2": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text"
          },
          "icon": "text",
          "technicalSupportEmail": "hello@example.com",
          "website": "text",
          "description": "text",
          "name": "text",
          "groups": [
            "[Circular Reference]"
          ]
        },
        "logo": "text",
        "isDefault": true,
        "modules": [
          {
            "id": "text",
            "audit": "[Circular Reference]",
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "description": "text",
            "isConfigurable": true,
            "isEnabledByDefault": true,
            "paid": true,
            "name": "text",
            "filters": {
              "group.buyers": [
                "text"
              ]
            },
            "settings": {
              "sharedAccount": true,
              "configurable": true,
              "default": true,
              "paid": true,
              "type": [
                "text"
              ]
            },
            "accountTypes": [
              "text"
            ]
          }
        ],
        "users": [
          {
            "id": "text",
            "audit": "[Circular Reference]",
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "email": "text",
            "status": "text",
            "phone": {
              "prefix": "text",
              "number": "text"
            },
            "firstName": "text",
            "lastName": "text",
            "icon": "text",
            "lastLoginAt": "2025-02-21T17:12:45.604Z",
            "settings": {
              "cultureCode": "text",
              "languageCode": "text"
            },
            "name": "text",
            "currentAccount": "[Circular Reference]",
            "accounts": "[Circular Reference]"
          }
        ],
        "buyers": [
          {
            "id": "text",
            "audit": "[Circular Reference]",
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "contact": "[Circular Reference]",
            "externalIds": {
              "erpCompanyContact": "text",
              "erpCustomer": "text",
              "accountExternalId": "text"
            },
            "status": "Active",
            "icon": "text",
            "address": {
              "addressLine1": "text",
              "addressLine2": "text",
              "postCode": "text",
              "city": "text",
              "state": "text",
              "country": "text"
            },
            "taxId": "text",
            "account": "[Circular Reference]",
            "name": "text",
            "errors": [
              {
                "id": "text",
                "message": "text",
                "parameters": null
              }
            ],
            "sellers": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "settings": {
    "productOrdering": true,
    "productRequests": {
      "enabled": true,
      "name": "text",
      "label": "text"
    },
    "itemSelection": true,
    "orderQueueChanges": true,
    "preValidation": {
      "purchaseOrderDraft": true,
      "purchaseOrderQuerying": true,
      "changeOrderDraft": true,
      "terminationOrder": true,
      "productRequest": true
    },
    "splitBilling": {
      "enabled": true,
      "type": "text"
    }
  },
  "statistics": {
    "itemCount": 1,
    "ordersPlacedCount": 1,
    "agreementCount": 1,
    "subscriptionCount": 1,
    "requestCount": 1
  }
}

Created