buyLinksCreate
buyLinksCreate
POST:buy_links.json

Description

Create one or multiple buy links.

Permission bit: "buy_links.create"

Arguments

data: [BuyLinkCreate!]!

Main argument for mutations.


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Data Argument Fields

custom_items: [OrderCustomItemCreate!]


enabled: Boolean

Whether this link is enabled or not

Example: false


id: String!

ID of the Buy Link, used as part of the URL

Example: "mega-frobnicate"

Valid when: id matches regexp pattern: ^[0-9a-z_-]+$

Valid when: id's length doesn't exceed 250 characters


line_items: [BuyLinkLineItemCreate!]!


name: String!

Human-friendly name of the Buy Link

Example: "Mega Frobnicate"

Valid when: name is not empty

Valid when: name's length doesn't exceed 250 characters


Result

[BuyLink!]

Preview (typescript)

Loading module