Update an order

patch

https://api.confidentcannabis.com/v0/labs/order/{order_id}

Update an existing order. Only the fields below can be patched; send just the
ones you want to change.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

order_id

string

required

Form Data

client_license_id

integer

Identifier for the client license under which this order should be placed (the ID, not the license number).

lab_license_id

integer

Identifier for the lab license under which this order should be placed (the ID, not the license number).

pickup

boolean

Defaults to false

True if this order should be picked up at the client location.

address_id

integer

Lab address ID for drop-off orders, client address ID for pickup orders.

price_adjustment

number

Dollar amount to change the order by; negative for a discount, positive for additional fees.

send_client_email

boolean

Defaults to true

If true the client receives email notifications for the order being edited. Defaults to true.

lims_id

string

Internal tracking ID for this order.

secondary_client_name

string

Company name for the secondary client.

secondary_client_address

string

Full address string for the secondary client.

secondary_client_license

string

License used by the secondary client for the order transaction.

secondary_client_type

integer

1 for producer, 2 for distributor.

Headers

X-ConfidentCannabis-Signature

string

HMAC-SHA256 request signature. Required only when request signing is enabled for your API key — see the Request Signing guide.

X-ConfidentCannabis-Timestamp

string

Unix timestamp (seconds) of the request, required only when request signing is enabled for your API key. Requests older than 30 seconds are rejected.

Responses

200Success

400The request was malformed or failed validation. Validation failures include per-field messages in error_details. Possible error_code values: invalid_request, request_too_old.

401Authentication failed. Possible error_code values: missing_api_key, invalid_api_key, invalid_credentials_type, api_access_restricted, api_access_denied, missing_signature, missing_timestamp, invalid_timestamp, invalid_signature.

403The API key is valid but does not have permission for this endpoint (for example, a client key calling a labs endpoint). Possible error_code values: permission_denied.

404The requested record does not exist or is not visible to this organization. Possible error_code values: not_found.