Skip to main content

Intro

This page is a comprehensive resource for integrating our food ordering and store management platform into your existing systems. Our API provides easy-to-use tools to streamline your order management, making it simpler and faster to manage your store. Whether you're a developer or business owner, our API documentation will give you the information you need to take advantage of the powerful features and functionalities of Pickup.

Getting Started

Get started by requesting for a sandboxed api-key here.

Or try contacting our sales at sales@pickup.ph.

What you'll need

  • API Key
  • REST API tool(s)
    • We recommend Postman if you are just trying it out
    • Or use Curl

Get list of stores

This command returns list of stores that has searchKey as part of it's name or, and/or items that has searchKey in it's name or description.

curl --location --request GET 'https://https://edge.stg.pickup.ph/v1/store?name={{searchKey}}' \
--header 'Accept: application/json' \
--header 'X-API-KEY: {{apiKey}}'

The following example response has list of stores that has chicken in it's menu.

{
    "result": [
        {
            ...,
            "name": "ADB - Eastwood - Delivery Only",
            "searched_items": [
                {
                    "id": "63062e943219b4001741e6c9",
                    "name": "Umami Chicken Rice Meal",
                    "description": "Umami Chicken Rice Meal",
                    "image_url": "https://pickupbeta.s3.ap-southeast-1.amazonaws.com/items/item_98b8096fb2e31_1661335117.jpg",
                    "discount_description": "",
                    "active_discount": "0.00",
                    "price": "250.00",
                    "discount_type": "noDiscount",
                    "discount_value": "0",
                    "discounted_price": "250.00",
                    "regular_price": "250.00",
                    "tags": []
                }
            ],
            "contact_number": "09121234567",
            "is_store_open": true,
            "delivery_distance_limit": 0
        },
        {
            ...,
            "name": "ADB - Alabang - Limits",
            "store_tags": [
                "Asian"
            ],
            "searched_items": [
                {
                    "id": "6307330d06bf2a00171c19ed",
                    "name": "Umami Chicken Rice Meal",
                    "description": "Umami Chicken Rice Meal",
                    "image_url": "https://pickupbeta.s3.ap-southeast-1.amazonaws.com/items/item_98b8096fb2e31_1661335117.jpg",
                    "discount_description": "",
                    "active_discount": "0.00",
                    "price": "250.00",
                    "discount_type": "noDiscount",
                    "discount_value": "0",
                    "discounted_price": "250.00",
                    "regular_price": "250.00",
                    "tags": []
                }
            ],
            "contact_number": "09121234567",
            "is_store_open": true,
            "delivery_distance_limit": 0
        },
        ...,
    "has_next_page": false,
    "has_prev_page": false,
    "total_pages": 1,
    "page": 1
}

Create cart and checkout url

Pickup lets you manage your own cart along with UI and UX so you can have the flexibility in your application. Creating a pickup cart means creating a checkout link for you customer. This link has all the supported payment and delivery option of the selected store.

curl --location --request POST 'https://edge.stg.pickup.ph/v1/cart' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'X-API-KEY: {{apiKey}}' \
--data-raw '{
  "items": [
    {
      "id": "63062e943219b4001741e6ab",
      "quantity": 3
    }
  ],
   "customer": {
       "address": {
           "lng": 121.0226361,
           "lat": 14.5614248
       },
      "first_name": "Felipe",
      "last_name": "Mercado",
      "mobile_number": "09123456789",
      "email": "fel.mercado@email.com",
      "id": "cust-001"
  },
  "delivery_option": {
    "delivery_payment_method": "non_cash",
    "delivery_vehicle": "motorcycle"
  },
   "order_type": "delivery"
}'

Two things to note in this example command:

  1. In the customer object request, notice that you are encourage to pass a customer id, this could be a reference to an actual customer ID on your end, or the actual customer ID itself. This gives you and your team the flexiblity to track your customer's orders without us having dependency in your API.
  2. A valid geolocation coordinates is required to auto select the correct address of your customer for delivery type orders.

Continue on to the next page to get more comprehensive guide on testing and calling our API.