Pickup Point Delivery Option Generator API reference
The Pickup Point Delivery Option Generator API enables you to generate custom pickup points available to buyers during checkout. The API includes three key objects: Input
, FunctionFetchResult
and FunctionRunResult
.
Extension targets
Anchor link to section titled "Extension targets"The Pickup Point Delivery Option Generator API exposes the following targets:
Target | Output type | Description |
---|---|---|
purchase.pickup-point-delivery-option-generator.fetch |
FunctionFetchResult | See Network access for Shopify Function |
purchase.pickup-point-delivery-option-generator.run |
FunctionRunResult | Outputs the list of validation errors |
Fetch target
Anchor link to section titled "Fetch target"The fetch target is responsible for generating an HTTP request to call the external API.
The following example shows an input query:
The Input
object is the complete schema that your function can receive as input.
The following example shows an input query:
The following example shows the resulting input to the query:
The FunctionFetchResult
object is the shape of the function's output.
The run target is responsible for generating the pickup point delivery options.
The following example shows an input query:
The Input
object is the complete schema that your function can receive as input.
The following example shows an input query:
The following example shows the resulting input to the query:
The FunctionRunResult
object is the shape of the function's output.