Tags

ADD Tags to a Specific Production Item

Description: This method allows you to add tags to a specific production item (line item) in an order. Optionally, you can choose to apply the tags to nested (child) production items as well.

Method

POST /api/orders/{external_order_id}/line-items/{line_item_id}/tags

Returns

200 OK if the tags are successfully added.

Permissions required

• Authorized access to manage orders and production items.

Request

• Headers:

  • x-tenant-id (string, UUID v4) - Tenant ID Example: 40dd0c53-2fa7-4193-82ae-14d4e62c20fb

• Body (application/json):

{
    "tags": ["new", "vip_client"],
    "apply_to_nested_productions": "true"
}

Request body parameters:

• tags (string, required) — A list of tags to be added to the production item.

  Example: ["Rush order", "High priority"]

• apply_to_nested_productions (boolean, optional) — Determines if the tags should be applied to nested (child) production items.

  • "true" — Tags are inherited by nested productions.

  • "false" — Tags are not inherited by nested productions.

  • Default option: "false" if not specified.

Path Parameters:

• external_order_id (string, required) — The unique identifier of the order.

  • Example: b86fa12a-76fc-46f5-8a3e-bf39e7be4c4e

• line_item_id (string, required) — The unique identifier of the production item.

  • Example: 557657-8654-89i76

Response

• 200 OK: Tags were successfully added to the specified production item.

{
    "message": "Tags successfully added to the production item."
}

Error Codes:

• 400 Bad Request — One or more parameters are missing or incorrect.

• 404 Order not found —The specified external_order_id does not exist.

• 404 Line item not found — The specified line_item_id does not exist.

• 409 Tag already exists — One or more of the tags already exist for this production item.

• 500 Internal Server Error — Server-side error occurred.

Notes

• If all parameters are passed correctly, the system adds the specified tags to the selected production item (line item) and all its nested production items (child productions), if they exist, provided that the apply_to_nested_productions parameter is set to true.

• If the apply_to_nested_productions parameter is not provided, the system adds the tags only to the main production item (line item), and the nested production items (child productions) remain unchanged.

• If at least one parameter is missing or incorrect, the system returns a 400 Bad Request error, indicating incomplete or invalid data in the request.

---

ADD Tags to All Productions Associated with the Order

Adds specified tags to all productions (line items) linked to a given order. Optionally, it can also add these tags to all nested (child) productions if specified.

Method

POST api/orders/{external_order_id}/tags

Returns

The method returns a successful response of the added tags for all productions in this order, otherwise an error status.

Permissions Required

• Write access to the order.

Request

• Headers:

  • x-tenant-id (string, UUID v4) - Tenant ID Example: 40dd0c53-2fa7-4193-82ae-14d4e62c20fb

• Body (application/json):

{
  "tags": ["new", "vip_client"],
  "apply_to_nested_productions": true
}

• Body Parameters:

  • tags (string, required) — A list of tags to be added to the production item.

    Example: ["Rush order", "High priority"]

  • apply_to_nested_productions (boolean, optional) — Determines if the tags should be applied to nested (child) production items.

    • "true" — Tags are inherited by nested productions.

    • "false" — Tags are not inherited by nested productions.

    • Default option: "false" if not specified.

Path Parameters:

• external_order_id(string, required)— The unique identifier of the order used as a reference ID to link up ordered items to the order.

Response

• 200 OK: Tags were successfully added to the order.

{
    "message": "Tags successfully added to the order."
}

Error Codes:

• 400 Bad Request — One or more parameters are missing or incorrect.

• 404 Order not found —The specified external_order_id does not exist.

• 409 Tag already exists — One or more of the tags already exist for this production item.

• 500 Internal Server Error — Server-side error occurred.

Notes

• If all parameters are passed correctly, The system adds the tags that were passed in this request to all line items (productions), connected with the order, which ID was passed in the request, with adding the subitems (child productions).

• If the apply_to_nested_productions parameter is not provided, the system adds the tags that were passed in this request to all line items (productions), connected with the order, which ID was passed in the request, without adding the subitems (child productions) if the line items (productions) have any.

• If at least one parameter is missing or incorrect, the system returns a 400 Bad Request error, indicating incomplete or invalid data in the request.

---

REPLACE Tags for a Specific Production Item

This method allows to replaces existing tags with the specified list of new tags for a specific line item (production). Optionally, it can also replace tags for all nested (child) productions if specified.

Method

PUT /api/orders/{external_order_id}/line-items/{line_item_id}/tags

Returns

The method returns a successful response of the updated tags for the specific line item(-s) (productions), otherwise an error status.

Permissions Required

• Write access to the order and its line items.

Request

• Headers:

  • x-tenant-id (string, UUID v4) - Tenant ID Example: 40dd0c53-2fa7-4193-82ae-14d4e62c20fb

• Body (application/json):

{
  "tags": ["new", "vip_client"],
  "apply_to_nested_productions": true
}

• Body Parameters:

  • tags (string, required) — A list of tags to be added to the production item.

    Example: ["Rush order", "High priority"]

  • apply_to_nested_productions (boolean, optional) — Determines if the tags should be applied to nested (child) production items.

    • "true" — Tags are inherited by nested productions.

    • "false" — Tags are not inherited by nested productions.

    • Default option: "false" if not specified.

Path Parameters:

• external_order_id(string, required)— The unique identifier of the order used as a reference ID to link up ordered items to the order.

• line_item_id (string, required) — The unique identifier of the production item.

  • Example: 557657-8654-89i76

Response

• 200 OK: Tags were successfully updated to the production item.

{
    "message": "Tags successfully replaced to the production item."
}

Error Codes:

• 400 Bad Request — One or more parameters are missing or incorrect.

• 404 Order not found —The specified external_order_id does not exist.

• 404 Line item not found — The specified line_item_id does not exist.

• 500 Internal Server Error — Server-side error occurred.

Notes

• If all parameters are passed correctly, the system replaces the tags that were passed in this request for the line items (productions), which IDs were passed in the request with replacing tags of the subitems (child productions) if the specified line items (productions) have any.

• If the apply_to_nested_productions parameter is not provided, the system replaces the tags that were passed in this request for the line items (productions), which IDs were passed in the request without replacing tags of the subitems (child productions) if the specified line items (productions) have any.

• If at least one parameter is missing or incorrect, the system returns a 400 Bad Request error, indicating incomplete or invalid data in the request.

---

REPLACE Tags for All Productions Associated with the Order

This method allows to replaces existing tags with the specified list of new tags for all productions in this order. Optionally, it can also replace tags for all nested (child) productions if specified.

Method

PUT /api/orders/{external_order_id}/tags

Returns

The method returns a successful response of the updated tags for all productions in this order, otherwise an error status.

Permissions Required

• Write access to the order.

Request

• Headers:

  • x-tenant-id (string, UUID v4) - Tenant ID Example: 40dd0c53-2fa7-4193-82ae-14d4e62c20fb

• Body (application/json):

{
  "tags": ["new", "vip_client"],
  "apply_to_nested_productions": true
}

• Body Parameters:

  • tags (string, required) — A list of tags to be added to the production item.

    Example: ["Rush order", "High priority"]

  • apply_to_nested_productions (boolean, optional) — Determines if the tags should be applied to nested (child) production items.

    • "true" — Tags are inherited by nested productions.

    • "false" — Tags are not inherited by nested productions.

    • Default option: "false" if not specified.

Path Parameters:

• external_order_id(string, required)— The unique identifier of the order used as a reference ID to link up ordered items to the order.

Response

• 200 OK: Tags were successfully updated to the order.

{
    "message": "Tags successfully replaced to the order."
}

Error Codes:

• 400 Bad Request — One or more parameters are missing or incorrect.

• 404 Order not found —The specified external_order_id does not exist.

• 500 Internal Server Error — Server-side error occurred.

Notes

• If all parameters are passed correctly, the system replaces the tags that were passed in this request for the all line items (productions), which IDs were passed in the request with replacing tags of the subitems (child productions) if the specified line items (productions) have any.

• If the apply_to_nested_productions parameter is not provided, the system replaces the tags that were passed in this request for the all line items (productions), which IDs were passed in the request without replacing tags of the subitems (child productions) if the specified line items (productions) have any.

• If at least one parameter is missing or incorrect, the system returns a 400 Bad Request error, indicating incomplete or invalid data in the request.

---

DELETE Tags for a Specific Production Item

This method allows to delete existing tags with the specified list of new tags for a specific line item (production). Optionally, it can also delete tags for all nested (child) productions if specified.

Method

DELETE api/orders/{external_order_id}/line-items/{line_item_id}/tags?tags=[string], apply_to_nested_productions={boolean}

Returns

The method returns a successful response of the deleted tags for the specific line item(-s) (productions), otherwise an error status.

Permissions Required

• Write access to the order and its line items.

Request

• Headers:

  • x-tenant-id (string, UUID v4) - Tenant ID Example: 40dd0c53-2fa7-4193-82ae-14d4e62c20fb

• Body Parameters:

  • tags (string, required) — A list of tags to be added to the production item.

    Example: ["Rush order", "High priority"]

  • apply_to_nested_productions (boolean, optional) — Determines if the tags should be applied to nested (child) production items.

    • "true" — Tags are inherited by nested productions.

    • "false" — Tags are not inherited by nested productions.

    • Default option: "false" if not specified.

Path Parameters:

• external_order_id(string, required)— The unique identifier of the order used as a reference ID to link up ordered items to the order.

• line_item_id (string, required) — The unique identifier of the production item.

  • Example: 557657-8654-89i76

Response

• 200 OK: Tags were successfully deleted to the production item.

{
    "message": "Tags successfully deleted to the production item."
}

Error Codes:

• 400 Bad Request — One or more parameters are missing or incorrect.

• 404 Order not found —The specified external_order_id does not exist.

• 404 Line item not found — The specified line_item_id does not exist.

• 500 Internal Server Error — Server-side error occurred.

Notes

• If all parameters are passed correctly, the system deletes the tags that were passed in this request for the line items (productions), which IDs were passed in the request with deleting tags of the subitems (child productions) if the specified line items (productions) have any.

• If the apply_to_nested_productions parameter is not provided, the system deletes the tags that were passed in this request for the line items (productions), which IDs were passed in the request without deleting tags of the subitems (child productions) if the specified line items (productions) have any.

• If at least one parameter is missing or incorrect, the system returns a 400 Bad Request error, indicating incomplete or invalid data in the request.

---

DELETE Tags for All Productions Associated with the Order

This method allows to delete existing tags with the specified list of new tags for all productions in this order. Optionally, it can also delete tags for all nested (child) productions if specified.

Method

PUT api/orders/{external_order_id}/tags?tags=[string], apply_to_nested_productions={boolean}

Returns

The method returns a successful response of the deleted tags for all productions in this order, otherwise an error status.

Permissions Required

• Write access to the order.

Request

• Headers:

  • x-tenant-id (string, UUID v4) - Tenant ID Example: 40dd0c53-2fa7-4193-82ae-14d4e62c20fb

• Body Parameters:

  • tags (string, required) — A list of tags to be added to the production item.

    Example: ["Rush order", "High priority"]

  • apply_to_nested_productions (boolean, optional) — Determines if the tags should be applied to nested (child) production items.

    • "true" — Tags are inherited by nested productions.

    • "false" — Tags are not inherited by nested productions.

    • Default option: "false" if not specified.

Path Parameters:

• external_order_id(string, required)— The unique identifier of the order used as a reference ID to link up ordered items to the order.

Response

• 200 OK: Tags were successfully deleted to the order.

{
    "message": "Tags successfully deleted to the order."
}

Error Codes:

• 400 Bad Request — One or more parameters are missing or incorrect.

• 404 Order not found —The specified external_order_id does not exist.

• 500 Internal Server Error — Server-side error occurred.

Notes

• If all parameters are passed correctly, the system deletes the tags that were passed in this request for the all line items (productions), which IDs were passed in the request with deleting tags of the subitems (child productions).

• If the apply_to_nested_productions parameter is not provided, the system deletes the tags that were passed in this request for the all line items (productions), which IDs were passed in the request without deleting tags of the subitems (child productions).

• If at least one parameter is missing or incorrect, the system returns a 400 Bad Request error, indicating incomplete or invalid data in the request.