Ctrlk
API Referenceswww.b2b-sellers.comPublic demoshopRoadmap
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Product Lists

Endpoints for Product Lists addon

Product Lists addon

post

Add products to a product list

Authorizations
sw-context-tokenstringRequired
Path parameters
idstringRequired

ID of product list

Body
Responses
200

Returns a success response indicating a successful update

application/json
anyOptional
post/product-lists/{id}/items
POST /product-lists/{id}/items HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "items": [
    {
      "id": "text",
      "articleNumber": "text",
      "productId": "text",
      "comment": "text",
      "position": 1,
      "quantity": 1,
      "customFields": {}
    }
  ]
}
200

Returns a success response indicating a successful update

No content
put

Update products in a product list

Authorizations
sw-context-tokenstringRequired
Path parameters
idstringRequired

ID of product list

Body
Responses
200

Returns a success response indicating a successful update

application/json
anyOptional
put/product-lists/{id}/items
PUT /product-lists/{id}/items HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "items": [
    {
      "id": "text",
      "articleNumber": "text",
      "productId": "text",
      "comment": "text",
      "position": 1,
      "quantity": 1,
      "customFields": {}
    }
  ]
}
200

Returns a success response indicating a successful update

No content
delete

Delete some products from a product list

Authorizations
sw-context-tokenstringRequired
Path parameters
idstringRequired

ID of product list

Body
Responses
200

Returns a success response indicating a successful update

application/json
anyOptional
delete/product-lists/{id}/items
DELETE /product-lists/{id}/items HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "items": [
    {
      "id": "text"
    }
  ]
}
200

Returns a success response indicating a successful update

No content
patch

Update products in a product list

Authorizations
sw-context-tokenstringRequired
Path parameters
idstringRequired

ID of product list

Body
Responses
200

Returns a success response indicating a successful update

application/json
anyOptional
patch/product-lists/{id}/items
PATCH /product-lists/{id}/items HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "items": [
    {
      "id": "text",
      "articleNumber": "text",
      "productId": "text",
      "comment": "text",
      "position": 1,
      "quantity": 1,
      "customFields": {}
    }
  ]
}
200

Returns a success response indicating a successful update

No content
delete

Delete a product from a product list

Authorizations
sw-context-tokenstringRequired
Path parameters
idstringRequired

ID of product list

productIdstringRequired

ID of product in list

Responses
200

Returns a success response indicating a successful update

application/json
anyOptional
delete/product-lists/{id}/product/{productId}
DELETE /product-lists/{id}/product/{productId} HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*
200

Returns a success response indicating a successful update

No content
get

create new product list

Authorizations
sw-context-tokenstringRequired
Body
anyOptional
Responses
200

Returns a success response indicating a successful update

application/json
anyOptional
get/product-lists/create
GET /product-lists/create HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
200

Returns a success response indicating a successful update

No content
post

create new product list

Authorizations
sw-context-tokenstringRequired
Body
anyOptional
Responses
200

Returns a success response indicating a successful update

application/json
anyOptional
post/product-lists/create
POST /product-lists/create HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
200

Returns a success response indicating a successful update

No content
get

Get a product list

Authorizations
sw-context-tokenstringRequired
Path parameters
idstringRequired

ID of product list

Responses
200Success
No content
get/product-lists/{id}
GET /product-lists/{id} HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*
200Success
No content
delete

Delete a product list

Authorizations
sw-context-tokenstringRequired
Path parameters
idstringRequired

ID of product list

Responses
200

Returns a success response indicating a successful update

application/json
anyOptional
delete/product-lists/{id}
DELETE /product-lists/{id} HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*
200

Returns a success response indicating a successful update

No content
patch

Update a product list

Authorizations
sw-context-tokenstringRequired
Path parameters
idstringRequired

ID of product list

Body
anyOptional
Responses
200Success
No content
patch/product-lists/{id}
PATCH /product-lists/{id} HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
200Success
{
  "$ref": "#/components/responses/ProductListResponse"
}

List product lists

post
Authorizations
sw-context-tokenstringRequired
Body
anyOptional
Responses
200Success
No content
post/product-list/list
POST /product-list/list HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200Success
No content

List product lists

post
Authorizations
sw-context-tokenstringRequired
Body
anyOptional
Responses
200Success
No content
post/product-lists
POST /product-lists HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200Success
No content

List items of a product list

post
Authorizations
sw-context-tokenstringRequired
Body
anyOptional
Responses
200Success
No content
post/product-list/{id}/items
POST /product-list/{id}/items HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200Success
No content
get

Get a product list item

Authorizations
sw-context-tokenstringRequired
Path parameters
idstringRequired

ID of product list item

Responses
200Success
No content
get/product-list-item/{id}
GET /product-list-item/{id} HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*
200Success
No content

Last updated

Was this helpful?