Order Fulfilment Status

PreviousLocalization NextPersonalise

Last updated 3 months ago

Delete the order status

delete

This endpoint deletes the order status for a given order status ID.

Path parameters

orderStatusIdintegerRequired

ID of the order status to be deleted

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully deleted the order status

404

Order status not found

delete

DELETE /backend/api/order-status/{orderStatusId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully deleted the order status</message>
</object>

Get complete order fulfillment status list

get

This endpoint retrieves a complete list of order fulfillment statuses.

Query parameters

limitintegerOptional

Limit the number of results

offsetintegerOptional

Offset for pagination

isFullfillmentintegerOptional

Filter by fulfillment status

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the order fulfillment status list

get

GET /backend/api/order-status/fullfillment HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

200

Successfully retrieved the order fulfillment status list

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the complete Order full-fillment status list</message>
</object>

Delete order fulfillment status

delete

This endpoint deletes an existing order fulfillment status.

Path parameters

idintegerRequired

The ID of the order fulfillment status to be deleted.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully deleted the order fulfillment status

delete

DELETE /backend/api/order-status/fullfillment/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

200

Successfully deleted the order fulfillment status

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully deleted the order status</message>
</object>

Get order fulfillment status list

get

This endpoint retrieves the complete list of order fulfillment statuses.

Query parameters

limitintegerOptional

Number of records to return in a single response

offsetintegerOptional

Offset from which to start the records (for pagination)

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the order fulfillment status list

400

Invalid query parameter

get

GET /backend/api/order-status/order-fullfillment-status-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the complete Order full-fillment status list</message>
</object>

Create a new order status

post

This endpoint creates a new order status with the given details.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

isFullfillmentintegerOptional

Indicates if the order status is related to fulfillment

namestringOptional

Name of the order status

colorCodestringOptional

Hexadecimal color code for the order status

prioritystringOptional

Priority level of the order status

statusintegerOptional

Status of the order (1 for active, 0 for inactive)

isAdminintegerOptional

Indicates if the order status is for admin

isVendorintegerOptional

Indicates if the order status is for vendor

isBuyerintegerOptional

Indicates if the order status is for buyer

isApiintegerOptional

Indicates if the order status is related to API

Responses

200

Successfully created a new order status

400

Invalid input data

post

POST /backend/api/order-status/create-order-status HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 129

"isFullfillment=1&name='test'&colorCode='#2e1515'&priority='4'&status=1&isAdmin=1&isVendor=0&isBuyer=0&isApi=0"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully created a new order status</message>
</object>

Update an existing order status

put

This endpoint updates an existing order status with the provided details.

Path parameters

orderStatusIdintegerRequired

ID of the order status to be updated

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

isFullfillmentintegerOptional

Indicates if the order status is related to fulfillment

namestringOptional

Name of the order status

colorCodestringOptional

Hexadecimal color code for the order status

priorityintegerOptional

Priority level of the order status

statusintegerOptional

Status of the order (1 for active, 0 for inactive)

parentIdintegerOptional

ID of the parent order status

isAdminintegerOptional

Indicates if the order status is for admin

isVendorintegerOptional

Indicates if the order status is for vendor

isBuyerintegerOptional

Indicates if the order status is for buyer

isApiintegerOptional

Indicates if the order status is related to API

orderStatusIdintegerOptional

ID of the order status

Responses

200

Successfully updated the order status

400

Invalid input data

put

PUT /backend/api/order-status/update-order-status/{orderStatusId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 159

"isFullfillment=1&name='test'&colorCode='#2e1515'&priority=4&status=1&parentId=0&isAdmin=1&isVendor=0&isBuyer=0&isApi=0&orderStatusId=54"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully updated the order status</message>
</object>

Update the order fulfillment status

put

This endpoint updates the order fulfillment status for a specific order status ID.

Path parameters

orderStatusIdintegerRequired

ID of the order status whose fulfillment status is to be updated

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

statusintegerOptional

The order fulfillment status (1 for active, 0 for inactive)

Responses

200

Successfully updated the order fulfillment status

400

Invalid input data

put

PUT /backend/api/order-status/update-order-fullfillment-status/{orderStatusId} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 12

"status=0"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully updated order fulfillment status</message>
</object>

Assign order statuses to fulfillment statuses

put

This endpoint assigns multiple order statuses to fulfillment statuses.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

orderStatusIdintegerRequired

fullfillmentStatusIdsinteger[]Required

Responses

200

Successfully updated order statuses with fulfillment status assignments

put

PUT /backend/api/order-status/fullfillment HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 49

"[{'orderStatusId':1,'fullfillmentStatusIds':[1]}]"

200

Successfully updated order statuses with fulfillment status assignments

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully updated order status</message>
</object>

Create new order fulfillment status

post

This endpoint creates a new order fulfillment status.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

isFullfillmentintegerRequiredExample: 1

namestringRequiredExample: test

colorCodestringRequiredExample: #9c2a2a

priorityintegerRequiredExample: 5

statusintegerRequiredExample: 1

Responses

200

Successfully created order fulfillment status

post

POST /backend/api/order-status/fullfillment HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 80

"isFullfillment=1&name='test'&colorCode='#9c2a2a'&priority=5&status=1"

200

Successfully created order fulfillment status

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully created full-fillment status</message>
</object>

Update order fulfillment status

put

This endpoint updates the status of an existing order fulfillment.

Path parameters

idintegerRequired

The ID of the order fulfillment status to be updated.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

idintegerRequired

statusintegerRequired

Responses

200

Successfully updated the order fulfillment status

put

PUT /backend/api/order-status/fullfillment/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 20

"id=23&status=0"

200

Successfully updated the order fulfillment status

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully updated the order status</message>
</object>