RECIPE: Business Recipe - Create Pay Link with store catalog items

Description: This recipe provides specific implementation details for creating a payment link (known as Pay Link) with catalog items (plain or with variants) on a Wix site, focusing on relevant steps & critical requirements not explicitly covered in the standard documentation.

Documentation Links:

• Pay Links REST API: https://dev.wix.com/api/rest/wix-payments/payment-links/create-payment-link
• Pay Links SDK: https://dev.wix.com/api/sdk/wix-get-paid/paymentlinks
• REST API: https://dev.wix.com/docs/rest/business-solutions/stores/catalog/query-products
• SDK: https://dev.wix.com/docs/sdk/backend-modules/stores/products/query-products

Article: Best Practices for creating Payment Links with Catalog Items

STEP 1: I MUST Find Relevant Catalog Product Details

• I need to find a product with a call to Stores Products V1 API/SDK [If V1 doesn't work - use V3].
  • IF I use query-products with product name, I MUST use such request form [can be have additional properties - details in docs]: query object with inner properties filter as JSON stringified value "{"name":{"$contains":"X"}}" and includeVariants bool.
  • IF I can't possibly find relevant product I MUST ask for clarification.
  • IF variant was not required, use default product price.

STEP 2: Create Payment Link with Catalog Products

• I MUST make sure to provide relevant catalog item details to the payment link.

Critical Requirements:

• Request to Query Product Variants V1 Stores:

  • I MUST NOT pass request body.

• Request prerequisites to create Pay Link with Catalog Items:

  • I MUST set type: "ECOM" & ecomPaymentLink.lineItems for payment links.
  • I MUST set lineItems item type to CATALOG.
  • I MUST set catalogItem details: quantity, catalogReference.
  • I MUST set catalogReference details: appId, catalogItemId and options. options can only have variantId.
  • I MUST set catalogOverrideFields property price always.
  • I should NEVER set additional override values in catalogOverrideFields if the user did not require them.
  • I MUST ensure that IF I must need to provide catalogOverrideFields.descriptionLines it must be valid - object with two inner objects: name, plainText.

• Example Request for Pay Link with Catalog Items {"type":"CATALOG","catalogItem":{"quantity":1,"catalogReference":{"catalogItemId": "<>","appId":"<>","options":{"variantId":"<>"},"catalogOverrideFields":{"productName":{"original":"<>","translated":"<>"},"price":"100.00","fullPrice":"100.00","physicalProperties":{"shippable":true},"descriptionLines":[{"name":{"original":"Variant X","translated":"Variant X"},"plainText":{"original":"Variant X","translated":"Variant X"}}]}}}}

• Important Notes for catalog payment links:

  • Only physical items are shippable.
  • Catalog Item ID is not the same as variantId. To find variantId I should search by Catalog Item ID.
  • Variants are not necessary.

Conditional Logic for Parameters:

• I can add catalog item overrides within catalogOverrideFields

Error handling:

• If Stores Catalog V3 service not accessible for a site: I must use Stores Catalog V1 service.

IMPORTANT NOTES FOR THE CONSUMING LLM:

• Next, I should suggest the user to send pay link to customer.