API Documentation

Requests

Description:

Gets the product ids from all nearby stores for the zip code specified.

Request
                      
                      {
                        "action": EAction, // Required
                        "zip": string, // Required
                        "productIds": EInternalProductId[], // Required
                      }
                    
                  
Response
                      
                        {
                          zip: string, // '12345'
                          products: {
                            [internalProductId: EInternalProductId]: {
                              name: string, // '2x4 Untreated 8 Feet Lumber'
                              description: string, // 'Every stud meets the stamped grading standards for strength.'
                              imageUrl: string, // 'https://images.thdstatic.com/productImages/46ab3cfb-6093-435d-a6f0-c991006f05c3/svn/framing-studs-058449-64_1000.jpg'
                            }
                          },
                          stores: {
                            id: string, // '123'
                            vendorId: EVendorId,
                            name: string, // 'Albert Lea'
                            address: string, // '123 Fake Street'
                            city: string, // 'Fake City'
                            state: string, // 'OH'
                            zip: string, // '12345'
                            phone: string, // '555-555-5555'
                            distance: number, // 4
                            hours: {
                              mon: { open: string, close: string }
                              tue: { open: string, close: string }
                              wed: { open: string, close: string }
                              thu: { open: string, close: string }
                              fri: { open: string, close: string }
                              sat: { open: string, close: string }
                              sun: { open: string, close: string }
                            },
                            products: {
                              [internalProductCategoryId: EInternalProductCategoryId]: {
                                internalProductId: EInternalProductId,
                                externalProductId: string; // '123'
                                url: string;
                                name: string, // '2 in. x 4 in. x 96 in. #2 Premium Grade KD-HT Stud'
                                quantityAvailable: number, // 12345
                                priceCentsPerUnit: number, // 312
                                salePriceCentsPerUnit: number, // 212
                                bulkPriceCentsPerUnit: number, // 112
                                bulkQuantityRequired: number, // 100
                                meta: {
                                  [key: EInternalProductMetaKey]: string
                                }
                              }[]
                            }
                          }[]
                        }
                    
                    

Supporting Types

Description:

The enumeration of supported actions within the system.

                      
                    

Description:

The enumeration of supported product ids within the system.

                      
                      

Description:

The enumeration of supported product categories within the system.

                      
                    

Description:

The enumeration of supported product meta keys within the system.

                      
                    

Description:

The enumeration of supported vendors within the system.