Orders

GET

Retrieves all orders for the authenticated user.

GET/orders

Response

200401

Orders retrieved successfully

Body

application/json

idnumber

Example: 1

userIdnumber

Example: 1

datestring (date-time)

Example: "2023-01-01T00:00:00Z"

productsarray of object

amountInCentsnumber

Example: 2000

clientSecretstring

Example: "client_secret"

statusstring

Example: "pending"

Request

JavaScriptCurlPython

const response = await fetch('/orders', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

[
  {
    "id": 1,
    "userId": 1,
    "date": "2023-01-01T00:00:00Z",
    "products": [
      {
        "id": 1,
        "name": "Product Name",
        "quantity": 2,
        "priceInCents": 1000
      }
    ],
    "amountInCents": 2000,
    "clientSecret": "client_secret",
    "status": "pending"
  }
]

Retrieves a demo cart with sample products.

GET/orders/demo-cart

Response

200

Demo cart retrieved successfully

Body

application/json

idnumber

Example: 1

namestring

Example: "Product Name"

quantitynumber

Example: 2

priceInCentsnumber

Example: 1000

Request

JavaScriptCurlPython

const response = await fetch('/orders/demo-cart', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 1,
    "name": "Product Name",
    "quantity": 2,
    "priceInCents": 1000
  }
]

Retrieves an order by its ID for the authenticated user.

GET/orders/{id}

Path parameters

id*number

Response

200401404

Order retrieved successfully

Body

application/json

idnumber

Example: 1

userIdnumber

Example: 1

datestring (date-time)

Example: "2023-01-01T00:00:00Z"

productsarray of object

amountInCentsnumber

Example: 2000

clientSecretstring

Example: "client_secret"

statusstring

Example: "pending"

Request

JavaScriptCurlPython

const response = await fetch('/orders/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "id": 1,
  "userId": 1,
  "date": "2023-01-01T00:00:00Z",
  "products": [
    {
      "id": 1,
      "name": "Product Name",
      "quantity": 2,
      "priceInCents": 1000
    }
  ],
  "amountInCents": 2000,
  "clientSecret": "client_secret",
  "status": "pending"
}

POST

Creates a new order for the authenticated user.

POST/orders/new

Body

application/json

itemsstring

Response

201400

Order created successfully

Body

application/json

idnumber

Example: 1

userIdnumber

Example: 1

datestring (date-time)

Example: "2023-01-01T00:00:00Z"

productsarray of object

amountInCentsnumber

Example: 2000

clientSecretstring

Example: "client_secret"

statusstring

Example: "pending"

Request

JavaScriptCurlPython

const response = await fetch('/orders/new', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "text"
    ]),
});
const data = await response.json();

Response

201400

{
  "id": 1,
  "userId": 1,
  "date": "2023-01-01T00:00:00Z",
  "products": [
    {
      "id": 1,
      "name": "Product Name",
      "quantity": 2,
      "priceInCents": 1000
    }
  ],
  "amountInCents": 2000,
  "clientSecret": "client_secret",
  "status": "pending"
}

Updates the status of an order.

POST/orders/status-update

Body

application/json

orderId*number

ID of the order

Example: 123

status*enum

Status of the order

Example: "Pending"

Awaiting PaymentPayment FailedOrder PaidShippedCompletedCancelledDeclined

Response

200400

Order status updated successfully

Body

application/json

idnumber

Example: 1

statusstring

Example: "completed"

Request

JavaScriptCurlPython

const response = await fetch('/orders/status-update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "orderId": 123,
      "status": "Pending"
    }),
});
const data = await response.json();

Response

200400

{
  "id": 1,
  "status": "completed"
}

PUT

Updates the order of lead statuses.

PUT/leads/statuses/order

Body

application/json

Lead statuses order update data

id*number

ID of the status

Example: 1

statusOrder*number

Order of the status

Example: 1

Response

200500

Lead statuses order updated successfully

Body

application/json

idnumber

Example: 1

statusOrdernumber

Example: 1

Request

JavaScriptCurlPython

const response = await fetch('/leads/statuses/order', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": 1,
      "statusOrder": 1
    }),
});
const data = await response.json();

Response

200500

[
  {
    "id": 1,
    "statusOrder": 1
  }
]