PATCH
/
api
/
v2
/
platform
/
orders
/
{id}
/
complete
Completes an Order
curl --request PATCH \
  --url http://{defaultHost}/api/v2/platform/orders/{id}/complete \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "56",
    "type": "order",
    "attributes": {
      "number": "R923002122",
      "item_total": "10.0",
      "total": "110.0",
      "state": "complete",
      "adjustment_total": "0.0",
      "completed_at": "2022-11-08T19:34:42.207Z",
      "payment_total": "0.0",
      "shipment_state": "pending",
      "payment_state": "balance_due",
      "email": "adeline@hodkiewicz.co.uk",
      "special_instructions": null,
      "created_at": "2022-11-08T19:34:41.758Z",
      "updated_at": "2022-11-08T19:34:42.207Z",
      "currency": "USD",
      "last_ip_address": null,
      "shipment_total": "100.0",
      "additional_tax_total": "0.0",
      "promo_total": "0.0",
      "channel": "spree",
      "included_tax_total": "0.0",
      "item_count": 1,
      "approved_at": null,
      "confirmation_delivered": false,
      "canceled_at": null,
      "state_lock_version": 0,
      "taxable_adjustment_total": "0.0",
      "non_taxable_adjustment_total": "0.0",
      "store_owner_notification_delivered": null,
      "public_metadata": {},
      "private_metadata": {},
      "internal_note": null,
      "display_ship_total": "$100.00",
      "display_shipment_total": "$100.00",
      "display_outstanding_balance": "$110.00",
      "display_item_total": "$10.00",
      "display_adjustment_total": "$0.00",
      "display_included_tax_total": "$0.00",
      "display_additional_tax_total": "$0.00",
      "display_tax_total": "$0.00",
      "display_promo_total": "$0.00",
      "display_total": "$110.00",
      "display_cart_promo_total": "$0.00",
      "display_pre_tax_item_amount": "$10.00",
      "display_pre_tax_total": "$110.00",
      "display_total_applicable_store_credit": "$0.00",
      "display_total_applied_store_credit": "$0.00",
      "display_order_total_after_store_credit": "$110.00",
      "display_total_available_store_credit": "$0.00",
      "display_store_credit_remaining_after_capture": "$0.00"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "56",
          "type": "user"
        }
      },
      "created_by": {
        "data": null
      },
      "approver": {
        "data": null
      },
      "canceler": {
        "data": null
      },
      "bill_address": {
        "data": {
          "id": "79",
          "type": "address"
        }
      },
      "ship_address": {
        "data": {
          "id": "80",
          "type": "address"
        }
      },
      "line_items": {
        "data": [
          {
            "id": "47",
            "type": "line_item"
          }
        ]
      },
      "payments": {
        "data": [
          {
            "id": "2",
            "type": "payment"
          }
        ]
      },
      "shipments": {
        "data": [
          {
            "id": "12",
            "type": "shipment"
          }
        ]
      },
      "state_changes": {
        "data": [
          {
            "id": "4",
            "type": "state_change"
          },
          {
            "id": "5",
            "type": "state_change"
          },
          {
            "id": "8",
            "type": "state_change"
          },
          {
            "id": "9",
            "type": "state_change"
          },
          {
            "id": "10",
            "type": "state_change"
          }
        ]
      },
      "return_authorizations": {
        "data": []
      },
      "reimbursements": {
        "data": []
      },
      "adjustments": {
        "data": []
      },
      "all_adjustments": {
        "data": []
      },
      "order_promotions": {
        "data": []
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Query Parameters

​
include
string

Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>

Response

200
application/vnd.api+json

Record updated

The response is of type object.