Documentation for Pickup API
Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| CartApi | cartControllerCreate | POST /v1/cart | Create cart |
| DefaultApi | appControllerGetServerInfo | GET / | Get server information |
| DeliveryApi | deliveryControllerGetQuotation | POST /v1/delivery | Get Quotation |
| ItemApi | itemControllerAggregateId | GET /v1/item/{id} | Get item data |
| ItemApi | itemControllerAggregateSearch | GET /v1/item | Search items by name |
| ItemApi | itemControllerGetSoldQuantity | GET /v1/item/{id}/stock | Get inventory of an item |
| OrdersApi | ordersControllerFetchStatus | GET /v1/orders/{transaction_number} | Get order status update |
| OrdersApi | ordersControllerFind | GET /v1/orders | Get customer order history |
| OrdersApi | ordersControllerReorder | GET /v1/orders/{order_id}/reorder | Get re-order plan |
| PromoApi | promoControllerGetPromosByStore | GET /v1/promo/{store_id} | Get list of promo per store |
| PromoApi | promoControllerValidatePromo | POST /v1/promo | Validate promo and get calculated result |
| ReservationBetaApi | reservationControllerAttachPayment | POST /v1/reservation/attach-payment | Attach Reservation Payment |
| ReservationBetaApi | reservationControllerConfirmReservation | POST /v1/reservation/confirm | Confirm reservation |
| ReservationBetaApi | reservationControllerCreateReservation | POST /v1/reservation | Create reservation request |
| ReservationBetaApi | reservationControllerGetReservationHistory | GET /v1/reservation/history | Get Reservation History |
| ReservationBetaApi | reservationControllerGetReservationStatus | GET /v1/reservation/{reservation_id} | Get reservation status and information |
| ReservationBetaApi | reservationControllerGetReservationStatusByNumber | GET /v1/reservation/check-status/{reservation_number} | Get reservation info using reservation number |
| ReservationBetaApi | reservationControllerGetReservationTypeInfo | GET /v1/reservation/type/{id} | Get reservation type information |
| ReservationBetaApi | reservationControllerGetStoresWithReservations | POST /v1/reservation/store/search | Get store list that offers reservations |
| StoreApi | storeControllerFetchMenu | GET /v1/store/{id}/menu | Get store menu |
| StoreApi | storeControllerFind | POST /v1/store | Find store |
| StoreApi | storeControllerFindOne | GET /v1/store/{id} | Get store information |
| StoreApi | storeControllerGetStoreDateOptions | GET /v1/store/{id}/order-dates | Get store date options |
Documentation for Models
- AttachedReservationPaymentEntity
- AvailableReservationEntity
- CartDTO
- CartDTO_curbside_pickup_option
- CartDTO_customer
- CartDTO_delivery_option
- CartDTO_third_party_pickup_option
- CartEntity
- CartItemDTO
- CategoryClass
- ConfirmReservationDTO
- ConfirmReservationEntity
- CreateReservationDTO
- CreateReservationDTO_contact
- CreateReservationEntity
- CursbsidePickupDTO
- CustomerAddressDTO
- CustomerDetail
- CustomerDetailDTO
- CustomerDetailDTO_address
- CustomerQuoteDTO
- DeliveryOptionDTO
- DeliveryQuotationEntity
- DeliveryQuotationResultEntity
- DeliveryQuotationResultEntity_selected
- ExtraGroupClass
- GroupSelectionClass
- ItemClass
- ItemInventoryEntity
- ItemPartialClass
- ItemTimeSlotClass
- ItemsEntity
- LocationPointDTO
- MenuClass
- MenuClass_item
- MenuItemClass
- OrderDetailsClass
- OrderDetailsClass_item
- OrderEntity
- OrderExtraClass
- OrderItemClass
- OrderPartialClass
- OrderPartialClass_customer
- OrderPartialClass_pickup_details
- OrderPartialClass_promo
- OrderPartialClass_store_details
- PromoDTO
- PromoDiscountDetails
- PromoEntity
- PromoListResponse
- QuotationRequestDTO
- QuotationRequestDTO_customer
- ReorderDetailsClass
- ReorderEntity
- ReorderEntityPlan
- ReorderEntityStatus
- ReorderEntity_plan
- ReorderEntity_status
- ReservationContact
- ReservationCustomerEntity
- ReservationEntity
- ReservationInfoEntity
- ReservationInfoEntity_contact
- ReservationInfoEntity_payment
- ReservationInfoEntity_store
- ReservationInfoEntity_type
- ReservationPaymentAttachDTO
- ReservationPaymentEntity
- ReservationSettingEntity
- ReservationTimeSlots
- ReservationTypeClass
- ReservationTypeClass_hours
- SearchAvailableStoresForReservationDTO
- SearchStoreDTO
- SearchStoreDTO_location_point
- StoreClass
- StoreDetailsClass
- StoreHoursClass
- StoreMenuClass
- StoreOrderDateTimeOptions
- StoreOrderDates
- StoreOrderDatesEntity
- StorePartialClass
- StoreReservationClass
- StoreReservationClass_reservations
- StoreReservationClass_store
- StoreReservationHoursEntity
- StoreReservationSearchClass
- StoreSearchClass
- StoresEntity
- ThirdPartyCustomerDetail
- ThirdPartyPickupDTO
- ValidPromoEntity
- ValidPromoEntity_promo
Documentation for Authorization
api-key
- Type: API key
- API key parameter name: X-API-KEY
- Location: HTTP header