List Export Columns

This endpoint allows you to retrieve the available fields that you need to add into an export template.

Scopes

exports.read- Exports Read Only

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Query Params

entity

enum<string>

required

The entity to be exported, either products or orders

Allowed values:

productsorders

Example:

products

Responses

🟢200Success

application/json

Body

status

integer

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

array [object {3}]

optional

title

string

optional

Column Title

name

string

optional

Column Name

section

string

optional

Column Section

Example

{
  "status": 200,
  "success": true,
  "data": [
    {
      "title": "اسم المنتج",
      "name": "product_name",
      "section": "product_info"
    },
    {
      "title": "تصنيف المنتج",
      "name": "product_categories",
      "section": "product_info"
    },
    {
      "title": "صورة المنتج",
      "name": "product_images",
      "section": "product_info"
    },
    {
      "title": "نوع المنتج",
      "name": "product_type",
      "section": "product_info"
    },
    {
      "title": "الوصف",
      "name": "product_desc",
      "section": "product_info"
    },
    {
      "title": "هل يتطلب شحن؟",
      "name": "required_shipping",
      "section": "product_info"
    },
    {
      "title": "تاريخ نهاية التخفيض",
      "name": "sale_end_date",
      "section": "product_info"
    },
    {
      "title": "اقصي كمية لكل عميل",
      "name": "customer_maximum_quantity",
      "section": "product_info"
    },
    {
      "title": "إخفاء خيار تحديد الكمية",
      "name": "hide_quantity",
      "section": "product_info"
    },
    {
      "title": "اضافة صورة عند الطلب",
      "name": "enable_upload_image",
      "section": "product_info"
    },
    {
      "title": "الوزن",
      "name": "product_weight",
      "section": "product_info"
    },
    {
      "title": "وحدة الوزن",
      "name": "product_weight_unit",
      "section": "product_info"
    },
    {
      "title": "حالة المنتج",
      "name": "product_status",
      "section": "product_info"
    },
    {
      "title": "الماركة",
      "name": "product_brand",
      "section": "product_info"
    },
    {
      "title": "العنوان الترويجي",
      "name": "promotional_title",
      "section": "product_info"
    },
    {
      "title": "تثبيت المنتج",
      "name": "product_pinned",
      "section": "product_info"
    },
    {
      "title": "السعرات الحرارية",
      "name": "product_calories",
      "section": "product_info"
    },
    {
      "title": "خاضع للضريبة؟",
      "name": "with_tax",
      "section": "product_info"
    },
    {
      "title": "غير محدود الكمية",
      "name": "unlimited_quantity",
      "section": "product_info"
    },
    {
      "title": "خيارات المنتج",
      "table": "product_options",
      "section": "product_options"
    },
    {
      "title": "السعر",
      "name": "product_or_option_price",
      "section": "match_columns"
    },
    {
      "title": "الكمية",
      "name": "product_or_option_quantity",
      "section": "match_columns"
    },
    {
      "title": "رمز المنتج sku",
      "name": "product_or_option_sku",
      "section": "match_columns"
    },
    {
      "title": "سعر التكلفة",
      "name": "product_or_option_cost_price",
      "section": "match_columns"
    },
    {
      "title": "سعر التخفيض",
      "name": "product_or_option_sale_price",
      "section": "match_columns"
    },
    {
      "title": "الباركود",
      "name": "product_or_option_barcode",
      "section": "match_columns"
    },
    {
      "title": "MPN",
      "name": "product_or_option_mpn",
      "section": "match_columns"
    },
    {
      "title": "GTIN",
      "name": "product_or_option_gtin",
      "section": "match_columns"
    },
    {
      "title": "عنوان صفحة المنتج (SEO Page Title)",
      "name": "meta__title",
      "section": "seo_improvements"
    },
    {
      "title": "رابط مخصص للمنتج (SEO Page URL)",
      "name": "product_page_url",
      "section": "seo_improvements"
    },
    {
      "title": "وصف صفحة المنتج (SEO Page Description)",
      "name": "meta_description",
      "section": "seo_improvements"
    }
  ]
}

🟠422Error Validation

🟠401Unauthorized

Request

Request samples

Responses