# Create a sales order or quote

```http
POST https://secure.yoprint.com/v2/api/store/{team_slug}/v2/sales_order/new
```

- API version: v2
- Operation ID: `v2_public_order_create`
- Section: Sales › [Sales orders](https://developer.yoprint.com/reference/sales-orders.md)
- Web page: https://developer.yoprint.com/reference/sales-orders/v2-order-create/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Creates a new draft sales order or quote. The draft already has its order number (`scoped_id`, such as SO1001) but sends nothing to the customer; add jobs and lines, then publish it.

Set `object_type` to `quote` for a quote (or the older `quote: true`). Without either you get a sales order.

The new draft takes its defaults from the team and the customer: today's issue date, the customer's (or team's) pricing group, payment term and warehouse, the customer's primary brand profile, the team's starting status, and due and production dates from the team's settings.

The order number (`scoped_id`) is the team's next number unless you send your own, and publishing keeps it.

Typical flow: create the draft, add jobs (`v2/sales_order/{hash_id}/job`), add line items, then publish. The answer is the order: its `id` and `unique_key`, `scoped_id` (the number people see), `name`, `object_type` (`sales_order` or `quote`), `internal_status` (`draft` until published), `status_id` and `status`, the customer and addresses, dates, notes, `is_rush`, pricing settings and totals. The value of the order's lines is `order_item_cart_total`. `invoiced_total`, `invoiced_order_item_subtotal`, `invoiced_shipment_subtotal`, `invoiced_tax_subtotal` and `invoiced_discount_subtotal` count only what has been **invoiced** (0 until the order has an invoice). They are **decimal pairs** (`{ "value": 850000, "dp": 4 }` is 85.00; always read `dp`). `paid_amount`, `calc_deposit_total` and `unallocated_amount` are in **thousandths** (`135000` is 135.00). `deposit_total` is a **percentage ×1000** (`50000` is 50%). `calc_subtotal`, `calc_discount`, `calc_tax` and `calc_total` are deprecated thousandths copies of the invoiced totals: they still return, but use the decimal pair fields instead.

## Permission

Needs the `create_order` permission (the team owner always has it). Quotes use the same permission.

## Business rules

- The team must have a default pricing group: "This team must have a default pricing group configured before creating an order or quote."
- `object_type` and `quote`, when both sent, must describe the same thing.
- A customer synced from Shopify can't be used: "Shopify customer cannot be used for native order or quote creation."
- Creating with `is_external: true` is refused for integrations.

## Side effects

- Creates a draft. No email, webhook or stock change happens until you publish.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.

## Request body

Content type `application/json`, required.

Fields:

- `client_note` (string | null, optional): The Client Note, printed on documents the customer receives.
- `customer_id` (string, optional): The customer's `id`. Optional, but an order needs a customer before it can be published. An id that is not one of your customers is ignored.
- `customer_po_number` (string | null, optional): The customer's purchase order number.
- `object_type` (string, optional): `quote` for a quote; `sales_order` (the default) for a sales order. One of: `"sales_order"`, `"quote"`.
- `quote` (boolean, optional): Older way to ask for a quote. If you send both, they must agree.
- `scoped_id` (string, optional): Your own order number. Leave it out to get the team's next number.

### Example request

```bash
curl -X POST 'https://secure.yoprint.com/v2/api/store/your-team/v2/sales_order/new' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "client_note": "Prices valid for 30 days.",
    "customer_id": "63KcENAAsKuipY",
    "object_type": "quote"
  }'
```

Another example: A sales order for a customer:

```bash
curl -X POST 'https://secure.yoprint.com/v2/api/store/your-team/v2/sales_order/new' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "customer_id": "63KcENAAsKuipY",
    "customer_po_number": "PO-1188",
    "object_type": "sales_order"
  }'
```

## Response

`200` Successful response.

Fields:

- `data` (object, required): A sales order or quote.
  - `id` (string, required): The order's hash id: use it in every other call.
  - `internal_status` (string, required): `draft` until published. One of: `"draft"`, `"published"`.
  - `object_type` (string, required): One of: `"sales_order"`, `"quote"`.
  - `scoped_id` (string, required): The order number people see, `SO` and at least four digits (quotes too). Not an id.
  - `unique_key` (string, required): The order's unique key (`ord_…`); accepted wherever `{order_unique_key}` is.
  - `approval_status` (string | null, optional): `requested`, `sent-to-customer`, `viewed-by-customer`, `need-changes` or `approved`; null without approvals.
  - `assigned_users` (array of objects, optional): The team members in the order's Assigned To list (always included).
    - Each item:
      - `avatar_url` (string | null, optional)
      - `email` (string, optional)
      - `id` (string, optional)
      - `name` (string, optional)
      - `timezone` (string | null, optional): IANA time zone, for example `America/Chicago`.
  - `auto_invoice_managed` (boolean, optional): true when YoPrint keeps one invoice in step with the order.
  - `auto_invoice_shipment_price_type` (string | null, optional): `DONOTMANAGE`, `NONE`, `MARKUP` or `MARGIN`.
  - `auto_invoice_shipment_rate` (decimal pair, optional): The MARKUP or MARGIN percentage. A decimal pair: the amount is `value` ÷ 10^`dp` (`{ "value": 12500000, "dp": 6 }` is 12.50). Kept with 6 decimal places; an amount never set can come as `{ "value": 0, "dp": 0 }`. Read `dp` every time: it can differ between fields and records. See https://developer.yoprint.com/concepts/money-and-quantities.md.
  - `auto_invoice_type` (string | null, optional): How the automatic invoice is built. Always `single_invoice` today.
  - `billing_address` (object | null, optional): An address, as the address operations return it.
    - `city` (string | null, optional)
    - `country_code` (string | null, optional)
    - `id` (string, optional)
    - `is_primary` (boolean, optional)
    - `label` (string | null, optional)
    - `postcode` (string | null, optional)
    - `role` (string | null, optional): `billing`, `shipping` or a warehouse role.
    - `state_code` (string | null, optional)
  - `billing_address_id` (string | null, optional)
  - `calc_deposit_total` (integer | number | string | null, optional): The deposit amount, rounded to 2 decimal places: the percentage of `order_item_cart_total`, or of the invoiced total once every line is invoiced (or the invoiced total reaches the order's); 0 unless `deposit_required`. Thousandths, an older encoding: `12500` is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (`1234.5` is 1.2345), or as a string (`"1234.5"`) when you send `X-Yoprint-Decimal-Format: exact-v1`. See [Money and quantities](/concepts/money-and-quantities/).
  - `client_note` (string | null, optional): The Client Note.
  - `created_at` (string (date-time) | null, optional): Created. ISO 8601 with offset, or null.
  - `created_by` (string | null, optional): Created By (a team member id).
  - `creator_name` (string | null, optional)
  - `cust_due_date` (string (date-time) | null, optional): Customer in-hands date. ISO 8601 with offset, or null.
  - `customer` (object | null, optional): Always present on order answers, lists included: the customer record, or null when the order has none. Get a sales order also nests the customer's contacts, addresses, brand profiles, tags, files and assigned users in it.
    - `default_payment_term_id` (string | null, optional)
    - `default_pricing_group_id` (string | null, optional)
    - `id` (string, optional)
    - `is_external` (boolean, optional): true for a customer synced from an integration.
    - `name` (string, optional)
    - `tax_exempt` (boolean, optional)
  - `customer_billing_contact_id` (string | null, optional): The id of the contact on the order (the same contact as `customer_contact_id`), or null.
  - `customer_contact_id` (string | null, optional)
  - `customer_has_email` (boolean, optional)
  - `customer_id` (string | null, optional)
  - `customer_po_number` (string | null, optional)
  - `customer_profile_id` (string | null, optional): Brand profile.
  - `deposit_amount_due` (decimal pair, optional): Deposit still to pay (negative once overpaid). A decimal pair: the amount is `value` ÷ 10^`dp` (`{ "value": 125000, "dp": 4 }` is 12.50). Kept with 4 decimal places; an amount never set can come as `{ "value": 0, "dp": 0 }`. Read `dp` every time: it can differ between fields and records. See https://developer.yoprint.com/concepts/money-and-quantities.md.
  - `deposit_due` (string (date-time) | null, optional): Deposit due date. ISO 8601 with offset, or null.
  - `deposit_required` (boolean, optional)
  - `deposit_total` (integer | number | string | null, optional): The deposit as a **percentage** of the order. A percentage ×1000: `8250` is 8.25%. With `X-Yoprint-Decimal-Format: exact-v1`, a value that isn't a whole number comes back as a string.
  - `due_date` (string (date-time) | null, optional): Production due. ISO 8601 with offset, or null.
  - `external_ids` (array of objects, optional): The order's links to records in other systems. An empty list when there are none.
  - `external_type` (string | null, optional): `shopify` for a Shopify order; null for YoPrint orders.
  - `from_legacy` (boolean, optional): true for an order that was moved over from the old format.
  - `full_amount_due` (string (date-time) | null, optional): Full payment due date. ISO 8601 with offset, or null.
  - `grouped_pdf` (array of objects, optional): PDF links, grouped: `Main` (only for roles with `view_order_finance`), `Job` (not on Shopify orders), `Shipment` and the team's templates.
    - Each item:
      - `documents` (array of objects, optional)
      - `label` (string, optional)
  - `has_external_integration_sync_error` (boolean, optional): true when the last sync with an integration failed.
  - `has_invoice` (boolean, optional): true when the order has at least one invoice, so a zero invoiced total can be told apart from no invoice.
  - `has_not_invoiced_items` (boolean, optional): true when some line items are not on an invoice yet.
  - `has_over_invoiced_items` (boolean, optional): true when some line items are invoiced for more than the order has.
  - `has_shipment_items_not_allocated` (boolean, optional): true when some line items are not on a shipment yet.
  - `has_shipment_items_over_allocated` (boolean, optional): true when some line items are on shipments for more than the order has.
  - `has_valid_invoice` (boolean, optional): true when at least one of the order's invoices is in a valid state.
  - `has_valid_shipment` (boolean, optional): true when at least one of the order's shipments is in a valid state.
  - `inventory_status` (string | null, optional): Stock status of the order's lines: `not_committed`, `committed`, `partially_committed`, `not_applicable` or `pending`.
  - `invoice_lock_version` (integer | string | null, optional): Changes whenever the order's invoices change.
  - `invoiced_discount_subtotal` (decimal pair, optional): Discounts on the order's invoices; 0 until invoiced. A decimal pair: the amount is `value` ÷ 10^`dp` (`{ "value": 125000, "dp": 4 }` is 12.50). Kept with 4 decimal places; an amount never set can come as `{ "value": 0, "dp": 0 }`. Read `dp` every time: it can differ between fields and records. See https://developer.yoprint.com/concepts/money-and-quantities.md.
  - `invoiced_order_item_subtotal` (decimal pair, optional): The lines and shipping fees the order's invoices bill (the sum of their `cart_item_subtotal`); 0 until invoiced. A decimal pair: the amount is `value` ÷ 10^`dp` (`{ "value": 125000, "dp": 4 }` is 12.50). Kept with 4 decimal places; an amount never set can come as `{ "value": 0, "dp": 0 }`. Read `dp` every time: it can differ between fields and records. See https://developer.yoprint.com/concepts/money-and-quantities.md.
  - `invoiced_shipment_subtotal` (decimal pair, optional): The shipping fees in `invoiced_order_item_subtotal`; 0 until invoiced. A decimal pair: the amount is `value` ÷ 10^`dp` (`{ "value": 125000, "dp": 4 }` is 12.50). Kept with 4 decimal places; an amount never set can come as `{ "value": 0, "dp": 0 }`. Read `dp` every time: it can differ between fields and records. See https://developer.yoprint.com/concepts/money-and-quantities.md.
  - `invoiced_tax_subtotal` (decimal pair, optional): Tax on the order's invoices; 0 until invoiced. A decimal pair: the amount is `value` ÷ 10^`dp` (`{ "value": 125000, "dp": 4 }` is 12.50). Kept with 4 decimal places; an amount never set can come as `{ "value": 0, "dp": 0 }`. Read `dp` every time: it can differ between fields and records. See https://developer.yoprint.com/concepts/money-and-quantities.md.
  - `invoiced_total` (decimal pair, optional): Total of the order's invoices. A decimal pair: the amount is `value` ÷ 10^`dp` (`{ "value": 125000, "dp": 4 }` is 12.50). Kept with 4 decimal places; an amount never set can come as `{ "value": 0, "dp": 0 }`. Read `dp` every time: it can differ between fields and records. See https://developer.yoprint.com/concepts/money-and-quantities.md.
  - `is_client_note_editable` (boolean, optional): false for a Shopify order, whose client note comes from Shopify.
  - `is_external` (boolean, optional): true for an order synced from an integration such as Shopify.
  - `is_legacy` (boolean, optional): true for an order made in the old format.
  - `is_rush` (boolean, optional)
  - `issue_date` (string (date-time) | null, optional): Issue date. ISO 8601 with offset, or null.
  - `job_lock_version` (integer | string | null, optional): Changes whenever the order's jobs change.
  - `last_payment_request_date` (string (date-time) | null, optional): When a payment reminder was last emailed for the order. ISO 8601 with offset, or null.
  - `lock_version` (integer | string | null, optional): Changes on every save.
  - `mode` (string, optional): Older flag: `create` for a draft, `view` once published. One of: `"create"`, `"view"`, `"edit"`.
  - `name` (string | null, optional)
  - `order_balance_due` (decimal pair, optional): Invoiced total minus paid. A decimal pair: the amount is `value` ÷ 10^`dp` (`{ "value": 125000, "dp": 4 }` is 12.50). Kept with 4 decimal places; an amount never set can come as `{ "value": 0, "dp": 0 }`. Read `dp` every time: it can differ between fields and records. See https://developer.yoprint.com/concepts/money-and-quantities.md.
  - `order_item_cart_total` (decimal pair, optional): The value of the order's lines: the order's own total before invoicing. A decimal pair: the amount is `value` ÷ 10^`dp` (`{ "value": 125000, "dp": 4 }` is 12.50). Kept with 4 decimal places; an amount never set can come as `{ "value": 0, "dp": 0 }`. Read `dp` every time: it can differ between fields and records. See https://developer.yoprint.com/concepts/money-and-quantities.md.
  - `order_item_lock_version` (integer | string | null, optional): Changes whenever the order's line items change.
  - `order_margin_percentage` (decimal pair, optional): Margin, in percent. A decimal pair: the amount is `value` ÷ 10^`dp` (`{ "value": 1250, "dp": 2 }` is 12.50). Kept with 2 decimal places; an amount never set can come as `{ "value": 0, "dp": 0 }`. Read `dp` every time: it can differ between fields and records. See https://developer.yoprint.com/concepts/money-and-quantities.md.
  - `order_markup_percentage` (decimal pair, optional): Markup, in percent. A decimal pair: the amount is `value` ÷ 10^`dp` (`{ "value": 1250, "dp": 2 }` is 12.50). Kept with 2 decimal places; an amount never set can come as `{ "value": 0, "dp": 0 }`. Read `dp` every time: it can differ between fields and records. See https://developer.yoprint.com/concepts/money-and-quantities.md.
  - `order_profit` (decimal pair, optional): Profit. A decimal pair: the amount is `value` ÷ 10^`dp` (`{ "value": 1250, "dp": 2 }` is 12.50). Kept with 2 decimal places; an amount never set can come as `{ "value": 0, "dp": 0 }`. Read `dp` every time: it can differ between fields and records. See https://developer.yoprint.com/concepts/money-and-quantities.md.
  - `paid_amount` (integer | number | string | null, optional): Paid so far. Thousandths, an older encoding: `12500` is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (`1234.5` is 1.2345), or as a string (`"1234.5"`) when you send `X-Yoprint-Decimal-Format: exact-v1`. See [Money and quantities](/concepts/money-and-quantities/).
  - `payment_lock_version` (integer | string | null, optional): Changes whenever the order's payments change.
  - `payment_term_id` (string | null, optional)
  - `pricing_group_id` (string | null, optional)
  - `pricing_strategy` (string | null, optional): `job_separately`, `job_together` or `service_loc_together`.
  - `prod_note` (string | null, optional): The production note.
  - `producible_item_count` (number | integer | string | null, optional): Quantity to produce.
  - `quickbook_disable_sync` (boolean, optional): true when QuickBooks sync is off for this order.
  - `quickbook_disable_sync_at` (string (date-time) | null, optional): When the switch was last changed. ISO 8601 with offset, or null.
  - `quickbook_disable_sync_by` (string | null, optional): The team member who last changed the switch, or null.
  - `quickbook_disable_sync_reason` (string | null, optional): The note given at the last change of the order's QuickBooks sync switch (off or back on), at most 500 characters, or null.
  - `quickbook_last_error_sync` (string (date-time) | null, optional): When a QuickBooks sync of the order last failed. ISO 8601 with offset, or null.
  - `quickbook_last_success_sync` (string (date-time) | null, optional): When QuickBooks last accepted the order. ISO 8601 with offset, or null.
  - `quickbooks_hold` (object | null, optional): Set when YoPrint holds back a QuickBooks payment covering this order: `code` is `changed`, `deleted` or `rejected` (the payment was changed or deleted in QuickBooks, or QuickBooks refused a change), and `detail` is `already_deposited` (the payment is in a QuickBooks bank deposit) or null. Null when nothing is held.
    - `code` (string, optional): One of: `"changed"`, `"deleted"`, `"rejected"`.
    - `detail` (string | null, optional)
  - `quote` (boolean, optional): Older flag: true for a quote.
  - `ship_due_date` (string (date-time) | null, optional): Ship due date. ISO 8601 with offset, or null.
  - `shipment_billable_fee_invoice_status` (string | null, optional): Whether those shipping fees are on an invoice. Null when there is nothing to bill.
  - `shipment_billable_fee_total` (decimal pair, optional): The shipping fees you bill the customer on the order's shipments. A decimal pair: the amount is `value` ÷ 10^`dp` (`{ "value": 125000, "dp": 4 }` is 12.50). Kept with 4 decimal places; an amount never set can come as `{ "value": 0, "dp": 0 }`. Read `dp` every time: it can differ between fields and records. See https://developer.yoprint.com/concepts/money-and-quantities.md.
  - `shipment_cost_total` (decimal pair, optional): Shipping cost incurred. A decimal pair: the amount is `value` ÷ 10^`dp` (`{ "value": 125000, "dp": 4 }` is 12.50). Kept with 4 decimal places; an amount never set can come as `{ "value": 0, "dp": 0 }`. Read `dp` every time: it can differ between fields and records. See https://developer.yoprint.com/concepts/money-and-quantities.md.
  - `shipment_lock_version` (integer | string | null, optional): Changes whenever the order's shipments change.
  - `shipping_address` (object | null, optional): An address, as the address operations return it. Same fields as `data.billing_address` above.
  - `shipping_address_id` (string | null, optional)
  - `shopify_last_error_sync` (string (date-time) | null, optional): When a Shopify sync of the order last failed. Shopify orders only. ISO 8601 with offset, or null.
  - `shopify_last_success_sync` (string (date-time) | null, optional): When Shopify last accepted the order. Shopify orders only. ISO 8601 with offset, or null.
  - `shopify_terminal_topic` (string | null, optional): Shopify orders only: the Shopify event name behind the order's final state there. Null on YoPrint orders. The answer can also hold more `shopify_*` fields (`shopify_admin_url`, `shopify_compliance_deletion`, `shopify_finance_notices`, `shopify_has_fulfillment_conflict`, `shopify_last_fulfillment_conflict_at`): they are null or empty on YoPrint orders.
  - `start_date` (string (date-time) | null, optional): Production start. ISO 8601 with offset, or null.
  - `status` (object | null, optional): The order's status (always included).
    - `color` (string, required): A hex color, such as `#2196f3`.
    - `customer_label` (string, required): What customers see in the customer portal. When none is set: `Pending` for `start`, `In Progress` for `in_progress` and `pre_production`, `Completed` for `end`.
    - `id` (string, required)
    - `label` (string, required): The status name people see.
    - `position` (integer, required): Sort order within its list, lowest first.
    - `role` (string, required): Which list the status belongs to: `order`, `quote`, `job`, `shipment`, `purchase_order`, `pipeline` or `customer_message`.
    - `trashed` (boolean, required): true for a deleted status.
    - `type` (string, required): `start` is the first status of its list and `end` the last; `pre_production` and `in_progress` are the ones in between. One of: `"start"`, `"pre_production"`, `"in_progress"`, `"end"`.
    - `pipeline_id` (string, optional): The task preset, for `pipeline` statuses only; absent for other roles.
  - `status_completion_date` (string (date-time) | null, optional): When the order's status last moved to an end status. ISO 8601 with offset, or null.
  - `status_id` (string, optional): The order's status (from the team's sales order or quote statuses).
  - `status_last_change_date` (string (date-time) | null, optional): Last status change. ISO 8601 with offset, or null.
  - `tags` (array of objects, optional)
    - Each item:
      - `color_hex` (string | null, optional): Tag color, for example `#E53935`.
      - `id` (string, optional)
      - `name` (string, optional)
  - `total_qty_need_ordering` (string, optional): Quantity still to buy, as a decimal string with 8 decimal places (`"24.00000000"`).
  - `trashed` (boolean, optional): true when the order is deleted.
  - `type` (string, optional): Older name for `object_type`. One of: `"order"`, `"quote"`.
  - `unallocated_amount` (integer | number | string | null, optional): Payments not yet allocated to an invoice. Thousandths, an older encoding: `12500` is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (`1234.5` is 1.2345), or as a string (`"1234.5"`) when you send `X-Yoprint-Decimal-Format: exact-v1`. See [Money and quantities](/concepts/money-and-quantities/).
  - `updated_at` (string (date-time) | null, optional): Last changed. ISO 8601 with offset, or null.
  - `version` (integer | string | null, optional): The order format version.
  - `wallet_currency_iso` (string | null, optional): The order's currency code (`USD` and so on), or null on older orders without one.
  - `warehouse_id` (string | null, optional)
  - `calc_discount` (integer | number | string | null, optional, deprecated): **Deprecated:** use `invoiced_discount_subtotal`, the same amount. Thousandths, an older encoding: `12500` is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (`1234.5` is 1.2345), or as a string (`"1234.5"`) when you send `X-Yoprint-Decimal-Format: exact-v1`. See [Money and quantities](/concepts/money-and-quantities/).
  - `calc_subtotal` (integer | number | string | null, optional, deprecated): **Deprecated:** use `invoiced_order_item_subtotal`, which already includes billed shipping. This older field adds `invoiced_shipment_subtotal` to it once more. Thousandths, an older encoding: `12500` is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (`1234.5` is 1.2345), or as a string (`"1234.5"`) when you send `X-Yoprint-Decimal-Format: exact-v1`. See [Money and quantities](/concepts/money-and-quantities/).
  - `calc_tax` (integer | number | string | null, optional, deprecated): **Deprecated:** use `invoiced_tax_subtotal`, the same amount. Thousandths, an older encoding: `12500` is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (`1234.5` is 1.2345), or as a string (`"1234.5"`) when you send `X-Yoprint-Decimal-Format: exact-v1`. See [Money and quantities](/concepts/money-and-quantities/).
  - `calc_total` (integer | number | string | null, optional, deprecated): **Deprecated:** use `invoiced_total`, the same amount. Thousandths, an older encoding: `12500` is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (`1234.5` is 1.2345), or as a string (`"1234.5"`) when you send `X-Yoprint-Decimal-Format: exact-v1`. See [Money and quantities](/concepts/money-and-quantities/).
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": {
    "assigned_users": [],
    "calc_deposit_total": 0,
    "customer": {
      "id": "63KcENAAsKuipY",
      "is_external": false,
      "name": "Northwind Apparel",
      "tax_exempt": false
    },
    "customer_id": "63KcENAAsKuipY",
    "customer_po_number": "PO-1188",
    "deposit_amount_due": {
      "dp": 4,
      "value": 0
    },
    "deposit_required": true,
    "deposit_total": 50000,
    "due_date": "2026-11-14T00:00:00+00:00",
    "id": "V4keXwwxMQyXw7",
    "internal_status": "draft",
    "invoiced_discount_subtotal": {
      "dp": 0,
      "value": 0
    },
    "invoiced_order_item_subtotal": {
      "dp": 0,
      "value": 0
    },
    "invoiced_shipment_subtotal": {
      "dp": 0,
      "value": 0
    },
    "invoiced_tax_subtotal": {
      "dp": 0,
      "value": 0
    },
    "invoiced_total": {
      "dp": 0,
      "value": 0
    },
    "is_rush": false,
    "issue_date": "2026-11-03T09:00:00+00:00",
    "mode": "create",
    "name": null,
    "object_type": "sales_order",
    "order_balance_due": {
      "dp": 4,
      "value": 0
    },
    "order_item_cart_total": {
      "dp": 0,
      "value": 0
    },
    "paid_amount": 0,
    "quote": false,
    "scoped_id": "SO1001",
    "status": {
      "color": "#9e9e9e",
      "customer_label": "Pending",
      "id": "HqXxdtvY4icbzQ",
      "label": "New",
      "position": 1,
      "role": "order",
      "trashed": false,
      "type": "start"
    },
    "status_id": "HqXxdtvY4icbzQ",
    "total_qty_need_ordering": "0.00000000",
    "trashed": false,
    "type": "order",
    "unique_key": "ord_EXAMPLEuniqueKey"
  },
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
  - When: The API key's role lacks `create_order`. Fix: Ask the team owner for permission to create orders.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
- `422` The request was refused and changed nothing. `validation_failed` lists what to fix in `error.fields`; other codes name a business rule, explained in `error.message`. A few checks answer with only `{"message": "..."}`. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer `connect_timeout` ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
  - When: The team has no default pricing group, `object_type` and `quote` disagree, or the customer comes from Shopify. Fix: Set a default pricing group in Settings, send matching values, or pick another customer.
  - When: `is_external: true`: "Cannot create external object from API." Fix: Leave `is_external` out.

## Notes

- The answer's `id` is the order's id for every other call. Save it.
- A new draft has no name; set one with Update.
- Change the customer of a draft later with the `change_customer` action, not with Update.

## Related

- [Add a job to a sales order or quote](https://developer.yoprint.com/reference/jobs/v2-job-store.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/job`
- [Add a line item to a sales order or quote](https://developer.yoprint.com/reference/sales-order-line-items/v2-order-item-store.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/order_item`
- [Publish a draft sales order or quote](https://developer.yoprint.com/reference/sales-orders/v2-order-publish.md): `PATCH /v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/publish`
- [Update a sales order or quote](https://developer.yoprint.com/reference/sales-orders/v2-order-update.md): `PUT /v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}`