get/jobs

Summary

Get production orders

Description

Get a list of production orders, optionally filtered by query parameters.

Parameters

Query

createdBefore

string

Filter jobs created before or in the specified date.

Format

date

createdAfter

string

Filter jobs created after or in the specified date.

Format

date

code

string

Filter jobs by code.

customer

string

Filter jobs by customer code.

salesOrderId

string

Filter jobs by sales order ID.

status

string

Filter jobs in the specified production status.

Responses

200

Job list.

Response type

application/json

Response content

Array<Job>

400

Invalid query parameters.

Response type

application/json

Response content

Error

500

Failed to get jobs.

Response type

application/json

Response content

Error

post/jobs

Summary

Create production orders

Description

Create one or more production orders.

Parameters

Query

overwrite_product_bom

boolean

Overwrite product BOM.

default_dependencies

boolean

Will set default phase dependencies. If true, each phase will be dependent on the previous one with a "DELIVERED_PARTIALLY" relationship.

Request body required

Request type

application/json

Request content

JobArray<Job>

Responses

200

Jobs upserted successfully.

Response type

application/json

Response content

Array<Job>

400

Invalid production order data.

Response type

application/json

Response content

Error

500

Failed to upsert production orders.

Response type

application/json

Response content

Error

put/jobs/{jobCode}

Summary

Update a production order.

Description

Update data for a production order.

Parameters

Path

jobCode

string
required

Production order 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

Job

Responses

200

Production order updated successfully.

Response type

application/json

Response content

Job

400

Invalid request payload.

Response type

application/json

Response content

Error

404

Production order not found.

Response type

application/json

Response content

Error

500

Failed to update production order.

Response type

application/json

Response content

Error

delete/jobs/{jobCode}

Summary

Delete a production order.

Description

Delete a production order.

Parameters

Path

jobCode

string
required

Production order code.

Responses

200

Production order deleted successfully.

Response type

application/json

Response content

Success

400

Production order cannot be deleted: is either currently in production or already completed.

Response type

application/json

Response content

Error

404

Production order not found.

Response type

application/json

Response content

Error

500

Failed to delete production order.

Response type

application/json

Response content

Error