Purple SCM API Documentation

Machine-readable OpenAPI 3.0 specification: https://marketplace.moveworks.com/api/purple-suite/scm/openapi.json

The consolidated all-apps document at https://marketplace.moveworks.com/api/purple-suite/openapi.json can be narrowed to this app with ?apps=scm, or combined with other apps comma-separated (e.g. ?apps=scm,itsm).

Overview

--- **Acting as a user (`X-PS-Impersonate-User`).** Every endpoint accepts an optional `X-PS-Impersonate-User` request header whose value is the email of the instance user to act as. The effective user resolves in this order: the header if present, else the instance's configured default MCP user, else none. User-scoped paths additionally accept the literal `me` in place of an email, and Graph-style apps also serve `/me/…` twins of their `/users/{email}/…` paths that resolve the same way. This header is honored by all operations but is intentionally omitted from each operation's parameter list so it is not surfaced as a per-tool argument by MCP clients; see the `ImpersonateUser` entry under `components.parameters`.

Endpoints

`GET` `/api/purple-suite/scm/suppliers`

List suppliers

Purple SCM suppliers are the vendors the company sources physical goods and services from, with category, country, quality rating, onboarding date and status (active | inactive | pending_approval | blacklisted). Supply-chain vendor master, distinct from ERP finance vendors and from CRM accounts (customers). Filter/sort server-side with $filter, $orderby, $select, $search, $top, $skip and $count (MCP clients send these as _filter, _orderby, …) rather than listing everything and filtering locally.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes
`limit`	query	integer	no	Legacy page size (default 50). Prefer $top. Ignored when $top/$skip are used.
`cursor`	query	string	no	Legacy keyset cursor — pass the previous response's nextCursor. Prefer $skip/$top.
`$filter`	query	string	no	OData filter expression. Comparison operators: eq, ne, gt, ge, lt, le. Logical: and, or, not, with parentheses for grouping. String functions: contains(field,'x'), startswith(field,'x'), endswith(field,'x'). Membership: field in ('a','b'). Case-insensitive matching via tolower(field) / toupper(field). Nested fields use a slash, e.g. pto_balance/vacation_days. String literals use single quotes; dates are ISO-8601. Examples: "status eq 'active'"; "salary gt 50000 and department eq 'Engineering'"; "contains(tolower(name),'acme')"; "closeDate gt 2026-01-01".
`$select`	query	string	no	Comma-separated list of fields to return, e.g. "id,firstName,email". Nested fields via slash ("pto_balance/vacation_days"). The id field is always included.
`$orderby`	query	string	no	Sort clause(s), comma-separated, each "field [asc\|desc]" (asc is the default). Example: "createdAt desc, lastName asc". Null values sort last.
`$search`	query	string	no	Free-text, case-insensitive substring match across the resource's searchable fields.
`$top`	query	integer	no	Maximum number of items to return (page size).
`$skip`	query	integer	no	Number of matching items to skip before returning results (offset paging). Combine with $top.
`$count`	query	boolean	no	When true, include @odata.count (total matches after $filter/$search, before paging) in the response.

Responses

200

Paginated list

application/json

data array
array of:
Supplier
- id string
- name string
- status string
- category string
- country string
- rating integer
- onboardedAt string
- createdAt string
- updatedAt string
nextCursor string — Cursor for the next page, or null on the last page. With $top/$skip this is the next $skip value; otherwise a keyset cursor.
total integer — Total documents in the collection.
@odata.count integer — Present only when $count=true: total matches after $filter/$search.
@odata.truncated boolean — Present and true only when the collection exceeded the in-memory query cap and results may be incomplete.

400

Invalid OData query (e.g. malformed $filter)

`POST` `/api/purple-suite/scm/suppliers`

Onboard supplier

Add a supplier to the Purple SCM vendor master with its category, country and rating. New suppliers usually start pending_approval; search the existing list first to avoid duplicates.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes

Request body

application/json — required

Supplier

id string
name string
status string
category string
country string
rating integer
onboardedAt string
createdAt string
updatedAt string

Responses

201

Created

application/json

Supplier

id string
name string
status string
category string
country string
rating integer
onboardedAt string
createdAt string
updatedAt string

`GET` `/api/purple-suite/scm/suppliers/{id}`

Get supplier

Fetch one supplier by id (e.g. SUP-0001) with its status, category, country and rating — the record behind sourcing, contract and quality questions.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes
`id`	path	string	yes

Responses

200

Found

application/json

Supplier

id string
name string
status string
category string
country string
rating integer
onboardedAt string
createdAt string
updatedAt string

404

Not found

`DELETE` `/api/purple-suite/scm/suppliers/{id}`

Delete supplier

Permanently delete a supplier from the vendor master. Destructive and irreversible, and it orphans their contracts, purchase orders, shipments and quality lots — set status to 'inactive' or 'blacklisted' instead.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes
`id`	path	string	yes

Responses

200

Deleted

application/json

success boolean

404

Not found

`PATCH` `/api/purple-suite/scm/suppliers/{id}`

Update supplier

Partially update a supplier — change category, country or rating, or move its status. Setting status to 'blacklisted' stops future sourcing from them and should be deliberate.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes
`id`	path	string	yes

Request body

Fields to update (partial)

application/json

Supplier

id string
name string
status string
category string
country string
rating integer
onboardedAt string
createdAt string
updatedAt string

Responses

200

Updated

application/json

Supplier

id string
name string
status string
category string
country string
rating integer
onboardedAt string
createdAt string
updatedAt string

404

Not found

`GET` `/api/purple-suite/scm/contracts`

List supplier contracts

Purple SCM contracts are the commercial agreements with a supplier (master supply agreements and similar) with value, start/end dates, auto-renew flag and status draft | active | signed | expired | cancelled. Supplier agreements, not customer contracts or purchase orders. Filter/sort server-side with $filter, $orderby, $select, $search, $top, $skip and $count (MCP clients send these as _filter, _orderby, …) rather than listing everything and filtering locally.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes
`limit`	query	integer	no	Legacy page size (default 50). Prefer $top. Ignored when $top/$skip are used.
`cursor`	query	string	no	Legacy keyset cursor — pass the previous response's nextCursor. Prefer $skip/$top.
`$filter`	query	string	no	OData filter expression. Comparison operators: eq, ne, gt, ge, lt, le. Logical: and, or, not, with parentheses for grouping. String functions: contains(field,'x'), startswith(field,'x'), endswith(field,'x'). Membership: field in ('a','b'). Case-insensitive matching via tolower(field) / toupper(field). Nested fields use a slash, e.g. pto_balance/vacation_days. String literals use single quotes; dates are ISO-8601. Examples: "status eq 'active'"; "salary gt 50000 and department eq 'Engineering'"; "contains(tolower(name),'acme')"; "closeDate gt 2026-01-01".
`$select`	query	string	no	Comma-separated list of fields to return, e.g. "id,firstName,email". Nested fields via slash ("pto_balance/vacation_days"). The id field is always included.
`$orderby`	query	string	no	Sort clause(s), comma-separated, each "field [asc\|desc]" (asc is the default). Example: "createdAt desc, lastName asc". Null values sort last.
`$search`	query	string	no	Free-text, case-insensitive substring match across the resource's searchable fields.
`$top`	query	integer	no	Maximum number of items to return (page size).
`$skip`	query	integer	no	Number of matching items to skip before returning results (offset paging). Combine with $top.
`$count`	query	boolean	no	When true, include @odata.count (total matches after $filter/$search, before paging) in the response.

Responses

200

Paginated list

application/json

data array
array of:
Contract
- id string
- supplierId string
- title string
- status string
- value number
- startDate string
- endDate string
- autoRenew boolean
- createdAt string
- updatedAt string
nextCursor string — Cursor for the next page, or null on the last page. With $top/$skip this is the next $skip value; otherwise a keyset cursor.
total integer — Total documents in the collection.
@odata.count integer — Present only when $count=true: total matches after $filter/$search.
@odata.truncated boolean — Present and true only when the collection exceeded the in-memory query cap and results may be incomplete.

400

Invalid OData query (e.g. malformed $filter)

`POST` `/api/purple-suite/scm/contracts`

Create supplier contract

Draft a new commercial agreement with a supplier, with its term dates, value and auto-renew flag. Also the correct move when an expired contract needs replacing, since expired contracts cannot be reactivated.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes

Request body

application/json — required

Contract

id string
supplierId string
title string
status string
value number
startDate string
endDate string
autoRenew boolean
createdAt string
updatedAt string

Responses

201

Created

application/json

Contract

id string
supplierId string
title string
status string
value number
startDate string
endDate string
autoRenew boolean
createdAt string
updatedAt string

`GET` `/api/purple-suite/scm/contracts/{id}`

Get supplier contract

Fetch one contract by id (e.g. CON-0001) with its supplier, value, term dates, auto-renew flag and status — the check before raising a PO against it or letting it lapse.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes
`id`	path	string	yes

Responses

200

Found

application/json

Contract

id string
supplierId string
title string
status string
value number
startDate string
endDate string
autoRenew boolean
createdAt string
updatedAt string

404

Not found

`DELETE` `/api/purple-suite/scm/contracts/{id}`

Delete supplier contract

Permanently delete a contract record. Destructive and irreversible, and it removes the commercial history — set status to 'cancelled' or let it expire instead.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes
`id`	path	string	yes

Responses

200

Deleted

application/json

success boolean

404

Not found

`PATCH` `/api/purple-suite/scm/contracts/{id}`

Update supplier contract

Partially update a contract — revise value, dates or auto-renew, or move its status. The state machine blocks two moves (422): an expired contract cannot be returned to active/draft (create a new one), and a cancelled contract cannot be signed.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes
`id`	path	string	yes

Request body

Fields to update (partial)

application/json

Contract

id string
supplierId string
title string
status string
value number
startDate string
endDate string
autoRenew boolean
createdAt string
updatedAt string

Responses

200

Updated

application/json

Contract

id string
supplierId string
title string
status string
value number
startDate string
endDate string
autoRenew boolean
createdAt string
updatedAt string

404

Not found

`GET` `/api/purple-suite/scm/shipments`

List inbound shipments

Purple SCM shipments are inbound freight from suppliers, with carrier (FedEx | UPS | DHL | USPS | Maersk | MSC), tracking number, origin, destination, estimated delivery and status pending | in_transit | out_for_delivery | delivered | exception | cancelled. Use for 'where is my delivery' questions. Filter/sort server-side with $filter, $orderby, $select, $search, $top, $skip and $count (MCP clients send these as _filter, _orderby, …) rather than listing everything and filtering locally.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes
`limit`	query	integer	no	Legacy page size (default 50). Prefer $top. Ignored when $top/$skip are used.
`cursor`	query	string	no	Legacy keyset cursor — pass the previous response's nextCursor. Prefer $skip/$top.
`$filter`	query	string	no	OData filter expression. Comparison operators: eq, ne, gt, ge, lt, le. Logical: and, or, not, with parentheses for grouping. String functions: contains(field,'x'), startswith(field,'x'), endswith(field,'x'). Membership: field in ('a','b'). Case-insensitive matching via tolower(field) / toupper(field). Nested fields use a slash, e.g. pto_balance/vacation_days. String literals use single quotes; dates are ISO-8601. Examples: "status eq 'active'"; "salary gt 50000 and department eq 'Engineering'"; "contains(tolower(name),'acme')"; "closeDate gt 2026-01-01".
`$select`	query	string	no	Comma-separated list of fields to return, e.g. "id,firstName,email". Nested fields via slash ("pto_balance/vacation_days"). The id field is always included.
`$orderby`	query	string	no	Sort clause(s), comma-separated, each "field [asc\|desc]" (asc is the default). Example: "createdAt desc, lastName asc". Null values sort last.
`$search`	query	string	no	Free-text, case-insensitive substring match across the resource's searchable fields.
`$top`	query	integer	no	Maximum number of items to return (page size).
`$skip`	query	integer	no	Number of matching items to skip before returning results (offset paging). Combine with $top.
`$count`	query	boolean	no	When true, include @odata.count (total matches after $filter/$search, before paging) in the response.

Responses

200

Paginated list

application/json

data array
array of:
Shipment
- id string
- supplierId string
- status string
- carrier string
- trackingNumber string
- origin string
- destination string
- estimatedDelivery string
- createdAt string
- updatedAt string
nextCursor string — Cursor for the next page, or null on the last page. With $top/$skip this is the next $skip value; otherwise a keyset cursor.
total integer — Total documents in the collection.
@odata.count integer — Present only when $count=true: total matches after $filter/$search.
@odata.truncated boolean — Present and true only when the collection exceeded the in-memory query cap and results may be incomplete.

400

Invalid OData query (e.g. malformed $filter)

`POST` `/api/purple-suite/scm/shipments`

Create shipment

Record an inbound shipment from a supplier with its carrier, tracking number, origin, destination and estimated delivery.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes

Request body

application/json — required

Shipment

id string
supplierId string
status string
carrier string
trackingNumber string
origin string
destination string
estimatedDelivery string
createdAt string
updatedAt string

Responses

201

Created

application/json

Shipment

id string
supplierId string
status string
carrier string
trackingNumber string
origin string
destination string
estimatedDelivery string
createdAt string
updatedAt string

`GET` `/api/purple-suite/scm/shipments/{id}`

Get shipment

Fetch one shipment by id (e.g. SHIP-0001) with its carrier, tracking number, route, ETA and current status — the record to quote when tracking a delivery.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes
`id`	path	string	yes

Responses

200

Found

application/json

Shipment

id string
supplierId string
status string
carrier string
trackingNumber string
origin string
destination string
estimatedDelivery string
createdAt string
updatedAt string

404

Not found

`DELETE` `/api/purple-suite/scm/shipments/{id}`

Delete shipment

Permanently delete a shipment record. Destructive and irreversible, and it loses the delivery trail — cancel an undelivered shipment via a status update instead.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes
`id`	path	string	yes

Responses

200

Deleted

application/json

success boolean

404

Not found

`PATCH` `/api/purple-suite/scm/shipments/{id}`

Update shipment

Partially update a shipment — advance its status, correct the ETA or fix carrier/tracking details. Status only moves forward through pending → in_transit → out_for_delivery → delivered (going backwards is rejected with 422), and a delivered shipment cannot be cancelled.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes
`id`	path	string	yes

Request body

Fields to update (partial)

application/json

Shipment

id string
supplierId string
status string
carrier string
trackingNumber string
origin string
destination string
estimatedDelivery string
createdAt string
updatedAt string

Responses

200

Updated

application/json

Shipment

id string
supplierId string
status string
carrier string
trackingNumber string
origin string
destination string
estimatedDelivery string
createdAt string
updatedAt string

404

Not found

`GET` `/api/purple-suite/scm/purchase_orders`

List supply-chain purchase orders

Purple SCM purchase orders are procurement POs raised on a supplier for goods (SCMPO-####), with total amount, line-item count, delivery date and status draft | submitted | approved | received | cancelled. This is the supply-chain view; the finance/ERP purchase-order ledger is a separate system with its own ids. Filter/sort server-side with $filter, $orderby, $select, $search, $top, $skip and $count (MCP clients send these as _filter, _orderby, …) rather than listing everything and filtering locally.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes
`limit`	query	integer	no	Legacy page size (default 50). Prefer $top. Ignored when $top/$skip are used.
`cursor`	query	string	no	Legacy keyset cursor — pass the previous response's nextCursor. Prefer $skip/$top.
`$filter`	query	string	no	OData filter expression. Comparison operators: eq, ne, gt, ge, lt, le. Logical: and, or, not, with parentheses for grouping. String functions: contains(field,'x'), startswith(field,'x'), endswith(field,'x'). Membership: field in ('a','b'). Case-insensitive matching via tolower(field) / toupper(field). Nested fields use a slash, e.g. pto_balance/vacation_days. String literals use single quotes; dates are ISO-8601. Examples: "status eq 'active'"; "salary gt 50000 and department eq 'Engineering'"; "contains(tolower(name),'acme')"; "closeDate gt 2026-01-01".
`$select`	query	string	no	Comma-separated list of fields to return, e.g. "id,firstName,email". Nested fields via slash ("pto_balance/vacation_days"). The id field is always included.
`$orderby`	query	string	no	Sort clause(s), comma-separated, each "field [asc\|desc]" (asc is the default). Example: "createdAt desc, lastName asc". Null values sort last.
`$search`	query	string	no	Free-text, case-insensitive substring match across the resource's searchable fields.
`$top`	query	integer	no	Maximum number of items to return (page size).
`$skip`	query	integer	no	Number of matching items to skip before returning results (offset paging). Combine with $top.
`$count`	query	boolean	no	When true, include @odata.count (total matches after $filter/$search, before paging) in the response.

Responses

200

Paginated list

application/json

data array
array of:
PurchaseOrder
- id string
- supplierId string
- status string
- totalAmount number
- lineItems integer
- deliveryDate string
- createdAt string
- updatedAt string
nextCursor string — Cursor for the next page, or null on the last page. With $top/$skip this is the next $skip value; otherwise a keyset cursor.
total integer — Total documents in the collection.
@odata.count integer — Present only when $count=true: total matches after $filter/$search.
@odata.truncated boolean — Present and true only when the collection exceeded the in-memory query cap and results may be incomplete.

400

Invalid OData query (e.g. malformed $filter)

`POST` `/api/purple-suite/scm/purchase_orders`

Create purchase order

Raise a purchase order on a supplier with total amount, line items and requested delivery date. New POs start in draft/submitted; approve them by updating status.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes

Request body

application/json — required

PurchaseOrder

id string
supplierId string
status string
totalAmount number
lineItems integer
deliveryDate string
createdAt string
updatedAt string

Responses

201

Created

application/json

PurchaseOrder

id string
supplierId string
status string
totalAmount number
lineItems integer
deliveryDate string
createdAt string
updatedAt string

`GET` `/api/purple-suite/scm/purchase_orders/{id}`

Get purchase order

Fetch one supply-chain purchase order by id (e.g. SCMPO-0001) with its supplier, total amount, line items, delivery date and status.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes
`id`	path	string	yes

Responses

200

Found

application/json

PurchaseOrder

id string
supplierId string
status string
totalAmount number
lineItems integer
deliveryDate string
createdAt string
updatedAt string

404

Not found

`DELETE` `/api/purple-suite/scm/purchase_orders/{id}`

Delete purchase order

Permanently delete a purchase order. Destructive and irreversible, and it breaks the audit trail against the supplier — set status to 'cancelled' instead.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes
`id`	path	string	yes

Responses

200

Deleted

application/json

success boolean

404

Not found

`PATCH` `/api/purple-suite/scm/purchase_orders/{id}`

Update purchase order

Partially update a purchase order, including approving it (status 'approved') or cancelling it. The state machine rejects (422) cancelling a PO already received or in transit, and approving a cancelled PO.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes
`id`	path	string	yes

Request body

Fields to update (partial)

application/json

PurchaseOrder

id string
supplierId string
status string
totalAmount number
lineItems integer
deliveryDate string
createdAt string
updatedAt string

Responses

200

Updated

application/json

PurchaseOrder

id string
supplierId string
status string
totalAmount number
lineItems integer
deliveryDate string
createdAt string
updatedAt string

404

Not found

`GET` `/api/purple-suite/scm/quality_lots`

List quality inspection lots

Purple SCM quality lots are received batches of goods under incoming inspection, with item SKU, quantity, supplier, defect rate, inspector and status pending | in_inspection | passed | failed | quarantined. Use these for supplier quality and defect-rate questions. Filter/sort server-side with $filter, $orderby, $select, $search, $top, $skip and $count (MCP clients send these as _filter, _orderby, …) rather than listing everything and filtering locally.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes
`limit`	query	integer	no	Legacy page size (default 50). Prefer $top. Ignored when $top/$skip are used.
`cursor`	query	string	no	Legacy keyset cursor — pass the previous response's nextCursor. Prefer $skip/$top.
`$filter`	query	string	no	OData filter expression. Comparison operators: eq, ne, gt, ge, lt, le. Logical: and, or, not, with parentheses for grouping. String functions: contains(field,'x'), startswith(field,'x'), endswith(field,'x'). Membership: field in ('a','b'). Case-insensitive matching via tolower(field) / toupper(field). Nested fields use a slash, e.g. pto_balance/vacation_days. String literals use single quotes; dates are ISO-8601. Examples: "status eq 'active'"; "salary gt 50000 and department eq 'Engineering'"; "contains(tolower(name),'acme')"; "closeDate gt 2026-01-01".
`$select`	query	string	no	Comma-separated list of fields to return, e.g. "id,firstName,email". Nested fields via slash ("pto_balance/vacation_days"). The id field is always included.
`$orderby`	query	string	no	Sort clause(s), comma-separated, each "field [asc\|desc]" (asc is the default). Example: "createdAt desc, lastName asc". Null values sort last.
`$search`	query	string	no	Free-text, case-insensitive substring match across the resource's searchable fields.
`$top`	query	integer	no	Maximum number of items to return (page size).
`$skip`	query	integer	no	Number of matching items to skip before returning results (offset paging). Combine with $top.
`$count`	query	boolean	no	When true, include @odata.count (total matches after $filter/$search, before paging) in the response.

Responses

200

Paginated list

application/json

data array
array of:
QualityLot
- id string
- supplierId string
- itemSku string
- quantity integer
- status string
- defectRate number
- inspectedBy string
- receivedAt string
- createdAt string
- updatedAt string
nextCursor string — Cursor for the next page, or null on the last page. With $top/$skip this is the next $skip value; otherwise a keyset cursor.
total integer — Total documents in the collection.
@odata.count integer — Present only when $count=true: total matches after $filter/$search.
@odata.truncated boolean — Present and true only when the collection exceeded the in-memory query cap and results may be incomplete.

400

Invalid OData query (e.g. malformed $filter)

`POST` `/api/purple-suite/scm/quality_lots`

Create quality lot

Register a received batch for incoming quality inspection, with its SKU, quantity and supplier. It starts pending; record the outcome by updating its status and defect rate.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes

Request body

application/json — required

QualityLot

id string
supplierId string
itemSku string
quantity integer
status string
defectRate number
inspectedBy string
receivedAt string
createdAt string
updatedAt string

Responses

201

Created

application/json

QualityLot

id string
supplierId string
itemSku string
quantity integer
status string
defectRate number
inspectedBy string
receivedAt string
createdAt string
updatedAt string

`GET` `/api/purple-suite/scm/quality_lots/{id}`

Get quality lot

Fetch one quality lot by id (e.g. QL-0001) with its SKU, quantity, supplier, defect rate, inspector and inspection status.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes
`id`	path	string	yes

Responses

200

Found

application/json

QualityLot

id string
supplierId string
itemSku string
quantity integer
status string
defectRate number
inspectedBy string
receivedAt string
createdAt string
updatedAt string

404

Not found

`DELETE` `/api/purple-suite/scm/quality_lots/{id}`

Delete quality lot

Permanently delete a quality lot record. Destructive and irreversible, and it erases the supplier's quality evidence — record a failed or quarantined outcome instead.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes
`id`	path	string	yes

Responses

200

Deleted

application/json

success boolean

404

Not found

`PATCH` `/api/purple-suite/scm/quality_lots/{id}`

Update quality lot

Record an inspection outcome on a lot — set status to in_inspection, passed, failed or quarantined, and write the defect rate and inspector. Quarantining or failing a lot holds the goods, so state the reason.

Parameters

Name	In	Type	Required	Description
`X-Instance-ID`	header	string	yes
`id`	path	string	yes

Request body

Fields to update (partial)

application/json

QualityLot

id string
supplierId string
itemSku string
quantity integer
status string
defectRate number
inspectedBy string
receivedAt string
createdAt string
updatedAt string

Responses

200

Updated

application/json

QualityLot

id string
supplierId string
itemSku string
quantity integer
status string
defectRate number
inspectedBy string
receivedAt string
createdAt string
updatedAt string

404

Not found

`GET` `/api/purple-suite/scm/openapi.json`

Get OpenAPI spec

Returns the OpenAPI 3.0 specification for this API. No authentication required.

Responses

200

OpenAPI spec

application/json

object

Purple SCM API Documentation

Overview

Endpoints

GET /api/purple-suite/scm/suppliers

Parameters

Responses

POST /api/purple-suite/scm/suppliers

Parameters

Request body

Responses

GET /api/purple-suite/scm/suppliers/{id}

Parameters

Responses

DELETE /api/purple-suite/scm/suppliers/{id}

Parameters

Responses

PATCH /api/purple-suite/scm/suppliers/{id}

Parameters

Request body

Responses

GET /api/purple-suite/scm/contracts

Parameters

Responses

POST /api/purple-suite/scm/contracts

Parameters

Request body

Responses

GET /api/purple-suite/scm/contracts/{id}

Parameters

Responses

DELETE /api/purple-suite/scm/contracts/{id}

Parameters

Responses

PATCH /api/purple-suite/scm/contracts/{id}

Parameters

Request body

Responses

GET /api/purple-suite/scm/shipments

Parameters

Responses

POST /api/purple-suite/scm/shipments

Parameters

Request body

Responses

GET /api/purple-suite/scm/shipments/{id}

Parameters

Responses

DELETE /api/purple-suite/scm/shipments/{id}

Parameters

Responses

PATCH /api/purple-suite/scm/shipments/{id}

Parameters

Request body

Responses

GET /api/purple-suite/scm/purchase_orders

Parameters

Responses

POST /api/purple-suite/scm/purchase_orders

Parameters

Request body

Responses

GET /api/purple-suite/scm/purchase_orders/{id}

Parameters

Responses

DELETE /api/purple-suite/scm/purchase_orders/{id}

Parameters

Responses

PATCH /api/purple-suite/scm/purchase_orders/{id}

Parameters

Request body

Responses

GET /api/purple-suite/scm/quality_lots

Parameters

Responses

POST /api/purple-suite/scm/quality_lots

Parameters

Request body

Responses

GET /api/purple-suite/scm/quality_lots/{id}

Parameters

`GET` `/api/purple-suite/scm/suppliers`

`POST` `/api/purple-suite/scm/suppliers`

`GET` `/api/purple-suite/scm/suppliers/{id}`

`DELETE` `/api/purple-suite/scm/suppliers/{id}`

`PATCH` `/api/purple-suite/scm/suppliers/{id}`

`GET` `/api/purple-suite/scm/contracts`

`POST` `/api/purple-suite/scm/contracts`

`GET` `/api/purple-suite/scm/contracts/{id}`

`DELETE` `/api/purple-suite/scm/contracts/{id}`

`PATCH` `/api/purple-suite/scm/contracts/{id}`

`GET` `/api/purple-suite/scm/shipments`

`POST` `/api/purple-suite/scm/shipments`

`GET` `/api/purple-suite/scm/shipments/{id}`

`DELETE` `/api/purple-suite/scm/shipments/{id}`

`PATCH` `/api/purple-suite/scm/shipments/{id}`

`GET` `/api/purple-suite/scm/purchase_orders`

`POST` `/api/purple-suite/scm/purchase_orders`

`GET` `/api/purple-suite/scm/purchase_orders/{id}`

`DELETE` `/api/purple-suite/scm/purchase_orders/{id}`

`PATCH` `/api/purple-suite/scm/purchase_orders/{id}`

`GET` `/api/purple-suite/scm/quality_lots`

`POST` `/api/purple-suite/scm/quality_lots`

`GET` `/api/purple-suite/scm/quality_lots/{id}`

`DELETE` `/api/purple-suite/scm/quality_lots/{id}`

`PATCH` `/api/purple-suite/scm/quality_lots/{id}`

`GET` `/api/purple-suite/scm/openapi.json`