Skip to main content

Fulfillment Type

The API for fulfillment types can display details of delivery options. Users can utilize the objects to understand and select the desired fulfillment type for their orders.

Endpoints
GET
/api/v2/fulfillment-type/list# Retrieve List

Retrieve List​

Users can choose the type of fulfillment they prefer. This API allows retrieval of the available fulfillment options.


Headers​

The server accepts JSON-formatted responses.



Parameters​

sku string *

The param specifies the stock keeping unit.

zip_code number *

The param specifies the zip code of the area.

without_eta number *


Attributes​

sku string

It indicates the code of stock keeping unit.

fulfillment_types array of objects
fulfillment_type number

It contains the id of the fulfillment type.

fulfillment_type_name string

It shows the name of the fulfillment type.

is_disable number

It indicates the option which is chosen.

estimated_availability string

It shows the estimation of fulfillment type availability.

estimated_availability_desc string

It shows the description of fulfillment type availability.

installation_availability null

It is optional to use this.

pickup_time null

It is optional to use this.

pickup_time_availability null

It is optional to use this.

pickup_time_availability_desc null

It is optional to use this.

pickup_time_post_desc null

It is optional to use this.

GET /api/v2/fulfillment-type/list
curl --location 'https://appliance-api.com/api/v2/fulfillment-type/list?zip_code=63005&sku=GNE27JYMFS' \
--header 'Accept: application/json' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'
{
  "code": "200",
  "message": "Success",
  "data": [
    {
      "sku": "GNE27JYMFS",
      "fulfillment_types": [
        {
          "fulfillment_type": 1,
          "fulfillment_type_name": "Local Delivery Only",
          "is_disable": 0,
          "estimated_availability": "Wed, Nov 22nd",
          "estimated_availability_desc": "Guaranteed by",
          "installation_availability": null,
          "installation_availability_desc": null,
          "pickup_time": null,
          "pickup_time_availability": null,
          "pickup_time_availability_desc": null,
          "pickup_time_post_desc": null
        },
        {
          "fulfillment_type": 3,
          "fulfillment_type_name": "Local Delivery & Install",
          "is_disable": 0,
          "estimated_availability": null,
          "estimated_availability_desc": null,
          "installation_availability": "Wed, Nov 22nd",
          "installation_availability_desc": "Guaranteed by",
          "pickup_time": null,
          "pickup_time_availability": null,
          "pickup_time_availability_desc": null,
          "pickup_time_post_desc": null
        },
        {
          "fulfillment_type": 2,
          "fulfillment_type_name": "Pickup",
          "is_disable": 0,
          "estimated_availability": null,
          "estimated_availability_desc": null,
          "installation_availability": null,
          "installation_availability_desc": null,
          "pickup_time": "tomorrow",
          "pickup_time_availability": null,
          "pickup_time_availability_desc": null,
          "pickup_time_post_desc": "Ready at 09:30 AM"
        }
      ]
    }
  ],
  "meta": null,
  "errors": null
}