Product Lists

List all Product Lists

get

Authorizations

api-key

api-keystringRequired

API Key

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

get

/v1/core/product-lists

HTTPcURLJavaScriptPython

GET /v1/core/product-lists HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "items": [
      {
        "type": "custom",
        "group": {},
        "locales": {
          "ar": {
            "name": "text",
            "description": "text"
          },
          "en": {
            "name": "text",
            "description": "text"
          }
        },
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "uid": "text",
        "entries": [
          {
            "sort": 1,
            "createdAt": "text",
            "createdVia": "text",
            "createdBy": "text",
            "updatedAt": "text",
            "updatedVia": "text",
            "updatedBy": "text",
            "uid": "text",
            "productUid": "text"
          }
        ]
      }
    ],
    "next": "text"
  }
}

Creates a new Product List

post

Authorizations

api-key

api-keystringRequired

API Key

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

post

/v1/core/product-lists

HTTPcURLJavaScriptPython

POST /v1/core/product-lists HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 177

{
  "params": {
    "type": "custom",
    "group": {},
    "locales": {
      "ar": {
        "name": "text",
        "description": "text"
      },
      "en": {
        "name": "text",
        "description": "text"
      }
    },
    "entries": [
      {
        "productId": "text",
        "sort": 1
      }
    ]
  }
}

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "type": "custom",
      "group": {},
      "locales": {
        "ar": {
          "name": "text",
          "description": "text"
        },
        "en": {
          "name": "text",
          "description": "text"
        }
      },
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "uid": "text",
      "entries": [
        {
          "sort": 1,
          "createdAt": "text",
          "createdVia": "text",
          "createdBy": "text",
          "updatedAt": "text",
          "updatedVia": "text",
          "updatedBy": "text",
          "uid": "text",
          "productUid": "text"
        }
      ]
    }
  }
}

Returns a Product List

get

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

400

Functional Error

application/json

get

/v1/core/product-lists/{uid}

HTTPcURLJavaScriptPython

GET /v1/core/product-lists/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "type": "custom",
      "group": {},
      "locales": {
        "ar": {
          "name": "text",
          "description": "text"
        },
        "en": {
          "name": "text",
          "description": "text"
        }
      },
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "uid": "text",
      "entries": [
        {
          "sort": 1,
          "createdAt": "text",
          "createdVia": "text",
          "createdBy": "text",
          "updatedAt": "text",
          "updatedVia": "text",
          "updatedBy": "text",
          "uid": "text",
          "productUid": "text"
        }
      ]
    }
  }
}

Deletes a Product List

delete

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

delete

/v1/core/product-lists/{uid}

HTTPcURLJavaScriptPython

DELETE /v1/core/product-lists/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Updates a Product List

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

400

Functional Error

application/json

patch

/v1/core/product-lists/{uid}

HTTPcURLJavaScriptPython

PATCH /v1/core/product-lists/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "params": {
    "group": {},
    "locales": {
      "ar": {
        "name": "text",
        "description": "text"
      },
      "en": {
        "name": "text",
        "description": "text"
      }
    }
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "type": "custom",
      "group": {},
      "locales": {
        "ar": {
          "name": "text",
          "description": "text"
        },
        "en": {
          "name": "text",
          "description": "text"
        }
      },
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "uid": "text",
      "entries": [
        {
          "sort": 1,
          "createdAt": "text",
          "createdVia": "text",
          "createdBy": "text",
          "updatedAt": "text",
          "updatedVia": "text",
          "updatedBy": "text",
          "uid": "text",
          "productUid": "text"
        }
      ]
    }
  }
}

Exports all products with support for incremental fetching.

get

Authorizations

api-key

api-keystringRequired

API Key

Query parameters

updatedSincestringOptional

offsetstringOptional

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

get

/v1/core/product-lists/export

HTTPcURLJavaScriptPython

GET /v1/core/product-lists/export HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "items": [
      {
        "type": "custom",
        "group": {},
        "locales": {
          "ar": {
            "name": "text",
            "description": "text"
          },
          "en": {
            "name": "text",
            "description": "text"
          }
        },
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "uid": "text",
        "entries": [
          {
            "sort": 1,
            "createdAt": "text",
            "createdVia": "text",
            "createdBy": "text",
            "updatedAt": "text",
            "updatedVia": "text",
            "updatedBy": "text",
            "uid": "text",
            "productUid": "text"
          }
        ]
      }
    ],
    "next": "text"
  }
}

Creates an entry within a product list

post

Authorizations

api-key

api-keystringRequired

API Key

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

post

/v1/core/product-list-entries

HTTPcURLJavaScriptPython

POST /v1/core/product-list-entries HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "params": {
    "listUid": "text",
    "productUid": "text",
    "sort": 1
  }
}

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "sort": 1,
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "uid": "text",
      "productUid": "text"
    },
    "product": {},
    "category": {}
  }
}

Deletes a Product List Entry

delete

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

delete

/v1/core/product-list-entries/{uid}

HTTPcURLJavaScriptPython

DELETE /v1/core/product-list-entries/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Updates an entry within a product list

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

400

Functional Error

application/json

patch

/v1/core/product-list-entries/{uid}

HTTPcURLJavaScriptPython

PATCH /v1/core/product-list-entries/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "params": {
    "uid": "text",
    "sort": 1
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "sort": 1,
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "uid": "text",
      "productUid": "text"
    }
  }
}