Skip to main content
POST
/
reseller
/
orders
Place a new order
curl --request POST \
  --url https://api.offergrid.io/reseller/orders \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "items": [
    {
      "offerId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "serviceAddress": {
    "street": "123 Main St",
    "city": "San Francisco",
    "state": "CA",
    "zipCode": "94102",
    "country": "US"
  },
  "customerInfo": {
    "fullName": "John Doe",
    "email": "john@example.com",
    "phone": "+1-555-123-4567"
  },
  "notes": "Customer prefers morning installations",
  "metadata": {
    "referralSource": "property-listing",
    "unitNumber": "4B"
  }
}
'

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.

Body

application/json
​
items
Order Item · object[]
required

Array of items to order (offers)

Example:
[
  {
    "offerId": "123e4567-e89b-12d3-a456-426614174000"
  }
]
​
serviceAddress
Service Address · object
required

Service address for installation

​
customerInfo
Customer Information · object
required

Customer information

​
notes
string

Additional notes for the order

Example:

"Customer prefers morning installations"

​
metadata
object

Additional metadata for the order

Example:
{
  "referralSource": "property-listing",
  "unitNumber": "4B"
}

Response

Order successfully created