Orders

Send an order in (create or update)

Secret key. Permission orders:write. Creates the order, or updates it if external_id was sent before. Safe to retry. The order source is decided by the key, never by the body: a WooCommerce connection key gives woocommerce, a Shopify connection gives shopify, any other secret key gives api.

post/orders

Request

  • Base URL: https://sitesplaced.com/api/v1
  • URL: https://sitesplaced.com/api/v1/orders
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Request body

external_idstring required

The order's id on the other system. Sending the same one again updates the order.

numberstring

The order number a shopper sees.

statusstring

Read according to status_kind.

status_kind'woocommerce' | 'shopify' | 'sitesplaced'

woocommerce: WooCommerce status slugs, with or without wc-. shopify: open, partial, fulfilled or cancelled. sitesplaced: the six order statuses, plus the aliases delivered, fulfilled, processing, paid and canceled. A connection key defaults to its platform; any other key defaults to sitesplaced.

currencystring
notestring
created_atstring date-time

ISO 8601, in UTC.

updated_atstring date-time

Older than the copy SitesPlaced holds → ignored (action: "unchanged").

admin_urlstring

The order's admin address on the other system.

deletedboolean

True archives the copy. It is never hard-deleted.

testboolean

True → skipped.

deliveredboolean

Example request

{
  "payment": {
    "method": "razorpay",
    "method_title": "Credit Card/UPI"
  },
  "currency": "INR",
  "customer": {
    "country": "IN"
  },
  "items": [
    {
      "variant": "Size: Small"
    }
  ]
}

Response

The order was updated, was unchanged, or was skipped.

action'created' | 'updated' | 'unchanged' | 'skipped' required
reasonstring

Set when action is skipped.

Example response

{
  "order": {
    "external_status": "processing",
    "currency": "INR",
    "risk": {
      "flags": [
        {
          "code": "bad_phone"
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.