Orders

Advance Status

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/orders/advanceStatus" \  -H "Content-Type: application/json" \  -d '{    "orderId": "string"  }'

{}

Archive Many

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderIds*array<>

Items1 <= items

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/orders/archiveMany" \  -H "Content-Type: application/json" \  -d '{    "orderIds": [      "string"    ]  }'

{}

Checkout

Path Parameters

organizationSlug*string

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email?|

firstName*string

Length1 <= length <= 50

lastName*string

Length1 <= length <= 50

phoneNumber*string

Length1 <= length

city*string

Length1 <= length <= 50

country*string

Length1 <= length <= 50

line1*string

Length1 <= length

line2*|

postalCode*string

Match^\d{4,10}$

state*string

Length1 <= length <= 50

type*string

Value in"BILLING" | "SHIPPING"

addressId?string

couponCode?string

customerNotes?string

deliveryType?string

Value in"HOME" | "STOPDESK"

internalNotes?string

locale?string

Value in"en" | "ar" | "fr"

provider*string

Value in"CASH_ON_DELIVERY" | "STRIPE"

variants*array<>

Items1 <= items

wilayaCode?string

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/string/orders/checkout" \  -H "Content-Type: application/json" \  -d '{    "firstName": "string",    "lastName": "string",    "phoneNumber": "string",    "city": "string",    "country": "string",    "line1": "string",    "line2": "string",    "postalCode": "string",    "state": "string",    "type": "BILLING",    "provider": "CASH_ON_DELIVERY",    "variants": [      {        "variantId": "string"      }    ]  }'

{}

Cod Reconciliation

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

dateFrom?string

Match^\d{4}-\d{2}-\d{2}$

dateTo?string

Match^\d{4}-\d{2}-\d{2}$

limit?number

Default10

Range1 <= value <= 100

page?number

Default1

Range1 <= value

status?string

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/orders/codReconciliation" \  -H "Content-Type: application/json" \  -d '{}'

{}

Cod Reconciliation Csv

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

dateFrom?string

Match^\d{4}-\d{2}-\d{2}$

dateTo?string

Match^\d{4}-\d{2}-\d{2}$

status?string

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/orders/codReconciliationCsv" \  -H "Content-Type: application/json" \  -d '{}'

{}

Confirm Payment

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderId*string

Length1 <= length

source*string

Value in"ADMIN" | "WEBHOOK"

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/orders/confirmPayment" \  -H "Content-Type: application/json" \  -d '{    "orderId": "string",    "source": "ADMIN"  }'

{}

Confirm Payment Many

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderIds*array<>

Items1 <= items

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/orders/confirmPaymentMany" \  -H "Content-Type: application/json" \  -d '{    "orderIds": [      "string"    ]  }'

{}

Create

Path Parameters

organizationSlug*string

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email?|

firstName*string

Length1 <= length <= 50

lastName*string

Length1 <= length <= 50

phoneNumber*string

Length1 <= length

city*string

Length1 <= length <= 50

country*string

Length1 <= length <= 50

line1*string

Length1 <= length

line2*|

postalCode*string

Match^\d{4,10}$

state*string

Length1 <= length <= 50

type*string

Value in"BILLING" | "SHIPPING"

addressId?string

couponCode?string

customerNotes?string

deliveryType?string

Value in"HOME" | "STOPDESK"

internalNotes?string

locale?string

Value in"en" | "ar" | "fr"

provider*string

Value in"CASH_ON_DELIVERY" | "STRIPE"

variants*array<>

Items1 <= items

wilayaCode?string

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/string/order" \  -H "Content-Type: application/json" \  -d '{    "firstName": "string",    "lastName": "string",    "phoneNumber": "string",    "city": "string",    "country": "string",    "line1": "string",    "line2": "string",    "postalCode": "string",    "state": "string",    "type": "BILLING",    "provider": "CASH_ON_DELIVERY",    "variants": [      {        "variantId": "string"      }    ]  }'

{}

Get By Customer

Path Parameters

organizationSlug*string

Length1 <= length

customerId*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://www.prolifto.store/api/string/orders/string"

{}

Get Many

Path Parameters

organizationSlug*string

Length1 <= length

Query Parameters

customerId?|

dateFrom?string

Match^\d{4}-\d{2}-\d{2}$

dateTo?string

Match^\d{4}-\d{2}-\d{2}$

deletedOnly?boolean

Defaultfalse

deliveryType?string

Value in"HOME" | "STOPDESK"

limit?number

Default10

Range1 <= value <= 100

orderBy?array<>

Default["created_desc"]

page?number

Default1

Range1 <= value

paymentStatus?string

Value in"PAID" | "UNPAID"

search?|

source?string

Value in"STOREFRONT" | "ADMIN" | "API"

status?string

Response Body

`application/json`

curl -X GET "https://www.prolifto.store/api/string/orders"

{}

Get Recent Summary

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

limit?integer

Default5

Range1 <= value <= 10

organizationSlug*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/orders/getRecentSummary" \  -H "Content-Type: application/json" \  -d '{    "organizationSlug": "string"  }'

{}

Get One

Path Parameters

organizationSlug*string

Length1 <= length

orderNumber*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://www.prolifto.store/api/string/orders/string"

{}

Log Contact Attempt

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderId*string

Length1 <= length

channel*string

Value in"PHONE" | "SMS" | "EMAIL"

notes?string

Lengthlength <= 2000

outcome*string

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/orders/logContactAttempt" \  -H "Content-Type: application/json" \  -d '{    "orderId": "string",    "channel": "PHONE",    "outcome": "NO_ANSWER"  }'

{}

Mark Return Refund Paid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/orders/markReturnRefundPaid" \  -H "Content-Type: application/json" \  -d '{    "orderId": "string"  }'

{}

Missing Stock Restorations

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/orders/missingStockRestorations"

{}

Resend Confirmation Email

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/orders/resendConfirmationEmail" \  -H "Content-Type: application/json" \  -d '{    "orderId": "string"  }'

{}

Resend Sms

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/orders/resendSms" \  -H "Content-Type: application/json" \  -d '{    "orderId": "string"  }'

{}

Restore

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/orders/restore" \  -H "Content-Type: application/json" \  -d '{    "orderId": "string"  }'

{}

Restore Many

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderIds*array<>

Items1 <= items

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/orders/restoreMany" \  -H "Content-Type: application/json" \  -d '{    "orderIds": [      "string"    ]  }'

{}

Restore Missing Stock

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/orders/restoreMissingStock" \  -H "Content-Type: application/json" \  -d '{    "orderId": "string"  }'

{}

Return Order

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderId*string

Length1 <= length

carrierFee?string

Match^\d+(\.\d{1,2})?$

notes?string

Lengthlength <= 2000

reason*string

refundAmount?string

Match^\d+(\.\d{1,2})?$

refundMethod?string

Value in"CASH" | "BANK_TRANSFER" | "STORE_CREDIT" | "GATEWAY" | "NONE"

refundPaid?boolean

restock?boolean

Defaulttrue

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/orders/returnOrder" \  -H "Content-Type: application/json" \  -d '{    "orderId": "string",    "reason": "REFUSED"  }'

{}

Update

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email?|

firstName*string

Length1 <= length <= 50

lastName*string

Length1 <= length <= 50

phoneNumber*string

Length1 <= length

city*string

Length1 <= length <= 50

country*string

Length1 <= length <= 50

line1*string

Length1 <= length

line2*|

postalCode*string

Match^\d{4,10}$

state*string

Length1 <= length <= 50

type*string

Value in"BILLING" | "SHIPPING"

addressId?string

couponCode?string

customerNotes?string

deliveryType?string

Value in"HOME" | "STOPDESK"

internalNotes?string

variants*array<>

Items1 <= items

wilayaCode?string

adjustmentAmount?string

Match^-?\d+(\.\d{1,2})?$

adjustmentReason?string

Lengthlength <= 500

orderId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/orders/update" \  -H "Content-Type: application/json" \  -d '{    "firstName": "string",    "lastName": "string",    "phoneNumber": "string",    "city": "string",    "country": "string",    "line1": "string",    "line2": "string",    "postalCode": "string",    "state": "string",    "type": "BILLING",    "variants": [      {        "variantId": "string"      }    ],    "orderId": "string"  }'

{}

Update Carrier Fee

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderId*string

Length1 <= length

carrierFee*string

Match^\d+(\.\d{1,2})?$

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/orders/updateCarrierFee" \  -H "Content-Type: application/json" \  -d '{    "orderId": "string",    "carrierFee": "string"  }'

{}

Update Shipping

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderId*string

Length1 <= length

shippingCarrier*string

Length1 <= length <= 100

trackingNumber*string

Length1 <= length <= 100

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/orders/updateShipping" \  -H "Content-Type: application/json" \  -d '{    "orderId": "string",    "shippingCarrier": "string",    "trackingNumber": "string"  }'

{}

Update Status

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderId*string

Length1 <= length

cancellationReason?string

notes?string

Lengthlength <= 2000

status?string

Default"PENDING"

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/orders/updateStatus" \  -H "Content-Type: application/json" \  -d '{    "orderId": "string"  }'

{}

Update Status Many

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderIds*array<>

Items1 <= items

status*string

Response Body

`application/json`

curl -X POST "https://www.prolifto.store/api/orders/updateStatusMany" \  -H "Content-Type: application/json" \  -d '{    "orderIds": [      "string"    ],    "status": "PENDING"  }'

{}

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`