Links

catalog Product Link Management V1Get Linked Items By Type Get

get

Provide the list of links for a specific product

Path parameters

skustringRequired

(Required)

Example: <string>

typestringRequired

(Required)

Example: <string>

Responses

200

OK

application/json

Responseobject

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

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

HTTPcURLJavaScriptPython

GET /V1/products/{sku}/links/{type} HTTP/1.1
Host: {{baseurl}}
Accept: */*

[
  {
    "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>"
    }
  }
]

catalog Product Link Repository V1Delete By Id Delete

delete

Path parameters

skustringRequired

(Required)

Example: <string>

typestringRequired

(Required)

Example: <string>

linkedProductSkustringRequired

(Required)

Example: <string>

Responses

200

OK

application/json

Responseobject

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

delete

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

HTTPcURLJavaScriptPython

DELETE /V1/products/{sku}/links/{type}/{linkedProductSku} HTTP/1.1
Host: {{baseurl}}
Accept: */*

true

catalog Product Link Management V1Set Product Links Post

post

Assign a product link to another product

Path parameters

skustringRequired

(Required)

Example: <string>

Header parameters

Content-TypestringOptionalExample: application/json

Body

application/json

objectOptionalExample: {"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

200

OK

application/json

Responseobject

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

/V1/products/{sku}/links

HTTPcURLJavaScriptPython

POST /V1/products/{sku}/links HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 355

{
  "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>"
      }
    }
  ]
}

true

catalog Product Link Repository V1Save Put

put

Save product link

Path parameters

skustringRequired

(Required)

Example: <string>

Header parameters

Content-TypestringOptionalExample: application/json

Body

application/json

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

Responses

200

OK

application/json

Responseobject

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

put

/V1/products/{sku}/links

HTTPcURLJavaScriptPython

PUT /V1/products/{sku}/links HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 182

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

true