get/items

Summary

Get products

Description

Get a list of products, optionally filtered by query parameters.

Parameters

Query

createdBefore

string

Filter jobs created before or in the specified date.

Format

date

createdAfter

string

Format

date

code

string

Filter products by code.

name

string

Filter products by name.

Responses

200

Product list.

Response type

application/json

Response content

Array<Product>

400

Invalid query parameters.

Response type

application/json

Response content

Error

500

Failed to get products.

Response type

application/json

Response content

Error

post/items

Summary

Create products

Description

Create one or more products.

Request body required

Request type

application/json

Request content

ProductArray<Product>

Responses

200

Products upserted successfully.

Response type

application/json

Response content

Array<Product>

400

Invalid product data.

Response type

application/json

Response content

Error

500

Failed to upsert products.

Response type

application/json

Response content

Error

put/items/{itemCode}

Summary

Update a product.

Description

Update data for a product.

Parameters

Path

itemCode

string
required

Product code.

Query

overwrite_product_bom

boolean

Overwrite bill of materials of products that are used in the picking list of phases for each of the updated production orders.

Request body required

Request type

application/json

Request content

Product

Responses

200

Product updated successfully.

Response type

application/json

Response content

Product

400

Invalid request payload.

Response type

application/json

Response content

Error

404

Product not found.

Response type

application/json

Response content

Error

500

Failed to update product.

Response type

application/json

Response content

Error

delete/items/{itemCode}

Summary

Delete a product.

Description

Delete a product.

Parameters

Path

itemCode

string
required

Product code.

Responses

200

Product deleted successfully.

Response type

application/json

Response content

Success

404

Product not found.

Response type

application/json

Response content

Error

500

Failed to delete product.

Response type

application/json

Response content

Error