[lightMode]

Create Export Template

POST/exports/templates

[updatedIn] 23 days ago

This endpoint allows you o create a custom export template for either "Orders" or "Products"

`exports.read_write`- Exports Read & Write

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

to [header]，whose value is to concatenate the Token after the Bearer.

[api.label.example]

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

name

string

required

Template Name.

entity

enum<string>

required

Entity value, either orders or products.

Allowed values:

ordersproducts

columns

array[string]

required

{
  "name": "first product template",
  "entity": "products",
  "columns": [
    "product_name",
    "product_images",
    "product_type"
  ]
}

Request samples

[api.label.responses]

Progress In-Action(200)

Error Validation(422)

Progress In-Action

HTTP Code: 200

Content Type : JSONapplication/json

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

object

optional

message

string

optional

A text or data communication generated by a system or application in response to a request.

{
  "status": 200,
  "success": true,
  "data": {
    "message": "تم حفظ القالب بنجاح"
  }
}

[updatedIn] 23 days ago