Settlements

PreviousEarnings NextProfile

Last updated 3 months ago

Export vendor sales data

get

Exports the vendor sales data based on the provided vendor order ID.

Query parameters

vendorOrderIdintegerRequired

The ID of the vendor order for which the sales data is to be exported.

Header parameters

AuthorizationstringRequired

Bearer token for vendor authentication

Responses

200

Successfully exported vendor sales data.

400

Bad Request

404

Vendor order not found

500

Internal Server Error

get

GET /backend/api/vendor-sales/vendor-sales-export HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Vendor sales data exported successfully.</message>
	<data>data.csv</data>
</object>

Get the complete list of vendor sales payments

get

Retrieves the list of vendor sales payments with pagination support.

Query parameters

limitintegerOptional

The number of records per page.

Default: 10

offsetintegerOptional

The starting point from where to fetch the data.

Default: 0

currentPageintegerOptional

The current page number.

Default: 1

countintegerOptional

Flag to determine if the total count is needed.

Default: 0

Header parameters

AuthorizationstringRequired

Bearer token for vendor authentication

Responses

200

Successfully retrieved the complete payment list.

400

Bad Request

500

Internal Server Error

get

GET /backend/api/vendor-sales/payment HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully got the complete payment list</message>
	<data>
		<paymentId>1</paymentId>
		<vendorId>1</vendorId>
		<amount>1</amount>
		<paymentDate>2025-05-17</paymentDate>
		<status>1</status>
	</data>
</object>

Archive a vendor payment

post

Archives a specific vendor payment based on the provided payment ID.

Header parameters

AuthorizationstringRequired

Bearer token for vendor authentication

Body

vendorPaymentIdintegerOptionalExample: 197

Responses

200

Successfully archived the vendor payment.

400

Bad Request

404

Payment not found

500

Internal Server Error

post

POST /backend/api/vendor-sales/make-vendor-payment-archive HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 23

"vendorPaymentId=197"

<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully archived your payments</message>
</object>