provider-orders
Update order item status
Update the fulfillment status of an order item (e.g., accept, reject, schedule, complete). Use this to manage the order workflow from acceptance to completion.
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"
}
}
'import requests
url = "https://api.offergrid.io/provider/orders/{itemId}/status"
payload = {
"status": "accepted",
"providerNotes": "Installation scheduled for next Tuesday",
"scheduledFor": "2025-01-15T10:00:00Z",
"metadata": {
"trackingNumber": "ABC123",
"estimatedCompletion": "2025-01-20"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: 'accepted',
providerNotes: 'Installation scheduled for next Tuesday',
scheduledFor: '2025-01-15T10:00:00Z',
metadata: {trackingNumber: 'ABC123', estimatedCompletion: '2025-01-20'}
})
};
fetch('https://api.offergrid.io/provider/orders/{itemId}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.offergrid.io/provider/orders/{itemId}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'accepted',
'providerNotes' => 'Installation scheduled for next Tuesday',
'scheduledFor' => '2025-01-15T10:00:00Z',
'metadata' => [
'trackingNumber' => 'ABC123',
'estimatedCompletion' => '2025-01-20'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.offergrid.io/provider/orders/{itemId}/status"
payload := strings.NewReader("{\n \"status\": \"accepted\",\n \"providerNotes\": \"Installation scheduled for next Tuesday\",\n \"scheduledFor\": \"2025-01-15T10:00:00Z\",\n \"metadata\": {\n \"trackingNumber\": \"ABC123\",\n \"estimatedCompletion\": \"2025-01-20\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.offergrid.io/provider/orders/{itemId}/status")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"accepted\",\n \"providerNotes\": \"Installation scheduled for next Tuesday\",\n \"scheduledFor\": \"2025-01-15T10:00:00Z\",\n \"metadata\": {\n \"trackingNumber\": \"ABC123\",\n \"estimatedCompletion\": \"2025-01-20\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.offergrid.io/provider/orders/{itemId}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"accepted\",\n \"providerNotes\": \"Installation scheduled for next Tuesday\",\n \"scheduledFor\": \"2025-01-15T10:00:00Z\",\n \"metadata\": {\n \"trackingNumber\": \"ABC123\",\n \"estimatedCompletion\": \"2025-01-20\"\n }\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Team API key for authentication. Your team role (provider/reseller/hybrid) determines which endpoints you can access.
Path Parameters
Body
application/json
New status for the order item
Available options:
pending, submitted_to_provider, accepted, rejected, scheduled, in_progress, completed, active, cancelled, failed Example:
"accepted"
Notes from provider about this status update
Example:
"Installation scheduled for next Tuesday"
Scheduled date/time for installation or activation (ISO 8601)
Example:
"2025-01-15T10:00:00Z"
Additional metadata for this status update
Example:
{
"trackingNumber": "ABC123",
"estimatedCompletion": "2025-01-20"
}
Response
Order item status successfully updated
Was this page helpful?
⌘I
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"
}
}
'import requests
url = "https://api.offergrid.io/provider/orders/{itemId}/status"
payload = {
"status": "accepted",
"providerNotes": "Installation scheduled for next Tuesday",
"scheduledFor": "2025-01-15T10:00:00Z",
"metadata": {
"trackingNumber": "ABC123",
"estimatedCompletion": "2025-01-20"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: 'accepted',
providerNotes: 'Installation scheduled for next Tuesday',
scheduledFor: '2025-01-15T10:00:00Z',
metadata: {trackingNumber: 'ABC123', estimatedCompletion: '2025-01-20'}
})
};
fetch('https://api.offergrid.io/provider/orders/{itemId}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.offergrid.io/provider/orders/{itemId}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'accepted',
'providerNotes' => 'Installation scheduled for next Tuesday',
'scheduledFor' => '2025-01-15T10:00:00Z',
'metadata' => [
'trackingNumber' => 'ABC123',
'estimatedCompletion' => '2025-01-20'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.offergrid.io/provider/orders/{itemId}/status"
payload := strings.NewReader("{\n \"status\": \"accepted\",\n \"providerNotes\": \"Installation scheduled for next Tuesday\",\n \"scheduledFor\": \"2025-01-15T10:00:00Z\",\n \"metadata\": {\n \"trackingNumber\": \"ABC123\",\n \"estimatedCompletion\": \"2025-01-20\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.offergrid.io/provider/orders/{itemId}/status")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"accepted\",\n \"providerNotes\": \"Installation scheduled for next Tuesday\",\n \"scheduledFor\": \"2025-01-15T10:00:00Z\",\n \"metadata\": {\n \"trackingNumber\": \"ABC123\",\n \"estimatedCompletion\": \"2025-01-20\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.offergrid.io/provider/orders/{itemId}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"accepted\",\n \"providerNotes\": \"Installation scheduled for next Tuesday\",\n \"scheduledFor\": \"2025-01-15T10:00:00Z\",\n \"metadata\": {\n \"trackingNumber\": \"ABC123\",\n \"estimatedCompletion\": \"2025-01-20\"\n }\n}"
response = http.request(request)
puts response.read_body