POST:buy_links.json

Description

Create one or multiple buy links.

Permission bit: "buy_links.create"

Topic: Buy Links

Query Parameters

shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

Request Body

Array of BuyLinkCreate

Copy
[
  {
    "custom_items": [
      {
        "grams": 200,
        "height": 150,
        "inventory_location_id": "",
        "length": 150,
        "physical": true,
        "price": 5,
        "tax_class": "",
        "taxable": true,
        "title": "",
        "width": 150
      }
    ],
    "enabled": false,
    "id": "mega-frobnicate",
    "line_items": [
      {
        "custom_item_index": {
          "value": 5
        },
        "field_set_id": "",
        "fields": [
          {
            "choice_index": 5,
            "field_index": 5,
            "label": "",
            "type": "checkbox",
            "value": ""
          }
        ],
        "quantity": 1,
        "subscription_plan_index": {
          "value": 5
        },
        "variant_id": "va_EQzGqWoY"
      }
    ],
    "name": "Mega Frobnicate"
  }
]

Response Body

Array of BuyLink

Response Body Type

Loading module