Openapi

Create a product.

Create a product for the specified organization.

Create an organization audit export. POST

Queue an asynchronous CSV export of redacted organization audit events. Restricted details cannot be requested through this endpoint.

Create a product category. POST

Create a product category for the specified organization.

Create a product.

Create a product for the specified organization.

Authorization

sb-auth-token<token>

Supabase browser session cookie. Supabase may split larger session values into chunked cookies like sb-auth-token.0.

In: cookie

Request Body

application/json

The product payload.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/v1/organizations/123/products" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",  "categoryIds": [    "7a99018c-b68f-4d32-be08-29a0cbea434a"  ],  "categories": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",      "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",      "name": "string",      "slug": "string",      "icon": "string",      "description": "string",      "position": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "name": "string",  "slug": "string",  "description": "string",  "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",  "brand": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",    "name": "string",    "slug": "string",    "description": "string",    "website": "string",    "logoUrl": "http://example.com",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "manufacturer": "string",  "model": "string",  "sku": "string",  "ean": "string",  "defaultPurchasePrice": 0,  "defaultSellingPrice": 0,  "vatPercentage": 0,  "status": "active",  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "tags": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",      "kind": "task",      "name": "string",      "slug": "string",      "color": "string",      "description": "string",      "position": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "images": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",      "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",      "url": "http://example.com",      "altText": "string",      "position": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "suppliers": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",      "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",      "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",      "supplier": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",        "name": "string",        "email": "string",        "phone": "string",        "website": "string",        "notes": "string",        "status": "active",        "code": "string",        "accountNumber": "string",        "kvk": "string",        "btw": "string",        "orderingEmail": "string",        "billingEmail": "string",        "addressLine1": "string",        "addressLine2": "string",        "addressCity": "string",        "addressState": "string",        "addressPostalCode": "string",        "addressCountry": "string",        "currency": "string",        "paymentTermsDays": 0,        "defaultLeadTimeDays": 0,        "defaultInventoryLocationId": "39ba1a59-f7f9-4e8f-a32f-270329b3f772",        "source": "string",        "externalId": "string",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      },      "supplierSku": "string",      "orderCode": "string",      "unitCost": 0,      "currency": "string",      "isPreferred": true,      "minOrderQuantity": 0,      "orderMultiple": 0,      "leadTimeDays": 0,      "isActive": true,      "externalId": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "customAttributes": [    {      "valueType": "text",      "textValue": "string",      "numberValue": 0,      "booleanValue": true,      "dateValue": "2019-08-24",      "urlValue": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",      "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",      "customerAssetId": 1,      "key": "string",      "label": "string",      "position": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "manufacturerPartNumber": "string",  "currency": "string",  "unitOfMeasure": "string"}

Path Parameters

organizationId*string

Formatuuid

Request Body

application/json

The product payload.

TypeScript Definitions

Use the request body type in TypeScript.

categoryIds?array<>

tagIds?array<>

Itemsitems <= 100

name*string

Length1 <= length <= 240

slug?string

Match^[a-z0-9]+(?:-[a-z0-9]+)*$

Length1 <= length <= 160

description?|

Lengthlength <= 4000

brandId?|null

manufacturer?|

Lengthlength <= 240

model?|

Lengthlength <= 240

sku?|

Lengthlength <= 120

ean?|

Lengthlength <= 120

defaultPurchasePrice?|

Range0 <= value

defaultSellingPrice?|

Range0 <= value

vatPercentage?|

Range0 <= value <= 100

status?string

Value in

"active"
"discontinued"
"archived"

manufacturerPartNumber?|

Lengthlength <= 240

currency?|null

unitOfMeasure?|

Lengthlength <= 240

{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "categoryIds": [ "7a99018c-b68f-4d32-be08-29a0cbea434a" ], "categories": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43", "name": "string", "slug": "string", "icon": "string", "description": "string", "position": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "name": "string", "slug": "string", "description": "string", "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5", "brand": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "name": "string", "slug": "string", "description": "string", "website": "string", "logoUrl": "http://example.com", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "manufacturer": "string", "model": "string", "sku": "string", "ean": "string", "defaultPurchasePrice": 0, "defaultSellingPrice": 0, "vatPercentage": 0, "status": "active", "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e", "updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "tags": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "kind": "task", "name": "string", "slug": "string", "color": "string", "description": "string", "position": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "images": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113", "url": "http://example.com", "altText": "string", "position": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "suppliers": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113", "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db", "supplier": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "name": "string", "email": "string", "phone": "string", "website": "string", "notes": "string", "status": "active", "code": "string", "accountNumber": "string", "kvk": "string", "btw": "string", "orderingEmail": "string", "billingEmail": "string", "addressLine1": "string", "addressLine2": "string", "addressCity": "string", "addressState": "string", "addressPostalCode": "string", "addressCountry": "string", "currency": "string", "paymentTermsDays": 0, "defaultLeadTimeDays": 0, "defaultInventoryLocationId": "39ba1a59-f7f9-4e8f-a32f-270329b3f772", "source": "string", "externalId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "supplierSku": "string", "orderCode": "string", "unitCost": 0, "currency": "string", "isPreferred": true, "minOrderQuantity": 0, "orderMultiple": 0, "leadTimeDays": 0, "isActive": true, "externalId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "customAttributes": [ { "valueType": "text", "textValue": "string", "numberValue": 0, "booleanValue": true, "dateValue": "2019-08-24", "urlValue": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113", "customerAssetId": 1, "key": "string", "label": "string", "position": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "manufacturerPartNumber": "string", "currency": "string", "unitOfMeasure": "string"}

Create a product.

Create a product.

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`