Skip to content

Fulfilment API (1.0.0)

This is the API documentation for the Fulfilment API.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://developer-docs.quiqup.com/_mock/openapi/
Production
https://platform-api.quiqup.com/
Staging
https://platform-api.staging.quiqup.com/

Fulfilment Inbound

Operations

Fulfilment Inventory

Operations

Fulfilment Orders

Operations

Fulfilment Products

Operations

Create Product

Request

Create a Product

📌 Description

This endpoint allows you to create a new product in the fulfilment system. Each product must have a unique SKU, and essential details such as pricing, inventory tracking settings, and dimensions must be provided.

🔹 Use Cases

  • Adding a new product to the fulfilment system.
  • Defining product pricing and inventory tracking settings.
  • Configuring product dimensions for warehouse storage and shipping calculations.
Security
OAuth2
Bodyapplication/json
availability_statusinteger(int64)(Current availability status of the product (1: available, 0: unavailable) )required
barcodestring(Product barcode (EAN, UPC, ISBN, etc.) )
cost_pricenumber(Cost of acquiring/manufacturing the product )
country_code_of_originstring(ISO2 Country code where product was manufactured )
currencystring(types.Currency)required
Enum"AED""SAR"
descriptionstring(Detailed description of the product )
dimensionsobject(types.RequestDimensions)
harmonized_system_codestring(Harmonized System Code for customs )
imagestring(URL of the product image )
inventory_trackedboolean(Whether inventory levels are tracked )
namestring(Name of the product )
partner_product_idstring(Partner's unique identifier for the product )
platform_pricenumber(Platform price for international orders (overrides sales channel price when enabled) )
requires_shippingboolean(Indicates whether the product requires shipping services )
retail_pricenumber(Recommended retail price )
selling_pricenumber(Price at which the product is sold to customers )required
skustring(Unique Stock Keeping Unit identifier )required
statusstring(Product API types )
Enum"active""archived""draft"
total_salesnumber(Total lifetime sales quantity of this product )
track_expiryboolean(Whether to track expiry dates for this product )
typestring(Type of product (e.g. physical, digital) )
vendorstring(Name of the product vendor/manufacturer )
weightnumber(Weight of a single unit of the product )
weight_unitstring(Unit of weight measurement (kg or g) )
curl -i -X POST \
  https://developer-docs.quiqup.com/_mock/openapi/api/fulfilment/products \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "availability_status": 0,
    "barcode": "string",
    "cost_price": 0,
    "country_code_of_origin": "string",
    "currency": "AED",
    "description": "string",
    "dimensions": {
      "height": 0,
      "length": 0,
      "unit": "string",
      "width": 0
    },
    "harmonized_system_code": "string",
    "image": "string",
    "inventory_tracked": true,
    "name": "string",
    "partner_product_id": "string",
    "platform_price": 0,
    "requires_shipping": true,
    "retail_price": 0,
    "selling_price": 0,
    "sku": "string",
    "status": "active",
    "total_sales": 0,
    "track_expiry": true,
    "type": "string",
    "vendor": "string",
    "weight": 0,
    "weight_unit": "string"
  }'

Responses

Success response

Bodyapplication/json
availability_statusinteger(int64)(Current total available quantity of the product )
barcodestring(Product barcode (EAN, UPC, ISBN, etc.) )
cost_pricenumber(Cost price of the product )
country_code_of_originstring(ISO2 Country code of origin (required). )
created_atstring(date-time)(Creation timestamp )
currencystring(types.Currency)
Enum"AED""SAR"
descriptionstring(Description of the product )
dimensionsobject(JSONType give a generic data type for json encoded data. )
harmonized_system_codestring(Harmonized System Code (HS Code) )
idstring(Unique identifier for the product )
imagestring(Images of the product )
inventory_trackedboolean(If false means inventory can not be tracked/updated )
namestring(Name of the product )
partner_product_idstring(Partner's unique identifier for the product )
platform_pricenumber(Platform price for international orders (overrides sales channel price when enabled) )
requires_shippingboolean(Indicates whether the product requires shipping services (virtual products do not require shipping) )
retail_pricenumber(Retail price of the product )
selling_pricenumber(Selling price of the product )
skustring(Stock Keeping Unit )
statusstring(Product API types )
Enum"active""archived""draft"
total_salesnumber(Total lifetime sales quantity of this product )
track_expiryboolean(Track expiry of the product, default to false )
typestring(Category of the product )
updated_atstring(date-time)(Last update timestamp )
vendorstring(Vendor or brand name )
weightnumber(Weight of a single unit of the product )
weight_unitstring(Unit of weight measurement (kg or g) )
Response
application/json
{
  "availability_status": 0,
  "barcode": "string",
  "cost_price": 0,
  "country_code_of_origin": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "currency": "AED",
  "description": "string",
  "dimensions": {},
  "harmonized_system_code": "string",
  "id": "string",
  "image": "string",
  "inventory_tracked": true,
  "name": "string",
  "partner_product_id": "string",
  "platform_price": 0,
  "requires_shipping": true,
  "retail_price": 0,
  "selling_price": 0,
  "sku": "string",
  "status": "active",
  "total_sales": 0,
  "track_expiry": true,
  "type": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "vendor": "string",
  "weight": 0,
  "weight_unit": "string"
}

Get Product

Request

Get a Product by SKU

📌 Description

This endpoint retrieves detailed information about a specific product using its unique sku. The response includes product metadata, pricing, inventory tracking status, and fulfilment-related details.

🔹 Use Cases

  • Fetching product details to confirm SKU, pricing, and inventory settings.
  • Displaying product information in an eCommerce system or inventory dashboard.
  • Ensuring a product is active and available before placing a fulfilment order.

🔹 Parameters

  • id: The unique id or sku of the product.
Security
OAuth2
Path
skustringrequired
curl -i -X GET \
  'https://developer-docs.quiqup.com/_mock/openapi/api/fulfilment/products/{sku}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success response

Bodyapplication/json
availability_statusinteger(int64)(Current total available quantity of the product )
barcodestring(Product barcode (EAN, UPC, ISBN, etc.) )
cost_pricenumber(Cost price of the product )
country_code_of_originstring(ISO2 Country code of origin (required). )
created_atstring(date-time)(Creation timestamp )
currencystring(types.Currency)
Enum"AED""SAR"
descriptionstring(Description of the product )
dimensionsobject(JSONType give a generic data type for json encoded data. )
harmonized_system_codestring(Harmonized System Code (HS Code) )
idstring(Unique identifier for the product )
imagestring(Images of the product )
inventory_trackedboolean(If false means inventory can not be tracked/updated )
namestring(Name of the product )
partner_product_idstring(Partner's unique identifier for the product )
platform_pricenumber(Platform price for international orders (overrides sales channel price when enabled) )
requires_shippingboolean(Indicates whether the product requires shipping services (virtual products do not require shipping) )
retail_pricenumber(Retail price of the product )
selling_pricenumber(Selling price of the product )
skustring(Stock Keeping Unit )
statusstring(Product API types )
Enum"active""archived""draft"
total_salesnumber(Total lifetime sales quantity of this product )
track_expiryboolean(Track expiry of the product, default to false )
typestring(Category of the product )
updated_atstring(date-time)(Last update timestamp )
vendorstring(Vendor or brand name )
weightnumber(Weight of a single unit of the product )
weight_unitstring(Unit of weight measurement (kg or g) )
Response
application/json
{
  "availability_status": 0,
  "barcode": "string",
  "cost_price": 0,
  "country_code_of_origin": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "currency": "AED",
  "description": "string",
  "dimensions": {},
  "harmonized_system_code": "string",
  "id": "string",
  "image": "string",
  "inventory_tracked": true,
  "name": "string",
  "partner_product_id": "string",
  "platform_price": 0,
  "requires_shipping": true,
  "retail_price": 0,
  "selling_price": 0,
  "sku": "string",
  "status": "active",
  "total_sales": 0,
  "track_expiry": true,
  "type": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "vendor": "string",
  "weight": 0,
  "weight_unit": "string"
}

Update Product

Request

Update a Product

📌 Description

This endpoint allows you to partially update an existing product. Unlike POST, which is used to create new products, PATCH only modifies specified fields of an existing product.

🔹 Use Cases

  • Updating product pricing without affecting other attributes.
  • Changing product status (e.g., from active to archived).
  • Modifying SKU or barcode while keeping other details intact.
Security
OAuth2
Path
skustringrequired
Bodyapplication/json
availability_statusinteger(int64)(Current availability status of the product (1: available, 0: unavailable) )required
barcodestring(Product barcode (EAN, UPC, ISBN, etc.) )
cost_pricenumber(Cost of acquiring/manufacturing the product )
country_code_of_originstring(ISO2 Country code where product was manufactured )
currencystring(types.Currency)required
Enum"AED""SAR"
descriptionstring(Detailed description of the product )
dimensionsobject(types.RequestDimensions)
harmonized_system_codestring(Harmonized System Code for customs )
imagestring(URL of the product image )
inventory_trackedboolean(Whether inventory levels are tracked )
namestring(Name of the product )
partner_product_idstring(Partner's unique identifier for the product )
platform_pricenumber(Platform price for international orders (overrides sales channel price when enabled) )
requires_shippingboolean(Indicates whether the product requires shipping services )
retail_pricenumber(Recommended retail price )
selling_pricenumber(Price at which the product is sold to customers )required
skustring(Unique Stock Keeping Unit identifier )required
statusstring(Product API types )
Enum"active""archived""draft"
total_salesnumber(Total lifetime sales quantity of this product )
track_expiryboolean(Whether to track expiry dates for this product )
typestring(Type of product (e.g. physical, digital) )
vendorstring(Name of the product vendor/manufacturer )
weightnumber(Weight of a single unit of the product )
weight_unitstring(Unit of weight measurement (kg or g) )
curl -i -X PATCH \
  'https://developer-docs.quiqup.com/_mock/openapi/api/fulfilment/products/{sku}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "availability_status": 0,
    "barcode": "string",
    "cost_price": 0,
    "country_code_of_origin": "string",
    "currency": "AED",
    "description": "string",
    "dimensions": {
      "height": 0,
      "length": 0,
      "unit": "string",
      "width": 0
    },
    "harmonized_system_code": "string",
    "image": "string",
    "inventory_tracked": true,
    "name": "string",
    "partner_product_id": "string",
    "platform_price": 0,
    "requires_shipping": true,
    "retail_price": 0,
    "selling_price": 0,
    "sku": "string",
    "status": "active",
    "total_sales": 0,
    "track_expiry": true,
    "type": "string",
    "vendor": "string",
    "weight": 0,
    "weight_unit": "string"
  }'

Responses

Success response

Bodyapplication/json
availability_statusinteger(int64)(Current total available quantity of the product )
barcodestring(Product barcode (EAN, UPC, ISBN, etc.) )
cost_pricenumber(Cost price of the product )
country_code_of_originstring(ISO2 Country code of origin (required). )
created_atstring(date-time)(Creation timestamp )
currencystring(types.Currency)
Enum"AED""SAR"
descriptionstring(Description of the product )
dimensionsobject(JSONType give a generic data type for json encoded data. )
harmonized_system_codestring(Harmonized System Code (HS Code) )
idstring(Unique identifier for the product )
imagestring(Images of the product )
inventory_trackedboolean(If false means inventory can not be tracked/updated )
namestring(Name of the product )
partner_product_idstring(Partner's unique identifier for the product )
platform_pricenumber(Platform price for international orders (overrides sales channel price when enabled) )
requires_shippingboolean(Indicates whether the product requires shipping services (virtual products do not require shipping) )
retail_pricenumber(Retail price of the product )
selling_pricenumber(Selling price of the product )
skustring(Stock Keeping Unit )
statusstring(Product API types )
Enum"active""archived""draft"
total_salesnumber(Total lifetime sales quantity of this product )
track_expiryboolean(Track expiry of the product, default to false )
typestring(Category of the product )
updated_atstring(date-time)(Last update timestamp )
vendorstring(Vendor or brand name )
weightnumber(Weight of a single unit of the product )
weight_unitstring(Unit of weight measurement (kg or g) )
Response
application/json
{
  "availability_status": 0,
  "barcode": "string",
  "cost_price": 0,
  "country_code_of_origin": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "currency": "AED",
  "description": "string",
  "dimensions": {},
  "harmonized_system_code": "string",
  "id": "string",
  "image": "string",
  "inventory_tracked": true,
  "name": "string",
  "partner_product_id": "string",
  "platform_price": 0,
  "requires_shipping": true,
  "retail_price": 0,
  "selling_price": 0,
  "sku": "string",
  "status": "active",
  "total_sales": 0,
  "track_expiry": true,
  "type": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "vendor": "string",
  "weight": 0,
  "weight_unit": "string"
}