This page documents a feature that is currently in development. This documentation might not match the final implementation.
Use an object based on FulfillmentOption
to represent each fulfillment option that appears in the payment sheet when the customer interacts with Meta Pay.
When FulfillmentType
is:
SHIPPING
- use FulfillmentOption
directly to pass in shipping option.PICKUP
- use child interface PickupFulfillmentOption
(see below) to pass in pickup option.FulfillmentOption
provides data for PaymentDetails.
Property | Type | Description | Required |
---|---|---|---|
| string | The unique identifier for the fulfillment option. | Yes |
| string | Information about the fulfillment option that appears to the customer (e.g. UPS Ground, USPS Priority, pickup store name, etc). | Yes |
| The cost of the fulfillment option. | Yes | |
| Date | Earliest estimated datetime (or guaranteed datetime) of fulfillment. | No |
| Date | Latest estimated datetime of fulfillment. | No |
NOTE: Please be sure to specify the correct time zone for Date
; otherwise, it will default to UTC time zone.
Use an object based on PickupFulfillmentOption
to represent each pickup option that appears in the payment sheet when the customer interacts with Meta Pay.
PickupFulfillmentOption
is a subclass of FulfillmentOption
and inherits all of its members listed above.
Use only when FulfillmentType
is PICKUP
.
PickupFulfillmentOption
provides data for PaymentDetails.
Property | Type | Description | Required |
---|---|---|---|
| The address of the store for the order to be picked up at. | Yes | |
| boolean | Whether the store is available for the order to be picked up at. | Yes |
| Approximate distance between the user and the store. | No |