Order

Upsert an order

Upsert an order

put/unstable/order

Request

  • Base URL
    https://api.authentified.co
  • Auth
    API key in header X-Authentified-API-Key

Request body

idstring required

The Unique Identifier of the order in your system

customerIdstring required

The Unique Identifier of the customer who placed the order

paidStatus'PENDING' | 'PARTIALLY_PAID' | 'PARTIALLY_REFUNDED' | 'PAID' | 'REFUNDED' | 'VOIDED' required

The financial status of the order

totalnumber

The total amount of the order

currencyCodestring

The currency code of the order total

createdAtstring date-time

The date and time when the order was created in your system

updatedAtstring date-time

The date and time when the order was updated in your system

Example request

{
  "id": "940198",
  "customerId": "897835",
  "paidStatus": "PAID",
  "total": 149.99,
  "currencyCode": "USD",
  "createdAt": "2023-10-01T12:12:00Z",
  "updatedAt": "2023-10-01T18:38:00Z"
}

Response

Order updated successfully

idstring required

The Unique Identifier of the order in your system

customerIdstring required

The Unique Identifier of the customer who placed the order

paidStatus'PENDING' | 'PARTIALLY_PAID' | 'PARTIALLY_REFUNDED' | 'PAID' | 'REFUNDED' | 'VOIDED' required

The financial status of the order

totalnumber

The total amount of the order

currencyCodestring

The currency code of the order total

createdAtstring date-time

The date and time when the order was created in your system

updatedAtstring date-time

The date and time when the order was updated in your system

Example response

{
  "id": "940198",
  "customerId": "897835",
  "paidStatus": "PAID",
  "total": 149.99,
  "currencyCode": "USD",
  "createdAt": "2023-10-01T12:12:00Z",
  "updatedAt": "2023-10-01T18:38:00Z"
}

Changes

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