Sign in

v50

latestOpenAPI 3.1.0Creative Force Client Subscription Termsraw.githubusercontent.com2026-07-137852387.4 KB
Orders

Update an order

Updates the billing information and status of the order identified by the specified slug.

put/order/{order_slug}

Headers

Accept'application/vnd.Creative Force.v2.3+json' | 'application/vnd.Creative Force.v2.3+xml' required

Defines the response type.

x-api-languagestring[]

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.

Request body

companystring

Billing company name.

addressstring

Billing address.

citystring

Billing city.

statestring

Billing state.

postcodestring

Billing postcode.

countrystring

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

payment_status'paid' | 'awaiting_payment'

Status of the order.

notestring

Annotation on the order.

Response

Order updated.

addressstring

Billing street address supplied for the order.

citystring

Billing city supplied for the order.

commentsstring

Free-text comments recorded against the order.

companystring

Billing company name supplied for the order.

countrystring

Billing country supplied for the order.

created_atstring date-time

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

currencystring

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

discountnumber

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

discount_codestring

Discount code applied to the order.

Empty string when no code was applied.

e_invoice_statusstring

Electronic invoicing status of the order.

invoice_numberstring

Invoice number assigned to the order.

ip_addressstring ip-address

IP address the order was placed from.

itemsstring

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

member_numberstring

Membership number recorded against the order.

payment_methodstring

Method used to pay for the order.

payment_statusstring

Payment status of the order.

postcodestring

Billing postcode supplied for the order.

processing_feenumber

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

processing_fee_ratenumber nullable

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

null when no processing fee applies.

regionstring

Billing region supplied for the order.

slugstring

Short URL-safe identifier for the order.

statestring

Billing state supplied for the order.

subtotalnumber

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

taxnumber

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

tax_ratenumber nullable

Rate used to calculate tax, as a percentage.

null when no tax applies.

tax_termstring

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

totalnumber

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

transaction_datestring date-time nullable

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

null when the order has no recorded payment transaction.

transaction_providerstring

Payment provider that processed the transaction.

transaction_referencestring

Reference assigned to the transaction by the payment provider.

transaction_statusstring

Status of the payment transaction.

vat_numberstring

VAT number supplied for the order.

Example response

{
  "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"
}