Update an order

PUT

orders

{id}

Update an order

curl --request PUT \
  --url https://{domain}/api/site/orders/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'User-Agent: <api-key>' \
  --data '
{
  "customerName": "<string>",
  "customerEmail": "jsmith@example.com",
  "billingAddress": {
    "name": "<string>",
    "phone": "<string>",
    "companyName": "<string>",
    "companyId": "<string>",
    "country": "<string>",
    "state": "<string>",
    "city": "<string>",
    "zipCode": "<string>",
    "address": "<string>",
    "address2": "<string>"
  },
  "shippingAddress": {
    "name": "<string>",
    "phone": "<string>",
    "companyName": "<string>",
    "companyId": "<string>",
    "country": "<string>",
    "state": "<string>",
    "city": "<string>",
    "zipCode": "<string>",
    "address": "<string>",
    "address2": "<string>"
  },
  "paymentMethod": "<string>",
  "transactionId": "<string>",
  "paid": true,
  "fulfillment": {
    "courier": "UPS",
    "trackingNo": "123456789ABC",
    "trackingUrl": "https://www.ups.com/mobile/track?trackingNumber=123456789ABC"
  },
  "notifyCustomer": true
}
'

import requests

url = "https://{domain}/api/site/orders/{id}"

payload = {
    "customerName": "<string>",
    "customerEmail": "jsmith@example.com",
    "billingAddress": {
        "name": "<string>",
        "phone": "<string>",
        "companyName": "<string>",
        "companyId": "<string>",
        "country": "<string>",
        "state": "<string>",
        "city": "<string>",
        "zipCode": "<string>",
        "address": "<string>",
        "address2": "<string>"
    },
    "shippingAddress": {
        "name": "<string>",
        "phone": "<string>",
        "companyName": "<string>",
        "companyId": "<string>",
        "country": "<string>",
        "state": "<string>",
        "city": "<string>",
        "zipCode": "<string>",
        "address": "<string>",
        "address2": "<string>"
    },
    "paymentMethod": "<string>",
    "transactionId": "<string>",
    "paid": True,
    "fulfillment": {
        "courier": "UPS",
        "trackingNo": "123456789ABC",
        "trackingUrl": "https://www.ups.com/mobile/track?trackingNumber=123456789ABC"
    },
    "notifyCustomer": True
}
headers = {
    "Authorization": "Bearer <token>",
    "User-Agent": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer <token>',
    'User-Agent': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customerName: '<string>',
    customerEmail: 'jsmith@example.com',
    billingAddress: {
      name: '<string>',
      phone: '<string>',
      companyName: '<string>',
      companyId: '<string>',
      country: '<string>',
      state: '<string>',
      city: '<string>',
      zipCode: '<string>',
      address: '<string>',
      address2: '<string>'
    },
    shippingAddress: {
      name: '<string>',
      phone: '<string>',
      companyName: '<string>',
      companyId: '<string>',
      country: '<string>',
      state: '<string>',
      city: '<string>',
      zipCode: '<string>',
      address: '<string>',
      address2: '<string>'
    },
    paymentMethod: '<string>',
    transactionId: '<string>',
    paid: true,
    fulfillment: {
      courier: 'UPS',
      trackingNo: '123456789ABC',
      trackingUrl: 'https://www.ups.com/mobile/track?trackingNumber=123456789ABC'
    },
    notifyCustomer: true
  })
};

fetch('https://{domain}/api/site/orders/{id}', 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://{domain}/api/site/orders/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'customerName' => '<string>',
    'customerEmail' => 'jsmith@example.com',
    'billingAddress' => [
        'name' => '<string>',
        'phone' => '<string>',
        'companyName' => '<string>',
        'companyId' => '<string>',
        'country' => '<string>',
        'state' => '<string>',
        'city' => '<string>',
        'zipCode' => '<string>',
        'address' => '<string>',
        'address2' => '<string>'
    ],
    'shippingAddress' => [
        'name' => '<string>',
        'phone' => '<string>',
        'companyName' => '<string>',
        'companyId' => '<string>',
        'country' => '<string>',
        'state' => '<string>',
        'city' => '<string>',
        'zipCode' => '<string>',
        'address' => '<string>',
        'address2' => '<string>'
    ],
    'paymentMethod' => '<string>',
    'transactionId' => '<string>',
    'paid' => true,
    'fulfillment' => [
        'courier' => 'UPS',
        'trackingNo' => '123456789ABC',
        'trackingUrl' => 'https://www.ups.com/mobile/track?trackingNumber=123456789ABC'
    ],
    'notifyCustomer' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "User-Agent: <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://{domain}/api/site/orders/{id}"

	payload := strings.NewReader("{\n  \"customerName\": \"<string>\",\n  \"customerEmail\": \"jsmith@example.com\",\n  \"billingAddress\": {\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"companyName\": \"<string>\",\n    \"companyId\": \"<string>\",\n    \"country\": \"<string>\",\n    \"state\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zipCode\": \"<string>\",\n    \"address\": \"<string>\",\n    \"address2\": \"<string>\"\n  },\n  \"shippingAddress\": {\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"companyName\": \"<string>\",\n    \"companyId\": \"<string>\",\n    \"country\": \"<string>\",\n    \"state\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zipCode\": \"<string>\",\n    \"address\": \"<string>\",\n    \"address2\": \"<string>\"\n  },\n  \"paymentMethod\": \"<string>\",\n  \"transactionId\": \"<string>\",\n  \"paid\": true,\n  \"fulfillment\": {\n    \"courier\": \"UPS\",\n    \"trackingNo\": \"123456789ABC\",\n    \"trackingUrl\": \"https://www.ups.com/mobile/track?trackingNumber=123456789ABC\"\n  },\n  \"notifyCustomer\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("User-Agent", "<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.put("https://{domain}/api/site/orders/{id}")
  .header("Authorization", "Bearer <token>")
  .header("User-Agent", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerName\": \"<string>\",\n  \"customerEmail\": \"jsmith@example.com\",\n  \"billingAddress\": {\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"companyName\": \"<string>\",\n    \"companyId\": \"<string>\",\n    \"country\": \"<string>\",\n    \"state\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zipCode\": \"<string>\",\n    \"address\": \"<string>\",\n    \"address2\": \"<string>\"\n  },\n  \"shippingAddress\": {\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"companyName\": \"<string>\",\n    \"companyId\": \"<string>\",\n    \"country\": \"<string>\",\n    \"state\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zipCode\": \"<string>\",\n    \"address\": \"<string>\",\n    \"address2\": \"<string>\"\n  },\n  \"paymentMethod\": \"<string>\",\n  \"transactionId\": \"<string>\",\n  \"paid\": true,\n  \"fulfillment\": {\n    \"courier\": \"UPS\",\n    \"trackingNo\": \"123456789ABC\",\n    \"trackingUrl\": \"https://www.ups.com/mobile/track?trackingNumber=123456789ABC\"\n  },\n  \"notifyCustomer\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{domain}/api/site/orders/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["User-Agent"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customerName\": \"<string>\",\n  \"customerEmail\": \"jsmith@example.com\",\n  \"billingAddress\": {\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"companyName\": \"<string>\",\n    \"companyId\": \"<string>\",\n    \"country\": \"<string>\",\n    \"state\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zipCode\": \"<string>\",\n    \"address\": \"<string>\",\n    \"address2\": \"<string>\"\n  },\n  \"shippingAddress\": {\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"companyName\": \"<string>\",\n    \"companyId\": \"<string>\",\n    \"country\": \"<string>\",\n    \"state\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zipCode\": \"<string>\",\n    \"address\": \"<string>\",\n    \"address2\": \"<string>\"\n  },\n  \"paymentMethod\": \"<string>\",\n  \"transactionId\": \"<string>\",\n  \"paid\": true,\n  \"fulfillment\": {\n    \"courier\": \"UPS\",\n    \"trackingNo\": \"123456789ABC\",\n    \"trackingUrl\": \"https://www.ups.com/mobile/track?trackingNumber=123456789ABC\"\n  },\n  \"notifyCustomer\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": 1234,
  "invoiceNo": 15,
  "created": 1573397217,
  "customerName": "John Doe",
  "customerEmail": "john@email.com",
  "contactId": 123,
  "memberId": 123,
  "shippingAddress": {
    "name": "<string>",
    "phone": "<string>",
    "companyName": "<string>",
    "companyId": "<string>",
    "country": "<string>",
    "state": "<string>",
    "city": "<string>",
    "zipCode": "<string>",
    "address": "<string>",
    "address2": "<string>"
  },
  "billingAddress": {
    "name": "<string>",
    "phone": "<string>",
    "companyName": "<string>",
    "companyId": "<string>",
    "country": "<string>",
    "state": "<string>",
    "city": "<string>",
    "zipCode": "<string>",
    "address": "<string>",
    "address2": "<string>"
  },
  "shippingRequired": true,
  "weight": 0,
  "weightUnit": "kg",
  "subTotal": 49,
  "total": 49,
  "discountCode": "<string>",
  "discountType": "fixed_discount",
  "discountAmount": 0,
  "shippingName": "<string>",
  "shippingAmount": 0,
  "paid": true,
  "paymentMethod": "stripe",
  "transactionId": "<string>",
  "status": "completed",
  "taxes": [
    {
      "name": "Sales Tax",
      "total": 20,
      "applyToShipping": true,
      "rate": 10,
      "type": "PERCENT",
      "appliedToItems": [
        0,
        1,
        2
      ]
    }
  ],
  "items": [
    {
      "id": 123,
      "name": "Running Shoes",
      "url": "running-shoes",
      "productId": 24,
      "type": "physical",
      "sku": "<string>",
      "quantity": 1,
      "total": 49,
      "weight": 0,
      "width": 0,
      "height": 0,
      "length": 0,
      "shippingRequired": true,
      "images": [
        "https://path-to-image.jpg"
      ],
      "variation": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "additions": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "tags": [
    "<string>"
  ],
  "additionalFields": [
    {
      "field": "<string>",
      "value": "<string>"
    }
  ],
  "notes": [
    {
      "time": 1686043751,
      "value": "Order Note Text Sample"
    }
  ]
}

{
  "success": false,
  "message": "Resource not found"
}

Authorizations

Authorization

string

header

required

Pass your API key as: Authorization: Bearer <API KEY>.

User-Agent

string

header

default:BosscartDocs/1.0

required

Client identifier sent with requests from the documentation playground.

Path Parameters

integer

required

The id of the order.

Example:

1234

Body

application/json

Only non-empty fields are set.

customerName

string

customerEmail

string<email>

billingAddress

object

A billing or shipping address.

Show child attributes

shippingAddress

object

A billing or shipping address.

Show child attributes

paymentMethod

string

The payment method type, e.g. "stripe".

transactionId

string

The transaction id uniquely identifying the payment for this order.

paid

boolean

status

enum<string>

The order status to set.

Available options:

PENDING,

SHIPPED,

COMPLETED,

CANCELED,

ARCHIVED

fulfillment

object

Show child attributes

notifyCustomer

boolean

Whether to notify the customer of this change.

Response

The updated order.

integer

Unique identifier.

Example:

1234

invoiceNo

integer

Invoice number assigned to the order.

Example:

15

created

integer<int64>

Timestamp in Unix seconds since epoch (time placed).

Example:

1573397217

customerName

string

Example:

"John Doe"

customerEmail

string<email>

Example:

"john@email.com"

contactId

integer

Unique identifier of the contact that made the order.

memberId

integer

Unique identifier of the registered member that made the order (if any).

shippingAddress

object

A billing or shipping address.

Show child attributes

billingAddress

object

A billing or shipping address.

Show child attributes

shippingRequired

boolean

Whether the order contains physical products requiring shipping.

weight

number

Total weight of the order.

Example:

0

weightUnit

string

Weight unit (kg, lb).

Example:

"kg"

subTotal

number

Example:

49

total

number

Example:

49

discountCode

string | null

Used discount code.

discountType

enum<string> | null

Type of discount used.

Available options:

fixed_discount,

percent_discount,

free_shipping,

null

discountAmount

number

Example:

0

shippingName

string

Shipping method used (if any).

shippingAmount

number

Cost of shipping.

Example:

0

paid

boolean

Whether the order is paid.

paymentMethod

string

Payment method used to place the order.

Example:

"stripe"

transactionId

string

If paid, the payment transaction id.

status

enum<string>

Order status. Returned in lowercase; see the Update operation for the accepted uppercase input values.

Available options:

pending,

shipped,

completed,

canceled,

archived

Example:

"completed"

taxes

object[]

Show child attributes

items

object[]

Show child attributes

tags

string[]

List of tags assigned to the order.

additionalFields

object[]

Field/value pairs of all additional fields collected with the order.

Show child attributes

notes

object[]

Private notes added to this order (time/value pairs).

Show child attributes

Last modified on September 2, 2026

Update an order

curl --request PUT \
  --url https://{domain}/api/site/orders/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'User-Agent: <api-key>' \
  --data '
{
  "customerName": "<string>",
  "customerEmail": "jsmith@example.com",
  "billingAddress": {
    "name": "<string>",
    "phone": "<string>",
    "companyName": "<string>",
    "companyId": "<string>",
    "country": "<string>",
    "state": "<string>",
    "city": "<string>",
    "zipCode": "<string>",
    "address": "<string>",
    "address2": "<string>"
  },
  "shippingAddress": {
    "name": "<string>",
    "phone": "<string>",
    "companyName": "<string>",
    "companyId": "<string>",
    "country": "<string>",
    "state": "<string>",
    "city": "<string>",
    "zipCode": "<string>",
    "address": "<string>",
    "address2": "<string>"
  },
  "paymentMethod": "<string>",
  "transactionId": "<string>",
  "paid": true,
  "fulfillment": {
    "courier": "UPS",
    "trackingNo": "123456789ABC",
    "trackingUrl": "https://www.ups.com/mobile/track?trackingNumber=123456789ABC"
  },
  "notifyCustomer": true
}
'

import requests

url = "https://{domain}/api/site/orders/{id}"

payload = {
    "customerName": "<string>",
    "customerEmail": "jsmith@example.com",
    "billingAddress": {
        "name": "<string>",
        "phone": "<string>",
        "companyName": "<string>",
        "companyId": "<string>",
        "country": "<string>",
        "state": "<string>",
        "city": "<string>",
        "zipCode": "<string>",
        "address": "<string>",
        "address2": "<string>"
    },
    "shippingAddress": {
        "name": "<string>",
        "phone": "<string>",
        "companyName": "<string>",
        "companyId": "<string>",
        "country": "<string>",
        "state": "<string>",
        "city": "<string>",
        "zipCode": "<string>",
        "address": "<string>",
        "address2": "<string>"
    },
    "paymentMethod": "<string>",
    "transactionId": "<string>",
    "paid": True,
    "fulfillment": {
        "courier": "UPS",
        "trackingNo": "123456789ABC",
        "trackingUrl": "https://www.ups.com/mobile/track?trackingNumber=123456789ABC"
    },
    "notifyCustomer": True
}
headers = {
    "Authorization": "Bearer <token>",
    "User-Agent": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer <token>',
    'User-Agent': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customerName: '<string>',
    customerEmail: 'jsmith@example.com',
    billingAddress: {
      name: '<string>',
      phone: '<string>',
      companyName: '<string>',
      companyId: '<string>',
      country: '<string>',
      state: '<string>',
      city: '<string>',
      zipCode: '<string>',
      address: '<string>',
      address2: '<string>'
    },
    shippingAddress: {
      name: '<string>',
      phone: '<string>',
      companyName: '<string>',
      companyId: '<string>',
      country: '<string>',
      state: '<string>',
      city: '<string>',
      zipCode: '<string>',
      address: '<string>',
      address2: '<string>'
    },
    paymentMethod: '<string>',
    transactionId: '<string>',
    paid: true,
    fulfillment: {
      courier: 'UPS',
      trackingNo: '123456789ABC',
      trackingUrl: 'https://www.ups.com/mobile/track?trackingNumber=123456789ABC'
    },
    notifyCustomer: true
  })
};

fetch('https://{domain}/api/site/orders/{id}', 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://{domain}/api/site/orders/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'customerName' => '<string>',
    'customerEmail' => 'jsmith@example.com',
    'billingAddress' => [
        'name' => '<string>',
        'phone' => '<string>',
        'companyName' => '<string>',
        'companyId' => '<string>',
        'country' => '<string>',
        'state' => '<string>',
        'city' => '<string>',
        'zipCode' => '<string>',
        'address' => '<string>',
        'address2' => '<string>'
    ],
    'shippingAddress' => [
        'name' => '<string>',
        'phone' => '<string>',
        'companyName' => '<string>',
        'companyId' => '<string>',
        'country' => '<string>',
        'state' => '<string>',
        'city' => '<string>',
        'zipCode' => '<string>',
        'address' => '<string>',
        'address2' => '<string>'
    ],
    'paymentMethod' => '<string>',
    'transactionId' => '<string>',
    'paid' => true,
    'fulfillment' => [
        'courier' => 'UPS',
        'trackingNo' => '123456789ABC',
        'trackingUrl' => 'https://www.ups.com/mobile/track?trackingNumber=123456789ABC'
    ],
    'notifyCustomer' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "User-Agent: <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://{domain}/api/site/orders/{id}"

	payload := strings.NewReader("{\n  \"customerName\": \"<string>\",\n  \"customerEmail\": \"jsmith@example.com\",\n  \"billingAddress\": {\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"companyName\": \"<string>\",\n    \"companyId\": \"<string>\",\n    \"country\": \"<string>\",\n    \"state\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zipCode\": \"<string>\",\n    \"address\": \"<string>\",\n    \"address2\": \"<string>\"\n  },\n  \"shippingAddress\": {\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"companyName\": \"<string>\",\n    \"companyId\": \"<string>\",\n    \"country\": \"<string>\",\n    \"state\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zipCode\": \"<string>\",\n    \"address\": \"<string>\",\n    \"address2\": \"<string>\"\n  },\n  \"paymentMethod\": \"<string>\",\n  \"transactionId\": \"<string>\",\n  \"paid\": true,\n  \"fulfillment\": {\n    \"courier\": \"UPS\",\n    \"trackingNo\": \"123456789ABC\",\n    \"trackingUrl\": \"https://www.ups.com/mobile/track?trackingNumber=123456789ABC\"\n  },\n  \"notifyCustomer\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("User-Agent", "<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.put("https://{domain}/api/site/orders/{id}")
  .header("Authorization", "Bearer <token>")
  .header("User-Agent", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerName\": \"<string>\",\n  \"customerEmail\": \"jsmith@example.com\",\n  \"billingAddress\": {\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"companyName\": \"<string>\",\n    \"companyId\": \"<string>\",\n    \"country\": \"<string>\",\n    \"state\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zipCode\": \"<string>\",\n    \"address\": \"<string>\",\n    \"address2\": \"<string>\"\n  },\n  \"shippingAddress\": {\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"companyName\": \"<string>\",\n    \"companyId\": \"<string>\",\n    \"country\": \"<string>\",\n    \"state\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zipCode\": \"<string>\",\n    \"address\": \"<string>\",\n    \"address2\": \"<string>\"\n  },\n  \"paymentMethod\": \"<string>\",\n  \"transactionId\": \"<string>\",\n  \"paid\": true,\n  \"fulfillment\": {\n    \"courier\": \"UPS\",\n    \"trackingNo\": \"123456789ABC\",\n    \"trackingUrl\": \"https://www.ups.com/mobile/track?trackingNumber=123456789ABC\"\n  },\n  \"notifyCustomer\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{domain}/api/site/orders/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["User-Agent"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customerName\": \"<string>\",\n  \"customerEmail\": \"jsmith@example.com\",\n  \"billingAddress\": {\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"companyName\": \"<string>\",\n    \"companyId\": \"<string>\",\n    \"country\": \"<string>\",\n    \"state\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zipCode\": \"<string>\",\n    \"address\": \"<string>\",\n    \"address2\": \"<string>\"\n  },\n  \"shippingAddress\": {\n    \"name\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"companyName\": \"<string>\",\n    \"companyId\": \"<string>\",\n    \"country\": \"<string>\",\n    \"state\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zipCode\": \"<string>\",\n    \"address\": \"<string>\",\n    \"address2\": \"<string>\"\n  },\n  \"paymentMethod\": \"<string>\",\n  \"transactionId\": \"<string>\",\n  \"paid\": true,\n  \"fulfillment\": {\n    \"courier\": \"UPS\",\n    \"trackingNo\": \"123456789ABC\",\n    \"trackingUrl\": \"https://www.ups.com/mobile/track?trackingNumber=123456789ABC\"\n  },\n  \"notifyCustomer\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": 1234,
  "invoiceNo": 15,
  "created": 1573397217,
  "customerName": "John Doe",
  "customerEmail": "john@email.com",
  "contactId": 123,
  "memberId": 123,
  "shippingAddress": {
    "name": "<string>",
    "phone": "<string>",
    "companyName": "<string>",
    "companyId": "<string>",
    "country": "<string>",
    "state": "<string>",
    "city": "<string>",
    "zipCode": "<string>",
    "address": "<string>",
    "address2": "<string>"
  },
  "billingAddress": {
    "name": "<string>",
    "phone": "<string>",
    "companyName": "<string>",
    "companyId": "<string>",
    "country": "<string>",
    "state": "<string>",
    "city": "<string>",
    "zipCode": "<string>",
    "address": "<string>",
    "address2": "<string>"
  },
  "shippingRequired": true,
  "weight": 0,
  "weightUnit": "kg",
  "subTotal": 49,
  "total": 49,
  "discountCode": "<string>",
  "discountType": "fixed_discount",
  "discountAmount": 0,
  "shippingName": "<string>",
  "shippingAmount": 0,
  "paid": true,
  "paymentMethod": "stripe",
  "transactionId": "<string>",
  "status": "completed",
  "taxes": [
    {
      "name": "Sales Tax",
      "total": 20,
      "applyToShipping": true,
      "rate": 10,
      "type": "PERCENT",
      "appliedToItems": [
        0,
        1,
        2
      ]
    }
  ],
  "items": [
    {
      "id": 123,
      "name": "Running Shoes",
      "url": "running-shoes",
      "productId": 24,
      "type": "physical",
      "sku": "<string>",
      "quantity": 1,
      "total": 49,
      "weight": 0,
      "width": 0,
      "height": 0,
      "length": 0,
      "shippingRequired": true,
      "images": [
        "https://path-to-image.jpg"
      ],
      "variation": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "additions": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "tags": [
    "<string>"
  ],
  "additionalFields": [
    {
      "field": "<string>",
      "value": "<string>"
    }
  ],
  "notes": [
    {
      "time": 1686043751,
      "value": "Order Note Text Sample"
    }
  ]
}

{
  "success": false,
  "message": "Resource not found"
}

Contacts

Members

Member groups

Products

Orders

Forms

Bookings

Subscriber lists

Webhooks

API Reference

Authorizations

Path Parameters

Body

Response