Product Lists

Endpoints for Product Lists addon

Product Lists addon

post

Add products to a product list

Authorizations

ApiKey

sw-context-tokenstringRequired

Path parameters

idstringRequired

ID of product list

Body

application/json

Responses

200

Returns a success response indicating a successful update

application/json

anyOptional

post

/product-lists/{id}/items

HTTPcURLJavaScriptPython

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

ApiKey

sw-context-tokenstringRequired

Path parameters

idstringRequired

ID of product list

Body

application/json

Responses

200

Returns a success response indicating a successful update

application/json

anyOptional

put

/product-lists/{id}/items

HTTPcURLJavaScriptPython

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

ApiKey

sw-context-tokenstringRequired

Path parameters

idstringRequired

ID of product list

Body

application/json

Responses

200

Returns a success response indicating a successful update

application/json

anyOptional

delete

/product-lists/{id}/items

HTTPcURLJavaScriptPython

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

ApiKey

sw-context-tokenstringRequired

Path parameters

idstringRequired

ID of product list

Body

application/json

Responses

200

Returns a success response indicating a successful update

application/json

anyOptional

patch

/product-lists/{id}/items

HTTPcURLJavaScriptPython

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

ApiKey

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}

HTTPcURLJavaScriptPython

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

ApiKey

sw-context-tokenstringRequired

Body

application/json

anyOptional

Responses

200

Returns a success response indicating a successful update

application/json

anyOptional

get

/product-lists/create

HTTPcURLJavaScriptPython

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

ApiKey

sw-context-tokenstringRequired

Body

application/json

anyOptional

Responses

200

Returns a success response indicating a successful update

application/json

anyOptional

post

/product-lists/create

HTTPcURLJavaScriptPython

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

ApiKey

sw-context-tokenstringRequired

Path parameters

idstringRequired

ID of product list

Responses

200Success

No content

get

/product-lists/{id}

HTTPcURLJavaScriptPython

GET /product-lists/{id} HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

200Success

No content

delete

Delete a product list

Authorizations

ApiKey

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}

HTTPcURLJavaScriptPython

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

ApiKey

sw-context-tokenstringRequired

Path parameters

idstringRequired

ID of product list

Body

application/json

anyOptional

Responses

200Success

No content

patch

/product-lists/{id}

HTTPcURLJavaScriptPython

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

ApiKey

sw-context-tokenstringRequired

Body

application/json

anyOptional

Responses

200Success

No content

post

/product-list/list

HTTPcURLJavaScriptPython

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

ApiKey

sw-context-tokenstringRequired

Body

application/json

anyOptional

Responses

200Success

No content

post

/product-lists

HTTPcURLJavaScriptPython

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

ApiKey

sw-context-tokenstringRequired

Body

application/json

anyOptional

Responses

200Success

No content

post

/product-list/{id}/items

HTTPcURLJavaScriptPython

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

ApiKey

sw-context-tokenstringRequired

Path parameters

idstringRequired

ID of product list item

Responses

200Success

No content

get

/product-list-item/{id}

HTTPcURLJavaScriptPython

GET /product-list-item/{id} HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

200Success

No content