ProductPackage

PreviousProductMedia NextProductProperties

Was this helpful?

Get product package slot

get

Get product package slot

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

productUidstringrequired

Reference to a Product.

Pattern: ^[A-Za-z0-9-_]+

productPackageSlotUidstringrequired

Reference to a product package slot

Responses

application/json

all ofoptional

get

GET /v2/tenants/{tenantUid}/products/{productUid}/packages/slots/{productPackageSlotUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "productPackageSlotUid": "text",
  "name": "text",
  "position": 1,
  "minComponentsAllowed": 1,
  "maxComponentsAllowed": 1,
  "normPrice": 1,
  "components": [
    {
      "productPackageComponentUid": "text",
      "product": {
        "productUid": "text",
        "name": "text",
        "sku": "text",
        "brand": "text",
        "description": "text"
      },
      "position": 1,
      "quantity": 1,
      "specialPrice": 1,
      "required": true,
      "createdBy": "text",
      "createdAt": "2025-04-18T01:52:06.392Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-04-18T01:52:06.392Z"
    }
  ],
  "createdBy": "text",
  "createdAt": "2025-04-18T01:52:06.392Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T01:52:06.392Z"
}

Delete product package slot

delete

Delet product package slot

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

productUidstringrequired

Reference to a Product.

Pattern: ^[A-Za-z0-9-_]+

productPackageSlotUidstringrequired

Reference to a product package slot

Responses

delete

DELETE /v2/tenants/{tenantUid}/products/{productUid}/packages/slots/{productPackageSlotUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

List product package components

get

List product package components

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

productUidstringrequired

Reference to a Product.

Pattern: ^[A-Za-z0-9-_]+

productPackageSlotUidstringrequired

Reference to a product package slot

Query parameters

pageNumberintegeroptional

Reference to a specific page in a result set.

pageSizeintegeroptional

The number of items per page in a result set.

sortBystringoptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumoptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Available options:

Responses

application/json

objectoptional

get

GET /v2/tenants/{tenantUid}/products/{productUid}/packages/slots/{productPackageSlotUid}/components HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "productPackageComponentUid": "text",
      "product": {
        "productUid": "text",
        "name": "text",
        "sku": "text",
        "brand": "text",
        "description": "text"
      },
      "position": 1,
      "quantity": 1,
      "specialPrice": 1,
      "required": true,
      "createdBy": "text",
      "createdAt": "2025-04-18T01:52:06.392Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-04-18T01:52:06.392Z"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Get product package component

get

Get product package component

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

productUidstringrequired

Reference to a Product.

Pattern: ^[A-Za-z0-9-_]+

productPackageSlotUidstringrequired

Reference to a product package slot

productPackageComponentUidstringrequired

Reference to a product package component

Responses

application/json

all ofoptional

get

GET /v2/tenants/{tenantUid}/products/{productUid}/packages/slots/{productPackageSlotUid}/components/{productPackageComponentUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "productPackageComponentUid": "text",
  "product": {
    "productUid": "text",
    "name": "text",
    "sku": "text",
    "brand": "text",
    "description": "text"
  },
  "position": 1,
  "quantity": 1,
  "specialPrice": 1,
  "required": true,
  "createdBy": "text",
  "createdAt": "2025-04-18T01:52:06.392Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T01:52:06.392Z"
}

Delete product package component

delete

Dele product package component

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

productUidstringrequired

Reference to a Product.

Pattern: ^[A-Za-z0-9-_]+

productPackageSlotUidstringrequired

Reference to a product package slot

productPackageComponentUidstringrequired

Reference to a product package component

Responses

delete

DELETE /v2/tenants/{tenantUid}/products/{productUid}/packages/slots/{productPackageSlotUid}/components/{productPackageComponentUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

List product package slots

get

List product package slots.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

productUidstringrequired

Reference to a Product.

Pattern: ^[A-Za-z0-9-_]+

Query parameters

pageNumberintegeroptional

Reference to a specific page in a result set.

pageSizeintegeroptional

The number of items per page in a result set.

sortBystringoptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumoptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Available options:

Responses

application/json

objectoptional

get

GET /v2/tenants/{tenantUid}/products/{productUid}/packages/slots HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "productPackageSlotUid": "text",
      "name": "text",
      "position": 1,
      "minComponentsAllowed": 1,
      "maxComponentsAllowed": 1,
      "normPrice": 1,
      "components": [
        {
          "productPackageComponentUid": "text",
          "product": {
            "productUid": "text",
            "name": "text",
            "sku": "text",
            "brand": "text",
            "description": "text"
          },
          "position": 1,
          "quantity": 1,
          "specialPrice": 1,
          "required": true,
          "createdBy": "text",
          "createdAt": "2025-04-18T01:52:06.392Z",
          "lastModifiedBy": "text",
          "lastModifiedAt": "2025-04-18T01:52:06.392Z"
        }
      ],
      "createdBy": "text",
      "createdAt": "2025-04-18T01:52:06.392Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-04-18T01:52:06.392Z"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create product package slot

post

Create new product package slot.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

productUidstringrequired

Reference to a Product.

Pattern: ^[A-Za-z0-9-_]+

Body

namestringoptional

positionintegeroptional

minComponentsAllowedintegeroptional

maxComponentsAllowedintegeroptional

productPackageSlotUidstringoptionalPattern: ^[A-Za-z0-9-_]*

Responses

application/json

all ofoptional

post

POST /v2/tenants/{tenantUid}/products/{productUid}/packages/slots HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "name": "text",
  "position": 1,
  "minComponentsAllowed": 1,
  "maxComponentsAllowed": 1,
  "productPackageSlotUid": "text"
}

201

Example response

{
  "productPackageSlotUid": "text",
  "name": "text",
  "position": 1,
  "minComponentsAllowed": 1,
  "maxComponentsAllowed": 1,
  "normPrice": 1,
  "components": [
    {
      "productPackageComponentUid": "text",
      "product": {
        "productUid": "text",
        "name": "text",
        "sku": "text",
        "brand": "text",
        "description": "text"
      },
      "position": 1,
      "quantity": 1,
      "specialPrice": 1,
      "required": true,
      "createdBy": "text",
      "createdAt": "2025-04-18T01:52:06.392Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-04-18T01:52:06.392Z"
    }
  ],
  "createdBy": "text",
  "createdAt": "2025-04-18T01:52:06.392Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T01:52:06.392Z"
}

Update product package slot

put

Update product package slot

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

productUidstringrequired

Reference to a Product.

Pattern: ^[A-Za-z0-9-_]+

productPackageSlotUidstringrequired

Reference to a product package slot

Body

namestringoptional

positionintegeroptional

minComponentsAllowedintegeroptional

maxComponentsAllowedintegeroptional

Responses

application/json

all ofoptional

put

PUT /v2/tenants/{tenantUid}/products/{productUid}/packages/slots/{productPackageSlotUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "name": "text",
  "position": 1,
  "minComponentsAllowed": 1,
  "maxComponentsAllowed": 1
}

200

Example response

{
  "productPackageSlotUid": "text",
  "name": "text",
  "position": 1,
  "minComponentsAllowed": 1,
  "maxComponentsAllowed": 1,
  "normPrice": 1,
  "components": [
    {
      "productPackageComponentUid": "text",
      "product": {
        "productUid": "text",
        "name": "text",
        "sku": "text",
        "brand": "text",
        "description": "text"
      },
      "position": 1,
      "quantity": 1,
      "specialPrice": 1,
      "required": true,
      "createdBy": "text",
      "createdAt": "2025-04-18T01:52:06.392Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-04-18T01:52:06.392Z"
    }
  ],
  "createdBy": "text",
  "createdAt": "2025-04-18T01:52:06.392Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T01:52:06.392Z"
}

Create product package component

post

Create product package component

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

productUidstringrequired

Reference to a Product.

Pattern: ^[A-Za-z0-9-_]+

productPackageSlotUidstringrequired

Reference to a product package slot

Body

productUidstringrequiredPattern: ^[A-Za-z0-9-_]+

quantityintegerrequired

positionintegeroptional

specialPriceintegeroptional

requiredbooleanoptionalDefault: false

productPackageComponentUidstringoptionalPattern: ^[A-Za-z0-9-_]*

Responses

application/json

all ofoptional

post

POST /v2/tenants/{tenantUid}/products/{productUid}/packages/slots/{productPackageSlotUid}/components HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "productUid": "text",
  "quantity": 1,
  "position": 1,
  "specialPrice": 1,
  "required": true,
  "productPackageComponentUid": "text"
}

201

Example response

{
  "productPackageComponentUid": "text",
  "product": {
    "productUid": "text",
    "name": "text",
    "sku": "text",
    "brand": "text",
    "description": "text"
  },
  "position": 1,
  "quantity": 1,
  "specialPrice": 1,
  "required": true,
  "createdBy": "text",
  "createdAt": "2025-04-18T01:52:06.392Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T01:52:06.392Z"
}

Update product package component

put

Update product package component

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

productUidstringrequired

Reference to a Product.

Pattern: ^[A-Za-z0-9-_]+

productPackageSlotUidstringrequired

Reference to a product package slot

productPackageComponentUidstringrequired

Reference to a product package component

Body

productUidstringoptionalPattern: ^[A-Za-z0-9-_]*

quantityintegeroptional

positionintegeroptional

specialPriceintegeroptional

requiredbooleanoptional

Responses

application/json

all ofoptional

put

PUT /v2/tenants/{tenantUid}/products/{productUid}/packages/slots/{productPackageSlotUid}/components/{productPackageComponentUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "productUid": "text",
  "quantity": 1,
  "position": 1,
  "specialPrice": 1,
  "required": true
}

200

Example response

{
  "productPackageComponentUid": "text",
  "product": {
    "productUid": "text",
    "name": "text",
    "sku": "text",
    "brand": "text",
    "description": "text"
  },
  "position": 1,
  "quantity": 1,
  "specialPrice": 1,
  "required": true,
  "createdBy": "text",
  "createdAt": "2025-04-18T01:52:06.392Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T01:52:06.392Z"
}