Update an order

curl --request PATCH \
  --url https://api.byblend.com/api/v1/orders/{order_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "my-system-128318AA2",
  "shipping": {
    "carrier": "usps",
    "service_level": "usps_ground_advantage",
    "signature_confirmation": "standard"
  }
}
'

import requests

url = "https://api.byblend.com/api/v1/orders/{order_id}"

payload = {
    "external_id": "my-system-128318AA2",
    "shipping": {
        "carrier": "usps",
        "service_level": "usps_ground_advantage",
        "signature_confirmation": "standard"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    external_id: 'my-system-128318AA2',
    shipping: {
      carrier: 'usps',
      service_level: 'usps_ground_advantage',
      signature_confirmation: 'standard'
    }
  })
};

fetch('https://api.byblend.com/api/v1/orders/{order_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://api.byblend.com/api/v1/orders/{order_id}",
  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([
    'external_id' => 'my-system-128318AA2',
    'shipping' => [
        'carrier' => 'usps',
        'service_level' => 'usps_ground_advantage',
        'signature_confirmation' => 'standard'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.byblend.com/api/v1/orders/{order_id}"

	payload := strings.NewReader("{\n  \"external_id\": \"my-system-128318AA2\",\n  \"shipping\": {\n    \"carrier\": \"usps\",\n    \"service_level\": \"usps_ground_advantage\",\n    \"signature_confirmation\": \"standard\"\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.byblend.com/api/v1/orders/{order_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"external_id\": \"my-system-128318AA2\",\n  \"shipping\": {\n    \"carrier\": \"usps\",\n    \"service_level\": \"usps_ground_advantage\",\n    \"signature_confirmation\": \"standard\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.byblend.com/api/v1/orders/{order_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"external_id\": \"my-system-128318AA2\",\n  \"shipping\": {\n    \"carrier\": \"usps\",\n    \"service_level\": \"usps_ground_advantage\",\n    \"signature_confirmation\": \"standard\"\n  }\n}"

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

{
  "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
  "created_at": "2025-03-15T12:00:00Z",
  "updated_at": "2025-03-15T12:00:00Z",
  "address": {
    "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
    "address_1": "140 Lindgren Streets",
    "address_2": "Apt 227",
    "city": "North Consueloburgh",
    "state": "CA",
    "country": "US",
    "type": "shipping",
    "zip_code": "02108"
  },
  "custom_shipping": {
    "label_url": "https://example.com/label.pdf",
    "tracking_number": "TEST123456",
    "tracking_url": "https://example.com/track/TEST123456",
    "carrier": "UPS"
  },
  "customer_id": "b658f16f-819c-4503-aede-bd555fc4ebfb",
  "external_id": "my-system-128318AA2",
  "is_replacement": false,
  "order_number": "ORD250312003548IAU4",
  "original_order_id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
  "patient": {
    "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
    "created_at": "2025-03-15T12:00:00Z",
    "updated_at": "2025-03-15T12:00:00Z",
    "first_name": "Willard",
    "middle_name": "Moises",
    "last_name": "Donnelly",
    "gender": "male",
    "email": "Harmon43@gmail.com",
    "phone": "6417383445",
    "date_of_birth": "1990-01-01",
    "driver_license_number": "B49188319",
    "driver_license_state": "CA",
    "ssn": "123456789",
    "primary_language": "en",
    "guardian_name": "John Guardian",
    "guardian_phone": "6417383445",
    "guardian_email": "parent@example.com",
    "guardian_relationship": "parent",
    "height_inches": 72,
    "weight_pounds": 180,
    "external_id": "1234567890",
    "is_smoker": false,
    "is_diabetic": false,
    "is_pregnant": false,
    "receive_sms": true,
    "receive_email": true,
    "address": {
      "address_1": "140 Lindgren Streets",
      "city": "North Consueloburgh",
      "state": "CA",
      "zip_code": "02108",
      "address_2": "Apt 227",
      "country": "US"
    }
  },
  "prescription_count": 1,
  "priority_requested": false,
  "cancellation_requested": false,
  "replacement_order_ids": [
    "0227d1e5-ba9a-42b5-8fe2-38882aa65708"
  ],
  "replacement_reason": "Product arrived damaged",
  "replacement_requested": false,
  "replacement_request_status": "pending",
  "replacement_requested_at": "2025-01-01T00:00:00Z",
  "replacement_requested_reason": "Product arrived damaged",
  "shipments": [
    {
      "carrier": "USPS",
      "created_at": "2026-04-17T18:31:05.175498",
      "delivered_at": "2026-04-17T18:31:05.175498",
      "id": "0239CA06-9A71-4FFE-8A8D-5403540A19E7",
      "service_level": "Ground Advantage",
      "status": "shipped",
      "tracking_number": "9200190347375200467807",
      "tracking_url": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9200190347375200467807"
    }
  ],
  "shipping": {
    "carrier": "usps",
    "service_level": "usps_ground_advantage",
    "signature_confirmation": "standard"
  },
  "status": "received",
  "paused_until": "2026-08-07T00:00:00",
  "products": {
    "prescription": [
      {
        "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
        "created_at": "2025-03-15T12:00:00Z",
        "updated_at": "2025-03-15T12:00:00Z",
        "sku": "1234567890",
        "name": "Mupirocin",
        "description": "A topical cream that is used to treat skin infections.",
        "product_code": "SUPERSPRAY15",
        "form": "cream",
        "is_active": true,
        "label_orientation": "portrait",
        "strength": "1%",
        "has_prescription": true,
        "quantity": 2,
        "reasons": [
          {
            "id": "00000000-0000-0000-0000-000000000201",
            "name": "Palatability",
            "description": "Commercial formulation has an unpleasant taste, texture, or odor."
          }
        ]
      }
    ],
    "non_prescription": [
      {
        "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
        "created_at": "2025-03-15T12:00:00Z",
        "updated_at": "2025-03-15T12:00:00Z",
        "sku": "1234567890",
        "name": "Krill Farms Fish Oil",
        "description": "A fish oil supplement complementary to prescribed products.",
        "form": "liquid",
        "is_active": true,
        "quantity": 1
      }
    ],
    "order_material": [
      {
        "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
        "created_at": "2025-03-15T12:00:00Z",
        "updated_at": "2025-03-15T12:00:00Z",
        "sku": "1234567890",
        "name": "Referral Brochure",
        "description": "Customer brochure included in every shipment.",
        "category": "marketing",
        "current_stock": 927,
        "reorder_threshold": 100,
        "has_inventory": true,
        "is_global": false,
        "quantity": 1
      }
    ]
  }
}

Orders

Update an order

Partial update — send only the fields to change. PUT is also accepted with identical merge semantics for backward compatibility.

Only address, external ID, (and, if supported in your account) custom shipping or shipping preferences (carrier, service_level, signature_confirmation) can be updated. Shipping details can only be updated if in certain statuses. (Orders that are verified are already in the shipping process, and those shipped or delivered are completed.)

By passing update_patient=true, the address will also update the patient’s address in the same request. Otherwise only the order’s address will be updated.

PATCH

api

orders

{order_id}

Update an order

curl --request PATCH \
  --url https://api.byblend.com/api/v1/orders/{order_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "my-system-128318AA2",
  "shipping": {
    "carrier": "usps",
    "service_level": "usps_ground_advantage",
    "signature_confirmation": "standard"
  }
}
'

import requests

url = "https://api.byblend.com/api/v1/orders/{order_id}"

payload = {
    "external_id": "my-system-128318AA2",
    "shipping": {
        "carrier": "usps",
        "service_level": "usps_ground_advantage",
        "signature_confirmation": "standard"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    external_id: 'my-system-128318AA2',
    shipping: {
      carrier: 'usps',
      service_level: 'usps_ground_advantage',
      signature_confirmation: 'standard'
    }
  })
};

fetch('https://api.byblend.com/api/v1/orders/{order_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://api.byblend.com/api/v1/orders/{order_id}",
  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([
    'external_id' => 'my-system-128318AA2',
    'shipping' => [
        'carrier' => 'usps',
        'service_level' => 'usps_ground_advantage',
        'signature_confirmation' => 'standard'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.byblend.com/api/v1/orders/{order_id}"

	payload := strings.NewReader("{\n  \"external_id\": \"my-system-128318AA2\",\n  \"shipping\": {\n    \"carrier\": \"usps\",\n    \"service_level\": \"usps_ground_advantage\",\n    \"signature_confirmation\": \"standard\"\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.byblend.com/api/v1/orders/{order_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"external_id\": \"my-system-128318AA2\",\n  \"shipping\": {\n    \"carrier\": \"usps\",\n    \"service_level\": \"usps_ground_advantage\",\n    \"signature_confirmation\": \"standard\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.byblend.com/api/v1/orders/{order_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"external_id\": \"my-system-128318AA2\",\n  \"shipping\": {\n    \"carrier\": \"usps\",\n    \"service_level\": \"usps_ground_advantage\",\n    \"signature_confirmation\": \"standard\"\n  }\n}"

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

{
  "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
  "created_at": "2025-03-15T12:00:00Z",
  "updated_at": "2025-03-15T12:00:00Z",
  "address": {
    "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
    "address_1": "140 Lindgren Streets",
    "address_2": "Apt 227",
    "city": "North Consueloburgh",
    "state": "CA",
    "country": "US",
    "type": "shipping",
    "zip_code": "02108"
  },
  "custom_shipping": {
    "label_url": "https://example.com/label.pdf",
    "tracking_number": "TEST123456",
    "tracking_url": "https://example.com/track/TEST123456",
    "carrier": "UPS"
  },
  "customer_id": "b658f16f-819c-4503-aede-bd555fc4ebfb",
  "external_id": "my-system-128318AA2",
  "is_replacement": false,
  "order_number": "ORD250312003548IAU4",
  "original_order_id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
  "patient": {
    "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
    "created_at": "2025-03-15T12:00:00Z",
    "updated_at": "2025-03-15T12:00:00Z",
    "first_name": "Willard",
    "middle_name": "Moises",
    "last_name": "Donnelly",
    "gender": "male",
    "email": "Harmon43@gmail.com",
    "phone": "6417383445",
    "date_of_birth": "1990-01-01",
    "driver_license_number": "B49188319",
    "driver_license_state": "CA",
    "ssn": "123456789",
    "primary_language": "en",
    "guardian_name": "John Guardian",
    "guardian_phone": "6417383445",
    "guardian_email": "parent@example.com",
    "guardian_relationship": "parent",
    "height_inches": 72,
    "weight_pounds": 180,
    "external_id": "1234567890",
    "is_smoker": false,
    "is_diabetic": false,
    "is_pregnant": false,
    "receive_sms": true,
    "receive_email": true,
    "address": {
      "address_1": "140 Lindgren Streets",
      "city": "North Consueloburgh",
      "state": "CA",
      "zip_code": "02108",
      "address_2": "Apt 227",
      "country": "US"
    }
  },
  "prescription_count": 1,
  "priority_requested": false,
  "cancellation_requested": false,
  "replacement_order_ids": [
    "0227d1e5-ba9a-42b5-8fe2-38882aa65708"
  ],
  "replacement_reason": "Product arrived damaged",
  "replacement_requested": false,
  "replacement_request_status": "pending",
  "replacement_requested_at": "2025-01-01T00:00:00Z",
  "replacement_requested_reason": "Product arrived damaged",
  "shipments": [
    {
      "carrier": "USPS",
      "created_at": "2026-04-17T18:31:05.175498",
      "delivered_at": "2026-04-17T18:31:05.175498",
      "id": "0239CA06-9A71-4FFE-8A8D-5403540A19E7",
      "service_level": "Ground Advantage",
      "status": "shipped",
      "tracking_number": "9200190347375200467807",
      "tracking_url": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9200190347375200467807"
    }
  ],
  "shipping": {
    "carrier": "usps",
    "service_level": "usps_ground_advantage",
    "signature_confirmation": "standard"
  },
  "status": "received",
  "paused_until": "2026-08-07T00:00:00",
  "products": {
    "prescription": [
      {
        "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
        "created_at": "2025-03-15T12:00:00Z",
        "updated_at": "2025-03-15T12:00:00Z",
        "sku": "1234567890",
        "name": "Mupirocin",
        "description": "A topical cream that is used to treat skin infections.",
        "product_code": "SUPERSPRAY15",
        "form": "cream",
        "is_active": true,
        "label_orientation": "portrait",
        "strength": "1%",
        "has_prescription": true,
        "quantity": 2,
        "reasons": [
          {
            "id": "00000000-0000-0000-0000-000000000201",
            "name": "Palatability",
            "description": "Commercial formulation has an unpleasant taste, texture, or odor."
          }
        ]
      }
    ],
    "non_prescription": [
      {
        "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
        "created_at": "2025-03-15T12:00:00Z",
        "updated_at": "2025-03-15T12:00:00Z",
        "sku": "1234567890",
        "name": "Krill Farms Fish Oil",
        "description": "A fish oil supplement complementary to prescribed products.",
        "form": "liquid",
        "is_active": true,
        "quantity": 1
      }
    ],
    "order_material": [
      {
        "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
        "created_at": "2025-03-15T12:00:00Z",
        "updated_at": "2025-03-15T12:00:00Z",
        "sku": "1234567890",
        "name": "Referral Brochure",
        "description": "Customer brochure included in every shipment.",
        "category": "marketing",
        "current_stock": 927,
        "reorder_threshold": 100,
        "has_inventory": true,
        "is_global": false,
        "quantity": 1
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

order_id

string

required

Unique identifier for the order, either UUID, order number (e.g. ORD250312003548IAU4), or external ID (e.g. my-system-128318AA2) if you have provided one during order creation or a prior update.

Query Parameters

update_patient

boolean

Whether to update the patient's address. Default is false.

Example:

true

Body

application/json

address

object

Show child attributes

custom_shipping

object

Custom shipping details for the order. Your account must have custom shipping enabled to use this field.

Show child attributes

external_id

string

External (your own system's) ID to associate with the order.

Example:

"my-system-128318AA2"

shipping

object

Shipping preferences for the order. Please ensure you have established the ability to use this feature with Blend administrators before using.

You may provide any combination of fields. If you provide a "generic" service_level only, we will use the most appropriate carrier to match the service level. If you provide both carrier and service_level, your service_level prefix ("usps_") must match your carrier.

On update, omitted fields are left unchanged. Send signature_confirmation: null to clear a previously set signature preference. Sending carrier and/or service_level without signature_confirmation does not clear signature.

Available carriers and service levels can be found in the Shipping Options endpoint.

Show child attributes

Response

200 - application/json

Order updated successfully

string<uuid>

Unique identifier

Example:

"0227d1e5-ba9a-42b5-8fe2-38882aa65708"

created_at

string<date-time>

Date and time of creation

Example:

"2025-03-15T12:00:00Z"

updated_at

string<date-time>

Date and time of last update

Example:

"2025-03-15T12:00:00Z"

address

object

Show child attributes

custom_shipping

object

Custom shipping details for the order if your account has custom shipping enabled, and you have provided prepaid label details.

Show child attributes

customer_id

string<uuid>

Example:

"b658f16f-819c-4503-aede-bd555fc4ebfb"

external_id

string

External (your own system's) ID associated with the order.

Example:

"my-system-128318AA2"

is_replacement

boolean

Whether the order is a replacement order

Example:

false

order_number

string

Friendlier identifier for the order. Auto-generated.

Example:

"ORD250312003548IAU4"

original_order_id

string<uuid>

ID of the original order, if this is a replacement order

Example:

"0227d1e5-ba9a-42b5-8fe2-38882aa65708"

patient

object

Show child attributes

prescription_count

integer

Number of prescriptions associated with the order (expected to be the same as the number of prescription products in the products object)

Example:

1

priority_requested

boolean

Whether the order has a priority request

Example:

false

cancellation_requested

boolean

Whether the customer has requested cancellation for an order in picked or verified status

Example:

false

replacement_order_ids

string<uuid>[]

IDs of any replacement orders, if they have been created from this order

replacement_reason

string

If this is a replacement order, reason for the replacement

Example:

"Product arrived damaged"

replacement_requested

boolean

Whether the order has a replacement request. This field is deprecated and will be removed in a future version. Please use replacement_request_status instead.

Example:

false

replacement_request_status

enum<string>

Status of the replacement request

Available options:

pending,

fulfilled,

declined,

cancelled

Example:

"pending"

replacement_requested_at

string

Date and time a replacement request was made

Example:

"2025-01-01T00:00:00Z"

replacement_requested_reason

string

Reason for the replacement request

Example:

"Product arrived damaged"

shipments

object[]

Show child attributes

shipping

object

Show child attributes

status

string

Order status. One of received, picked, verified, exception, paused, shipped, delivered, cancelled, returned.

Example:

"received"

paused_until

string<date-time> | null

When an order is paused, midnight UTC of the pause-until calendar day. The order automatically unpauses when this date is reached. null when the pause is indefinite or the order is not paused.

Example:

"2026-08-07T00:00:00"

products

object

Show child attributes

Authentication

Composite Creation

Electronic Prescriptions

Notifications

Orders

Patients

Prescribers

Prescriptions

Products and Materials

Reports

Search

Update an order

Authorizations

Path Parameters

Query Parameters

Body

Response