1. Orders
OrderMesh STG
  • Introduction to our API
    • Getting Started
    • Product Catalog
    • Webhooks Overview
    • Merchant Notifications Guide
  • User
    • Client
      • Generate Service Client Access Token
    • User
      • Login User by Username and Password
      • Login User with Refresh Token
  • Order
    • OrderItems
      • Search for order items based on various criteria and filters
    • Orders
      • Create a New Order.
        POST
      • Search for orders based on various criteria and filters.
        GET
      • Create multiple orders
        POST
      • Retrieve multiple orders
        GET
      • Update multiple orders
        PATCH
      • Retrieve a list of orders
        GET
      • Retrieve an order by Order ID.
        GET
      • Update order data.
        PATCH
      • Retrieve an order by Safe ID
        GET
      • Retrieve order item by Order Item ID
        GET
      • Update an item within an order.
        PATCH
      • Cancel Order or order items
        POST
      • Change the order status to Customer Care Hold
        POST
      • Place a manual hold on an order
        POST
      • Add time to an active manual hold
        POST
      • Release a manual hold and let the order carry on
        POST
      • Retrieve audit logs for a specific order.
        GET
      • Retrieve audit logs for a specific order.
        GET
      • Retrieve audit logs for a specific order item.
        GET
      • Add a Refund Request.
        POST
  • Note
    • Notes
      • Create a New Note
      • Search All Notes
      • View Note by ID
      • Update Note
      • Delete Note
      • View Note Audit Logs
  • Catalog
    • Categories
      • View all product categories
      • Create a new category
      • Update category
      • Delete category
      • Get audit logs of a category
    • MerchantCatalog
      • Create a merchant catalog
      • Update a merchant catalog
      • Partially update a merchant catalog
      • Get a list of merchant catalogs
      • Delete a merchant catalog
      • Get a merchant catalog and search variants in it
      • Get a merchant catalog with variants
      • Get a list of variants the merchant can use in accordance with their enabled catalog
      • Get the variants of the merchant's custom catalog with their stored and live global attributes
      • Search the variants of the merchant's custom catalog, with their stored and live global attributes
      • Search for variants in enabled merchant catalog with fallback to global catalog
      • Get audit logs of a merchant catalog
      • Get the products of the merchant's custom catalog with live global product data
      • Search the products of the merchant's custom catalog, with live global product data
    • Products
      • View all products
      • Retrieve product variant details
      • Create a new product
      • Search products
      • Bulk create products
      • Bulk update products
      • Update product
      • Delete product
      • Update variant
      • Get audit logs of a product
    • Variants
      • Delete variant
      • Create a variant
      • Search product variants
      • Search product variants with cursor pagination
      • Get audit logs of a variant
    • MerchantVariants
      • Add new variants to a merchant catalog
      • Update a merchant catalog variants
      • Update a merchant catalog by removing variants
    • Enriched Catalog
      • List the vendors a merchant is connected to.
      • Page through the vendor product data of every vendor a merchant is connected to.
      • Get every variation of one product, per connected vendor able to produce it.
  • Shipment
    • Packing Slip
      • Generates a packing slip for a specific shipment by Shipment ID.
    • Shipments
      • Get details of a specific shipment by Shipment ID.
      • Update details of a specific shipment by Shipment ID.
      • Create packages for a specific shipment.
      • Delete shipment with packages.
      • Get all shipments for an order by Order ID.
      • Create shipment for order, vendor, and order items.
      • Get shipment with packages for order and vendor.
      • Get shipment details by Order Item ID.
      • Update a specific shipment package.
      • Delete a specific shipment package.
      • Cancel shipment.
      • Unassign items to shipment.
      • Shipment resubmission to assigned facility.
      • Retry outbound polling for a shipment by publishing an OutboundShipmentUpdate event.
      • Search shipments.
      • Reroute shipment.
      • Rejects a shipment.
      • Bulk reroute shipments.
      • Get shipment audit logs.
      • Get package audit logs.
      • Get message audit logs for shipment updates.
      • Assign Shipment.
    • VendorShipments
      • Get full vendor details for up to 100 shipments in a single call. Only available for vendor and admin users. Returns a per-id result for each requested shipment: accessible shipments return a 200 detail model, missing ids return 404, and inaccessible ids
  1. Orders

Change the order status to Customer Care Hold

POST
/v1/orders/{orderId}/hold
Vendor Access: Forbidden — This endpoint is not accessible to vendor users.
This endpoint allows you to set the status of an order to Customer Care Hold when needed.
Returns 409 when the order is currently being processed, or when it is on a merchant
fulfillment hold, which outranks a customer care hold and is released only by removing
the merchant's hold.

Request

Authorization
Add the parameter
Authorization
to Headers，whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Path Params

Responses

🟢200
application/json
OK
Body

🟠400
🟠401
🟠403
🟠404
🟠409
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.stg.ordermesh.io/order/v1/orders//hold' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Success
{
    "message": "Order was placed on customer care hold."
}
Modified at 2026-10-24 19:29:52
Previous
Cancel Order or order items
Next
Place a manual hold on an order
Built with