Reporting | Home

Download a report file

get

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Successful response, returns the report file

Responsestring · binary

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

410

The requested resource is no longer available.

500

Server Error

get

GET /reporting/{id}/download/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

binary

Request a remote customer report

get

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

channelintegerOptional

ID of the channel the customer belongs to

Example: 5

start_datestring · date-timeOptional

Start date for the data range.

end_datestring · date-timeOptional

End date for the data range.

email_allowedbooleanOptional

Indicates if the customer allows receiving emails

Example: true

sms_allowedbooleanOptional

Indicates if the customer allows receiving SMS

Example: false

call_allowedbooleanOptional

Indicates if the customer allows receiving calls

Example: true

export_formatstring · enumOptional

Export format for the report

Default: csvPossible values:

Responses

200

Report request received

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

406

A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.

application/json

500

Server Error

get

GET /reporting/remote/{channel_id}/customer/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "Report request has been received."
}

Request a sales report

get

Authorizations

Query parameters

order__channelintegerOptional

start_datestring · date-timeRequired

Start date for the data range.

end_datestring · date-timeRequired

End date for the data range.

product__skustringOptional

Filter by SKU.

Example: SKU123

product__base_codestringOptional

Filter by base code.

Example: BASECODE123

export_formatstring · enumOptional

Export format for the report

Default: csvPossible values:

Responses

200

Report request received

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

406

A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.

application/json

500

Server Error

get

GET /reporting/sales/?start_date=2025-05-22T09%3A27%3A43.874Z&end_date=2025-05-22T09%3A27%3A43.874Z HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "Report request has been received."
}

Request an order report

get

Authorizations

Query parameters

channelintegerOptional

ID of the channel the customer belongs to

Example: 5

cancel_statusstring · enumOptional

Filter by cancel status

Possible values:

start_datestring · date-timeOptional

Start date for the data range.

end_datestring · date-timeOptional

End date for the data range.

export_formatstring · enumOptional

Export format for the report

Default: csvPossible values:

Responses

200

Report request received

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

406

A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.

application/json

500

Server Error

get

GET /reporting/order/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "Report request has been received."
}