Links

catalog Product Link Management V1Get Linked Items By Type Get

Provide the list of links for a specific product

get

/V1/products/{sku}/links/{type}

Path parameters

skustringrequired

(Required)

Example: <string>

typestringrequired

(Required)

Example: <string>

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://{{baseurl}}/V1/products/{sku}/links/{type}'

200

400

401

500

200

[
  {
    "sku": "<string>",
    "link_type": "<string>",
    "linked_product_sku": "<string>",
    "linked_product_type": "<string>",
    "position": "<integer>",
    "extension_attributes": {
      "qty": "<number>"
    }
  },
  {
    "sku": "<string>",
    "link_type": "<string>",
    "linked_product_sku": "<string>",
    "linked_product_type": "<string>",
    "position": "<integer>",
    "extension_attributes": {
      "qty": "<number>"
    }
  }
]

OK

catalog Product Link Repository V1Delete By Id Delete

delete

/V1/products/{sku}/links/{type}//{linkedProductSku}

Path parameters

skustringrequired

(Required)

Example: <string>

typestringrequired

(Required)

Example: <string>

linkedProductSkustringrequired

(Required)

Example: <string>

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'http://{{baseurl}}/V1/products/{sku}/links/{type}/{linkedProductSku}'

200

400

401

500

200

true

OK

catalog Product Link Management V1Set Product Links Post

Assign a product link to another product

post

/V1/products/{sku}/links

Path parameters

skustringrequired

(Required)

Example: <string>

Header parameters

Content-Typestring

Example: application/json

Body

object

Example: {"items":[{"sku":"<string>","link_type":"<string>","linked_product_sku":"<string>","linked_product_type":"<string>","position":"<integer>","extension_attributes":{"qty":"<number>"}},{"sku":"<string>","link_type":"<string>","linked_product_sku":"<string>","linked_product_type":"<string>","position":"<integer>","extension_attributes":{"qty":"<number>"}}]}

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://{{baseurl}}/V1/products/{sku}/links' \
  --header 'Content-Type: application/json' \
  --data '{
    "items": [
      {
        "sku": "<string>",
        "link_type": "<string>",
        "linked_product_sku": "<string>",
        "linked_product_type": "<string>",
        "position": "<integer>",
        "extension_attributes": {
          "qty": "<number>"
        }
      },
      {
        "sku": "<string>",
        "link_type": "<string>",
        "linked_product_sku": "<string>",
        "linked_product_type": "<string>",
        "position": "<integer>",
        "extension_attributes": {
          "qty": "<number>"
        }
      }
    ]
  }'

200

400

401

500

200

true

OK

catalog Product Link Repository V1Save Put

Save product link

put

/V1/products/{sku}/links

Path parameters

skustringrequired

(Required)

Example: <string>

Header parameters

Content-Typestring

Example: application/json

Body

object

Example: {"entity":{"sku":"<string>","link_type":"<string>","linked_product_sku":"<string>","linked_product_type":"<string>","position":"<integer>","extension_attributes":{"qty":"<number>"}}}

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'http://{{baseurl}}/V1/products/{sku}/links' \
  --header 'Content-Type: application/json' \
  --data '{
    "entity": {
      "sku": "<string>",
      "link_type": "<string>",
      "linked_product_sku": "<string>",
      "linked_product_type": "<string>",
      "position": "<integer>",
      "extension_attributes": {
        "qty": "<number>"
      }
    }
  }'

200

400

401

500

200

true

OK