Skip to main content
PATCH
/
provider
/
orders
/
{itemId}
/
status
Update order item status
curl --request PATCH \
  --url https://api.offergrid.io/provider/orders/{itemId}/status \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "status": "accepted",
  "providerNotes": "Installation scheduled for next Tuesday",
  "scheduledFor": "2025-01-15T10:00:00Z",
  "metadata": {
    "trackingNumber": "ABC123",
    "estimatedCompletion": "2025-01-20"
  }
}
'

Documentation Index

Fetch the complete documentation index at: https://offergrid.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Team API key for authentication. Your team role (provider/reseller/hybrid) determines which endpoints you can access.

Path Parameters

​
itemId
string
required

Body

application/json
​
status
enum<string>
required

New status for the order item

Available options:
pending,
submitted_to_provider,
accepted,
rejected,
scheduled,
in_progress,
completed,
active,
cancelled,
failed
Example:

"accepted"

​
providerNotes
string

Notes from provider about this status update

Example:

"Installation scheduled for next Tuesday"

​
scheduledFor
string

Scheduled date/time for installation or activation (ISO 8601)

Example:

"2025-01-15T10:00:00Z"

​
metadata
object

Additional metadata for this status update

Example:
{
  "trackingNumber": "ABC123",
  "estimatedCompletion": "2025-01-20"
}

Response

Order item status successfully updated