Custom integrations

Create an order

Write requests are disabled on production docs to avoid account noise. Fill the request below, then copy the generated cURL, fetch, or JSON output.

Copy page

Step 2 of the custom integration flow. After your server handles the WEBHOOK product:created callback and returns an external_id, send the completed order from your ecommerce platform. Each products[].external_id value must match a product ID you previously returned during product creation.

POST /api/v2/orders

Authorisation

Bearer token required. Include in the Authorization header.

Request body

integration_id integer body

external_id string body

external_order_number string body

currency string body

billing_address object body

shipping_address object body

shipping_line string body

customer object body

products array body

Request body example

{
  "integration_id": 42,
  "external_id": "order-123456",
  "external_order_number": "SC-1001",
  "currency": "USD",
  "billing_address": {
    "first_name": "John",
    "last_name": "Smith",
    "email": "customer@example.com",
    "phone": "+1 555-123-4567",
    "address_1": "123 Main St",
    "address_2": "Suite 4",
    "city": "Los Angeles",
    "province": "CA",
    "postcode": "90001",
    "country": "US"
  },
  "shipping_address": {
    "first_name": "John",
    "last_name": "Smith",
    "address_1": "123 Main St",
    "address_2": "Suite 4",
    "city": "Los Angeles",
    "province": "CA",
    "postcode": "90001",
    "country": "US"
  },
  "shipping_line": "Standard Shipping",
  "customer": {
    "first_name": "John",
    "last_name": "Smith",
    "email": "customer@example.com",
    "phone": "+1 555-123-4567"
  },
  "products": [
    {
      "external_id": "your-product-id-123",
      "quantity": 2,
      "price": 2999
    }
  ]
}

Create an order

curl https://web.signcustomiser.com/api/v2/orders \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "integration_id": 42,
  "external_id": "order-123456",
  "external_order_number": "SC-1001",
  "currency": "USD",
  "billing_address": {
    "first_name": "John",
    "last_name": "Smith",
    "email": "customer@example.com",
    "phone": "+1 555-123-4567",
    "address_1": "123 Main St",
    "address_2": "Suite 4",
    "city": "Los Angeles",
    "province": "CA",
    "postcode": "90001",
    "country": "US"
  },
  "shipping_address": {
    "first_name": "John",
    "last_name": "Smith",
    "address_1": "123 Main St",
    "address_2": "Suite 4",
    "city": "Los Angeles",
    "province": "CA",
    "postcode": "90001",
    "country": "US"
  },
  "shipping_line": "Standard Shipping",
  "customer": {
    "first_name": "John",
    "last_name": "Smith",
    "email": "customer@example.com",
    "phone": "+1 555-123-4567"
  },
  "products": [
    {
      "external_id": "your-product-id-123",
      "quantity": 2,
      "price": 2999
    }
  ]
}'

{
  "order": {
    "order_id": 1,
    "external_id": "order-123456",
    "external_order_number": "SC-1001",
    "currency": "USD",
    "shipping_line": "Standard Shipping",
    "products": [
      {
        "external_id": "product-987654321",
        "quantity": 2,
        "price": 2999
      }
    ]
  }
}