Servers Playground How we check Add a server Log in

Order Desk MCP by usefulapi

Working · 487 ms

io.usefulapi/order-deskv1.3.0 Domain verified

Search Order Desk orders and inventory; read order items and shipments; create or update orders.

Commerce

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://order-desk.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

orderdesk_add_order_item Destructive

WRITE: add one line item to an existing order; Order Desk recalculates the totals. POST /orders/{order_id}/order-items.

itemobject, required

The line item to add (name, code, price, quantity...).

order_idinteger, required

Order Desk's internal order id.

The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.

I understand, run it anyway

Order Desk MCP by usefulapi MCP server | mcptry

Tools (15)

orderdesk_add_order_item

WRITE: add one line item to an existing order; Order Desk recalculates the totals. POST /orders/{order_id}/order-items.

destructive

Argument	Type	Description
item*	object	The line item to add (name, code, price, quantity...).
order_id*	integer	Order Desk's internal order id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "order_id",
    "item"
  ],
  "properties": {
    "item": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "maxLength": 200,
          "description": "Item SKU or product code."
        },
        "name": {
          "type": "string",
          "maxLength": 500
        },
        "price": {
          "type": "number",
          "maximum": 1000000000,
          "minimum": 0
        },
        "weight": {
          "type": "number",
          "maximum": 1000000000,
          "minimum": 0
        },
        "metadata": {
          "type": "object",
          "description": "Hidden item details (max 15,000 characters as JSON).",
          "propertyNames": {
            "type": "string",
            "maxLength": 100,
            "minLength": 1
          },
          "additionalProperties": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 2000
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "quantity": {
          "type": "integer",
          "maximum": 1000000,
          "minimum": 1,
          "description": "Defaults to 1."
        },
        "category_code": {
          "type": "string",
          "maxLength": 200
        },
        "delivery_type": {
          "enum": [
            "ship",
            "noship",
            "download",
            "future"
          ],
          "type": "string",
          "description": "ship (default), noship, download or future."
        },
        "variation_list": {
          "type": "object",
          "description": "Variations, e.g. {\"Size\":\"Large\",\"Color\":\"Red\"} (max 5,000 characters as JSON).",
          "propertyNames": {
            "type": "string",
            "maxLength": 100,
            "minLength": 1
          },
          "additionalProperties": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 2000
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "description": "The line item to add (name, code, price, quantity...)."
    },
    "order_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Order Desk's internal order id.",
      "exclusiveMinimum": 0
    }
  }
}

orderdesk_add_order_note

WRITE: append an entry to an order's history. History is append-only (entries cannot be edited or removed) and an order holds at most 250 entries, so do not use it for routine polling. POST /orders/{order_id}/order-history.

destructive

Argument	Type	Description
note*	string	The note text.
order_id*	integer	Order Desk's internal order id.
source_name	string	What wrote the entry (default API).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "order_id",
    "note"
  ],
  "properties": {
    "note": {
      "type": "string",
      "maxLength": 1800,
      "minLength": 1,
      "description": "The note text."
    },
    "order_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Order Desk's internal order id.",
      "exclusiveMinimum": 0
    },
    "source_name": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "What wrote the entry (default API)."
    }
  }
}

orderdesk_add_shipment

WRITE: record a shipment (carrier and tracking number) against an order. One shipment per parcel; several shipments represent a partial fulfillment. Use "n/a" when there is no tracking number. If tracking_url is omitted Order Desk derives it. POST /orders/{order_id}/shipments.

destructive

Argument	Type	Description
cost	number	Your cost to send the shipment.
weight	number	Final shipment weight.
order_id*	integer	Order Desk's internal order id.
carrier_code	string	Carrier code such as USPS or FedEx.
tracking_url	string
shipment_method	string	Shipping service name, e.g. First Class International.
tracking_number*	string	Carrier tracking number, or "n/a".

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "order_id",
    "tracking_number"
  ],
  "properties": {
    "cost": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": 0,
      "description": "Your cost to send the shipment."
    },
    "weight": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": 0,
      "description": "Final shipment weight."
    },
    "order_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Order Desk's internal order id.",
      "exclusiveMinimum": 0
    },
    "carrier_code": {
      "type": "string",
      "maxLength": 50,
      "description": "Carrier code such as USPS or FedEx."
    },
    "tracking_url": {
      "type": "string",
      "pattern": "^https?:\\/\\/",
      "maxLength": 1000
    },
    "shipment_method": {
      "type": "string",
      "maxLength": 200,
      "description": "Shipping service name, e.g. First Class International."
    },
    "tracking_number": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Carrier tracking number, or \"n/a\"."
    }
  }
}

orderdesk_create_inventory_item

WRITE: add an inventory item. The code (SKU) must match the code your orders arrive with. POST /inventory-items.

destructive

Argument	Type	Description
code*	string	Unique SKU.
cost	number	Item cost.
name*	string	Product name.
price	number
stock	integer	Units available.
weight	number	Shipping weight.
location	string	Warehouse or fulfillment method.
metadata	object
variation_list	object
manufacturer_sku	string

Input schema (JSON)

orderdesk_create_order

WRITE: add a new order to the store. Needs at least one item, and a name or company in the shipping or customer address (if only one address is given the other is copied from it). Omit folder_id to land in the first folder. Order Desk rejects an order it recognizes as a duplicate and names the existing order id. POST /orders.

destructive

Argument	Type	Description
email	string	Customer e-mail address.
customer	object	Customer (billing) address.
shipping	object	Shipping address.
folder_id	integer	Folder to put the order in (see orderdesk_get_store).
source_id	string	Your own order id (the order's Order Desk id is used when blank).
tax_total	number
order_items*	array	Line items (at least one).
source_name	string	Order source / cart name (default Order Desk).
payment_type

orderdesk_get_inventory_item

One inventory item by Order Desk's internal id. GET /inventory-items/{inventory_item_id}.

read-only

Argument	Type	Description
inventory_item_id*	integer	Order Desk's internal inventory item id (see orderdesk_list_inventory_items).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "inventory_item_id"
  ],
  "properties": {
    "inventory_item_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Order Desk's internal inventory item id (see orderdesk_list_inventory_items).",
      "exclusiveMinimum": 0
    }
  }
}

orderdesk_get_order

One order by Order Desk's internal id: addresses, items, totals, payment, notes, discounts, checkout data and shipments. To find an order by your own id, use orderdesk_list_orders with source_id. GET /orders/{order_id}.

read-only

Argument	Type	Description
order_id*	integer	Order Desk's internal order id (not the cart's order number).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "order_id"
  ],
  "properties": {
    "order_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Order Desk's internal order id (not the cart's order number).",
      "exclusiveMinimum": 0
    }
  }
}

orderdesk_get_store

The store's name, id, FOLDERS (id -> name; orders live in exactly one folder, and folder ids are needed to filter and move orders) and key settings (timezone, locale, stock behavior, shipping methods). The API key and mail credentials are never returned. GET /store.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

orderdesk_list_inventory_items

Search the store's inventory (SKU, name, price, cost, weight, stock, location). Order Desk returns every match with no paging, so narrow with search/code/name; limit and offset slice the result here. GET /inventory-items.

read-only

Argument	Type	Description
code	string	Exact SKU.
name	string	Product name.
limit	integer	How many items to return, 1-200 (default 50).
offset	integer	Records to skip (default 0). Pass the previous reply's next_offset.
search	string	Matches name, code and metadata together.
location	string	Warehouse or fulfillment method.
updated_from	string	Items updated on or after this time.
manufacturer_sku	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "code": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Exact SKU."
    },
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Product name."
    },
    "limit": {
      "type": "integer",
      "maximum": 200,
      "description": "How many items to return, 1-200 (default 50).",
      "exclusiveMinimum": 0
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Records to skip (default 0). Pass the previous reply's next_offset."
    },
    "search": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Matches name, code and metadata together."
    },
    "location": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Warehouse or fulfillment method."
    },
    "updated_from": {
      "type": "string",
      "description": "Items updated on or after this time."
    },
    "manufacturer_sku": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    }
  }
}

orderdesk_list_order_items

The line items of one order (name, SKU, price, quantity, weight, delivery type, variations). GET /orders/{order_id}/order-items.

read-only

Argument	Type	Description
order_id*	integer	Order Desk's internal order id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "order_id"
  ],
  "properties": {
    "order_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Order Desk's internal order id.",
      "exclusiveMinimum": 0
    }
  }
}

orderdesk_list_order_shipments

The shipments recorded against an order: carrier, tracking number and URL, method, weight, cost, dates. GET /orders/{order_id}/shipments.

read-only

Argument	Type	Description
order_id*	integer	Order Desk's internal order id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "order_id"
  ],
  "properties": {
    "order_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Order Desk's internal order id.",
      "exclusiveMinimum": 0
    }
  }
}

orderdesk_list_orders

Search orders, newest first, with items, addresses, totals, payment and shipments. Filters combine with AND. Prefer a date range: Order Desk asks clients to avoid open-ended queries. Page with limit and offset (next_offset). GET /orders.

read-only

Argument	Type	Description
email	string	Customer e-mail address.
limit	integer	How many records to return, 1-100 (default 20).
order	string	Sort direction (default DESC).
offset	integer	Records to skip (default 0). Pass the previous reply's next_offset.
added_to	string	Orders added on or before this time (a date means the end of that UTC day).
order_by	string	Order field to sort by (default date_added).
folder_id	string	Folder id, or several separated by commas (see orderdesk_get_store).
source_id	string	Your original order id from the cart or marketplace.
added_from

orderdesk_move_orders

WRITE: move one or more orders to another folder. Moving runs the rules attached to the destination folder (which can send e-mail, call fulfillment services, etc.) and writes a history entry. Pass exactly one of destination_folder_id or destination_folder_name (see orderdesk_get_store). Returns each order's previous folder. POST /move-orders.

destructive

Argument	Type	Description
order_ids*	array	Order Desk's internal order ids.
destination_folder_id	integer	Folder id to move to.
destination_folder_name	string	Exact folder name to move to.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "order_ids"
  ],
  "properties": {
    "order_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "Order Desk's internal order ids."
    },
    "destination_folder_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Folder id to move to.",
      "exclusiveMinimum": 0
    },
    "destination_folder_name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Exact folder name to move to."
    }
  }
}

orderdesk_update_inventory_item

WRITE: change fields of an inventory item, for example its stock count. Order Desk's PUT replaces the whole record, so this reads the item, applies only the fields you pass (metadata and variation keys are merged) and sends the complete record back. PUT /inventory-items/{inventory_item_id}.

destructive

Argument	Type	Description
code	string	SKU.
cost	number
name	string
price	number
stock	integer	The new units-available count (replaces the old one).
weight	number
location	string
metadata	object	Metadata keys to set (others are kept).
variation_list	object	Variation keys to set (others are kept).
manufacturer_sku

orderdesk_update_order

WRITE: change fields of an existing order. Order Desk's PUT replaces the whole record, so this reads the order, applies only the fields you pass (shipping/customer address fields and checkout_data/order_metadata keys are merged into what is there, other values replaced) and sends the complete record back, items included. The order keeps its folder; use orderdesk_move_orders to move it. PUT /orders/{order_id}.

destructive

Argument	Type	Description
email	string
customer	object	Customer address fields to change (others are kept).
order_id*	integer	Order Desk's internal order id.
shipping	object	Shipping address fields to change (others are kept).
tax_total	number
checkout_data	object	Checkout data keys to set (other keys are kept).
handling_total	number
order_metadata	object	Order metadata keys to set (other keys are kept).

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name",
    "code"
  ],
  "properties": {
    "code": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Unique SKU."
    },
    "cost": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": 0,
      "description": "Item cost."
    },
    "name": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Product name."
    },
    "price": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": 0
    },
    "stock": {
      "type": "integer",
      "maximum": 1000000000,
      "minimum": -1000000000,
      "description": "Units available."
    },
    "weight": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": 0,
      "description": "Shipping weight."
    },
    "location": {
      "type": "string",
      "maxLength": 200,
      "description": "Warehouse or fulfillment method."
    },
    "metadata": {
      "type": "object",
      "propertyNames": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 2000
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          },
          {
            "type": "null"
          }
        ]
      }
    },
    "variation_list": {
      "type": "object",
      "propertyNames": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 2000
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          },
          {
            "type": "null"
          }
        ]
      }
    },
    "manufacturer_sku": {
      "type": "string",
      "maxLength": 200
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "order_items"
  ],
  "properties": {
    "email": {
      "type": "string",
      "maxLength": 200,
      "description": "Customer e-mail address."
    },
    "customer": {
      "type": "object",
      "properties": {
        "city": {
          "type": "string",
          "maxLength": 200
        },
        "phone": {
          "type": "string",
          "maxLength": 200
        },
        "state": {
          "type": "string",
          "maxLength": 200,
          "description": "State or region."
        },
        "company": {
          "type": "string",
          "maxLength": 200
        },
        "country": {
          "type": "string",
          "maxLength": 200,
          "description": "Country code or full country name."
        },
        "address1": {
          "type": "string",
          "maxLength": 200
        },
        "address2": {
          "type": "string",
          "maxLength": 200
        },
        "address3": {
          "type": "string",
          "maxLength": 200,
          "description": "Shipping addresses only."
        },
        "address4": {
          "type": "string",
          "maxLength": 200,
          "description": "Shipping addresses only."
        },
        "last_name": {
          "type": "string",
          "maxLength": 200
        },
        "first_name": {
          "type": "string",
          "maxLength": 200
        },
        "postal_code": {
          "type": "string",
          "maxLength": 200
        }
      },
      "description": "Customer (billing) address."
    },
    "shipping": {
      "type": "object",
      "properties": {
        "city": {
          "type": "string",
          "maxLength": 200
        },
        "phone": {
          "type": "string",
          "maxLength": 200
        },
        "state": {
          "type": "string",
          "maxLength": 200,
          "description": "State or region."
        },
        "company": {
          "type": "string",
          "maxLength": 200
        },
        "country": {
          "type": "string",
          "maxLength": 200,
          "description": "Country code or full country name."
        },
        "address1": {
          "type": "string",
          "maxLength": 200
        },
        "address2": {
          "type": "string",
          "maxLength": 200
        },
        "address3": {
          "type": "string",
          "maxLength": 200,
          "description": "Shipping addresses only."
        },
        "address4": {
          "type": "string",
          "maxLength": 200,
          "description": "Shipping addresses only."
        },
        "last_name": {
          "type": "string",
          "maxLength": 200
        },
        "first_name": {
          "type": "string",
          "maxLength": 200
        },
        "postal_code": {
          "type": "string",
          "maxLength": 200
        }
      },
      "description": "Shipping address."
    },
    "folder_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Folder to put the order in (see orderdesk_get_store).",
      "exclusiveMinimum": 0
    },
    "source_id": {
      "type": "string",
      "maxLength": 200,
      "description": "Your own order id (the order's Order Desk id is used when blank)."
    },
    "tax_total": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": 0
    },
    "order_items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "maxLength": 200,
            "description": "Item SKU or product code."
          },
          "name": {
            "type": "string",
            "maxLength": 500
          },
          "price": {
            "type": "number",
            "maximum": 1000000000,
            "minimum": 0
          },
          "weight": {
            "type": "number",
            "maximum": 1000000000,
            "minimum": 0
          },
          "metadata": {
            "type": "object",
            "description": "Hidden item details (max 15,000 characters as JSON).",
            "propertyNames": {
              "type": "string",
              "maxLength": 100,
              "minLength": 1
            },
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 2000
                },
                {
                  "type": "number"
                },
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "quantity": {
            "type": "integer",
            "maximum": 1000000,
            "minimum": 1,
            "description": "Defaults to 1."
          },
          "category_code": {
            "type": "string",
            "maxLength": 200
          },
          "delivery_type": {
            "enum": [
              "ship",
              "noship",
              "download",
              "future"
            ],
            "type": "string",
            "description": "ship (default), noship, download or future."
          },
          "variation_list": {
            "type": "object",
            "description": "Variations, e.g. {\"Size\":\"Large\",\"Color\":\"Red\"} (max 5,000 characters as JSON).",
            "propertyNames": {
              "type": "string",
              "maxLength": 100,
              "minLength": 1
            },
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 2000
                },
                {
                  "type": "number"
                },
                {
                  "type": "boolean"
                },
                {
                  "type": "null"
                }
              ]
            }
          }
        }
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "Line items (at least one)."
    },
    "source_name": {
      "type": "string",
      "maxLength": 200,
      "description": "Order source / cart name (default Order Desk)."
    },
    "payment_type": {
      "type": "string",
      "maxLength": 200,
      "description": "Visa, MasterCard, PayPal, ..."
    },
    "checkout_data": {
      "type": "object",
      "description": "Editable extra order details (max 3,500 characters as JSON).",
      "propertyNames": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 2000
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          },
          {
            "type": "null"
          }
        ]
      }
    },
    "handling_total": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": 0
    },
    "order_metadata": {
      "type": "object",
      "description": "Hidden extra order details (max 2,000 characters as JSON).",
      "propertyNames": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 2000
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          },
          {
            "type": "null"
          }
        ]
      }
    },
    "payment_status": {
      "enum": [
        "Approved",
        "Authorized",
        "Captured",
        "Fully Refunded",
        "Partially Refunded",
        "Pending",
        "Rejected",
        "Voided"
      ],
      "type": "string",
      "description": "Defaults to Captured."
    },
    "shipping_total": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": 0
    },
    "shipping_method": {
      "type": "string",
      "maxLength": 200
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "email": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Customer e-mail address."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "How many records to return, 1-100 (default 20).",
      "exclusiveMinimum": 0
    },
    "order": {
      "enum": [
        "ASC",
        "DESC"
      ],
      "type": "string",
      "description": "Sort direction (default DESC)."
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Records to skip (default 0). Pass the previous reply's next_offset."
    },
    "added_to": {
      "type": "string",
      "description": "Orders added on or before this time (a date means the end of that UTC day)."
    },
    "order_by": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9_]{0,39}$",
      "description": "Order field to sort by (default date_added)."
    },
    "folder_id": {
      "type": "string",
      "pattern": "^\\d{1,12}(,\\d{1,12}){0,19}$",
      "description": "Folder id, or several separated by commas (see orderdesk_get_store)."
    },
    "source_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Your original order id from the cart or marketplace."
    },
    "added_from": {
      "type": "string",
      "description": "Orders added on or after this time (a date means the start of that UTC day)."
    },
    "customer_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Customer id in the originating system."
    },
    "folder_name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "The folder's exact name instead of its id."
    },
    "modified_to": {
      "type": "string",
      "description": "Orders modified on or before this time."
    },
    "source_name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Order source name (cart or marketplace)."
    },
    "modified_from": {
      "type": "string",
      "description": "Orders modified on or after this time."
    },
    "include_history": {
      "type": "boolean",
      "description": "Include each order's history (slow; use with a small limit)."
    },
    "customer_last_name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "shipping_last_name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "customer_first_name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "shipping_first_name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "inventory_item_id"
  ],
  "properties": {
    "code": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "SKU."
    },
    "cost": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": 0
    },
    "name": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1
    },
    "price": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": 0
    },
    "stock": {
      "type": "integer",
      "maximum": 1000000000,
      "minimum": -1000000000,
      "description": "The new units-available count (replaces the old one)."
    },
    "weight": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": 0
    },
    "location": {
      "type": "string",
      "maxLength": 200
    },
    "metadata": {
      "type": "object",
      "description": "Metadata keys to set (others are kept).",
      "propertyNames": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 2000
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          },
          {
            "type": "null"
          }
        ]
      }
    },
    "variation_list": {
      "type": "object",
      "description": "Variation keys to set (others are kept).",
      "propertyNames": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 2000
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          },
          {
            "type": "null"
          }
        ]
      }
    },
    "manufacturer_sku": {
      "type": "string",
      "maxLength": 200
    },
    "inventory_item_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Order Desk's internal inventory item id.",
      "exclusiveMinimum": 0
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "order_id"
  ],
  "properties": {
    "email": {
      "type": "string",
      "maxLength": 200
    },
    "customer": {
      "type": "object",
      "properties": {
        "city": {
          "type": "string",
          "maxLength": 200
        },
        "phone": {
          "type": "string",
          "maxLength": 200
        },
        "state": {
          "type": "string",
          "maxLength": 200,
          "description": "State or region."
        },
        "company": {
          "type": "string",
          "maxLength": 200
        },
        "country": {
          "type": "string",
          "maxLength": 200,
          "description": "Country code or full country name."
        },
        "address1": {
          "type": "string",
          "maxLength": 200
        },
        "address2": {
          "type": "string",
          "maxLength": 200
        },
        "address3": {
          "type": "string",
          "maxLength": 200,
          "description": "Shipping addresses only."
        },
        "address4": {
          "type": "string",
          "maxLength": 200,
          "description": "Shipping addresses only."
        },
        "last_name": {
          "type": "string",
          "maxLength": 200
        },
        "first_name": {
          "type": "string",
          "maxLength": 200
        },
        "postal_code": {
          "type": "string",
          "maxLength": 200
        }
      },
      "description": "Customer address fields to change (others are kept)."
    },
    "order_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Order Desk's internal order id.",
      "exclusiveMinimum": 0
    },
    "shipping": {
      "type": "object",
      "properties": {
        "city": {
          "type": "string",
          "maxLength": 200
        },
        "phone": {
          "type": "string",
          "maxLength": 200
        },
        "state": {
          "type": "string",
          "maxLength": 200,
          "description": "State or region."
        },
        "company": {
          "type": "string",
          "maxLength": 200
        },
        "country": {
          "type": "string",
          "maxLength": 200,
          "description": "Country code or full country name."
        },
        "address1": {
          "type": "string",
          "maxLength": 200
        },
        "address2": {
          "type": "string",
          "maxLength": 200
        },
        "address3": {
          "type": "string",
          "maxLength": 200,
          "description": "Shipping addresses only."
        },
        "address4": {
          "type": "string",
          "maxLength": 200,
          "description": "Shipping addresses only."
        },
        "last_name": {
          "type": "string",
          "maxLength": 200
        },
        "first_name": {
          "type": "string",
          "maxLength": 200
        },
        "postal_code": {
          "type": "string",
          "maxLength": 200
        }
      },
      "description": "Shipping address fields to change (others are kept)."
    },
    "tax_total": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": 0
    },
    "checkout_data": {
      "type": "object",
      "description": "Checkout data keys to set (other keys are kept).",
      "propertyNames": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 2000
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          },
          {
            "type": "null"
          }
        ]
      }
    },
    "handling_total": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": 0
    },
    "order_metadata": {
      "type": "object",
      "description": "Order metadata keys to set (other keys are kept).",
      "propertyNames": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 2000
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          },
          {
            "type": "null"
          }
        ]
      }
    },
    "payment_status": {
      "enum": [
        "Approved",
        "Authorized",
        "Captured",
        "Fully Refunded",
        "Partially Refunded",
        "Pending",
        "Rejected",
        "Voided"
      ],
      "type": "string"
    },
    "shipping_total": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": 0
    },
    "shipping_method": {
      "type": "string",
      "maxLength": 200
    }
  }
}