Update an order

{
  "address": "12 Example Street",
  "city": "London",
  "comments": "",
  "company": "Example Productions Ltd",
  "country": "United Kingdom",
  "created_at": "2026-01-15T09:00:00Z",
  "currency": "GBP",
  "discount": 0,
  "discount_code": "",
  "e_invoice_status": "none",
  "invoice_number": "INV-001234",
  "ip_address": "203.0.113.42",
  "items": "<ul><li>Standard entry &times; 1 &mdash; &pound;50.00</li></ul>",
  "items_array": [
    {
      "amount": "£50.00",
      "description": "Standard entry",
      "discount": "£0.00",
      "entry": {
        "slug": "AbCdEfGh",
        "link": "https://api.au.cr4ce.com/entry/AbCdEfGh",
        "title": "Sustainable Cities Initiative"
      },
      "item_type": "entry",
      "name": "Standard entry",
      "price": {
        "slug": "IjKlMnOp",
        "link": "https://api.au.cr4ce.com/price/IjKlMnOp",
        "title": {
          "en_GB": "Standard entry"
        }
      },
      "quantity": 1
    }
  ],
  "member_number": "",
  "payment_method": "card",
  "payment_status": "paid",
  "postcode": "EC1A 1BB",
  "processing_fee": 1.5,
  "processing_fee_rate": 3,
  "region": "",
  "season": {
    "slug": "QrStUvWx",
    "link": "https://api.au.cr4ce.com/season/QrStUvWx",
    "name": {
      "en_GB": "2025"
    }
  },
  "slug": "YzAbCdEf",
  "state": "",
  "subtotal": 50,
  "tax": 10,
  "tax_rate": 20,
  "tax_rate_details": {
    "country": "GB",
    "link": "https://api.au.cr4ce.com/tax/GhIjKlMn",
    "name": "VAT",
    "rate": 20,
    "region": null,
    "slug": "GhIjKlMn",
    "term": "VAT"
  },
  "tax_term": "VAT",
  "total": 61.5,
  "transaction_date": "2026-01-15T09:01:00Z",
  "transaction_provider": "stripe",
  "transaction_reference": "REDACTED",
  "transaction_status": "succeeded",
  "user": {
    "slug": "OpQrStUv",
    "link": "https://api.au.cr4ce.com/user/OpQrStUv",
    "name": "Jane Smith",
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "jane.smith@example.com"
  },
  "vat_number": "GB123456789"
}

{
  "message": "<string>",
  "status_code": 400
}

{
  "message": "<string>",
  "status_code": 401
}

{
  "message": "<string>",
  "status_code": 403
}

{
  "message": "<string>",
  "status_code": 404
}

{
  "message": "<string>",
  "status_code": 422,
  "errors": {}
}

{
  "message": "<string>",
  "status_code": 429
}

{
  "status": "Maintenance in progress"
}

PUT

order

{order_slug}

{
  "address": "12 Example Street",
  "city": "London",
  "comments": "",
  "company": "Example Productions Ltd",
  "country": "United Kingdom",
  "created_at": "2026-01-15T09:00:00Z",
  "currency": "GBP",
  "discount": 0,
  "discount_code": "",
  "e_invoice_status": "none",
  "invoice_number": "INV-001234",
  "ip_address": "203.0.113.42",
  "items": "<ul><li>Standard entry &times; 1 &mdash; &pound;50.00</li></ul>",
  "items_array": [
    {
      "amount": "£50.00",
      "description": "Standard entry",
      "discount": "£0.00",
      "entry": {
        "slug": "AbCdEfGh",
        "link": "https://api.au.cr4ce.com/entry/AbCdEfGh",
        "title": "Sustainable Cities Initiative"
      },
      "item_type": "entry",
      "name": "Standard entry",
      "price": {
        "slug": "IjKlMnOp",
        "link": "https://api.au.cr4ce.com/price/IjKlMnOp",
        "title": {
          "en_GB": "Standard entry"
        }
      },
      "quantity": 1
    }
  ],
  "member_number": "",
  "payment_method": "card",
  "payment_status": "paid",
  "postcode": "EC1A 1BB",
  "processing_fee": 1.5,
  "processing_fee_rate": 3,
  "region": "",
  "season": {
    "slug": "QrStUvWx",
    "link": "https://api.au.cr4ce.com/season/QrStUvWx",
    "name": {
      "en_GB": "2025"
    }
  },
  "slug": "YzAbCdEf",
  "state": "",
  "subtotal": 50,
  "tax": 10,
  "tax_rate": 20,
  "tax_rate_details": {
    "country": "GB",
    "link": "https://api.au.cr4ce.com/tax/GhIjKlMn",
    "name": "VAT",
    "rate": 20,
    "region": null,
    "slug": "GhIjKlMn",
    "term": "VAT"
  },
  "tax_term": "VAT",
  "total": 61.5,
  "transaction_date": "2026-01-15T09:01:00Z",
  "transaction_provider": "stripe",
  "transaction_reference": "REDACTED",
  "transaction_status": "succeeded",
  "user": {
    "slug": "OpQrStUv",
    "link": "https://api.au.cr4ce.com/user/OpQrStUv",
    "name": "Jane Smith",
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "jane.smith@example.com"
  },
  "vat_number": "GB123456789"
}

{
  "message": "<string>",
  "status_code": 400
}

{
  "message": "<string>",
  "status_code": 401
}

{
  "message": "<string>",
  "status_code": 403
}

{
  "message": "<string>",
  "status_code": 404
}

{
  "message": "<string>",
  "status_code": 422,
  "errors": {}
}

{
  "message": "<string>",
  "status_code": 429
}

{
  "status": "Maintenance in progress"
}

Authorizations

x-api-key

string

header

required

API key used to authenticate and authorise every request. Include it in the x-api-key header.

Headers

enum<string>

required

Defines the response type.

Available options:

application/vnd.Creative Force.v2.3+json,

application/vnd.Creative Force.v2.3+xml

x-api-language

enum<string>[]

Defines the languages included in the response. If non are provided, the account default language is returned.

Value all overrides any other values present.

You can request multiple languages using a comma-separated string of languages.

The selected language must be supported by your account or a 400 error is returned.

Available options:

all,

ar_AR,

bg_BG,

bn_IN,

ca_ES,

cs_CZ,

cy_GB,

da_DK,

de_DE,

en_GB,

en_US,

el_GR,

es_NN,

es_LA,

et_EE,

fa_NN,

fi_FI,

fr_FR,

fr_CA,

he_IL,

hi_IN,

hr_HR,

hu_HU,

hy_AM,

it_IT,

ja_JP,

ko_KR,

lt_LT,

ms_MY,

nl_NL,

nb_NO,

pl_PL,

pt_BR,

ro_RO,

ru_RU,

sk_SK,

sl_SI,

sq_AL,

sr_RS,

sv_SE,

sw_NN,

th_TH,

tr_TR,

uk_UA,

vi_VN,

zh_CN,

zh_HK

Path Parameters

order_slug

string

required

Slug of the order.

Pattern: ^[A-Za-z]{8}$

Body

application/json

Order update payload.

company

string

Billing company name.

address

string

Billing address.

city

string

Billing city.

state

string

Billing state.

postcode

string

Billing postcode.

country

string

Two-letter country code. See Two-letter country codes.

payment_status

enum<string>

Status of the order.

Available options:

paid,

awaiting_payment

note

string

Annotation on the order.

Response

Order updated.

Order recording a purchase made on the account, including billing details, line items, applied discounts, tax and fees, totals, and payment and transaction status.

address

string

Billing street address supplied for the order.

city

string

Billing city supplied for the order.

comments

string

Free-text comments recorded against the order.

company

string

Billing company name supplied for the order.

country

string

Billing country supplied for the order.

created_at

string<date-time>

Date and time the order was created, in ISO 8601 format.

currency

string

Currency the order amounts are denominated in, as an ISO 4217 code.

discount

number

Total discount applied to the order, in the order currency.

discount_code

string

Discount code applied to the order.

Empty string when no code was applied.

e_invoice_status

string

Electronic invoicing status of the order.

invoice_number

string

Invoice number assigned to the order.

ip_address

string<ip-address>

IP address the order was placed from.

items

string

HTML-formatted summary of the line items for the order, suitable for display.

items_array

object[]

Structured list of the line items for the order.

Show child attributes

member_number

string

Membership number recorded against the order.

payment_method

string

Method used to pay for the order.

payment_status

string

Payment status of the order.

postcode

string

Billing postcode supplied for the order.

processing_fee

number

Processing fee charged on the order, in the order currency.

processing_fee_rate

number | null

Rate used to calculate the processing fee, as a percentage.

null when no processing fee applies.

region

string

Billing region supplied for the order.

season

object

Season the order was placed in.

Show child attributes

slug

string

Short URL-safe identifier for the order.

state

string

Billing state supplied for the order.

subtotal

number

Order subtotal before tax and fees, in the order currency.

tax

number

Total tax charged on the order, in the order currency.

tax_rate

number | null

Rate used to calculate tax, as a percentage.

null when no tax applies.

tax_rate_details

object

Details of the tax rate applied to the order.

Show child attributes

tax_term

string

Display term used for tax on the order, such as VAT or GST.

total

number

Order total including tax and fees, in the order currency.

transaction_date

string<date-time> | null

Date and time of the payment transaction, in ISO 8601 format.

null when the order has no recorded payment transaction.

transaction_provider

string

Payment provider that processed the transaction.

transaction_reference

string

Reference assigned to the transaction by the payment provider.

transaction_status

string

Status of the payment transaction.

user

object

User who placed the order.

Show child attributes

vat_number

string

VAT number supplied for the order.

Retrieve an order Payment pending

Account

Assignments

Attachments

Categories

Chapters

Contributors

Documents

Entries

Entries (realtime)

Fields

Files

Leaderboard

Orders

Review tasks

Rounds

Score sets

Seasons

Taxes

Users

Webhooks

Authorizations

Headers

Path Parameters

Body

Response