SCscalev
Orders

Update shipment receipt data

Requires the order:update scope. Update shipment receipt / tracking ID for an order.

patch/v3/orders/{id}/shipment-receipt

Request

  • Base URL
    https://api.scalev.com
  • URL
    https://api.scalev.com/v3/orders/{id}/shipment-receipt
  • Auth
    • HTTP bearer
    • or API key in header authorization

Request body

shipment_receiptstring required

Response

Receipt updated successfully

idstring uuid

Canonical UUIDv7 order primary key returned by the partitioned orders table.

order_idstring

Order ID in string format

public_order_urlstring uri nullable

Public order URL on the verified checkout hostname for orders created through a hosted page or storefront. Otherwise uses the store's verified default domain, then the business's default Scalev domain. Custom domains must belong to the same business. Revalidated when rendered; stale domain metadata is not authoritative.

payment_urlstring uri nullable

Scalev PayLink URL rebuilt from its identity on the currently resolved order domain, or public_order_url with /success appended for other payment methods.

shipment_receiptstring nullable

Shipment receipt URL

Changes

No recorded changes to this operation across all 14 revisions of this API.