Path API

Returns all brand profiles in the database

Successful POST to create a Brand under brand_profiles

Returns a brand profile where it equals brandId in the database

Returns a brand profile where it equals storefrontURL in the database

Returns a brand page flows in the database by id

updates a brand page flow by id or creates new if id == 'new' or 'default'

Returns a path map where it equals pathMapId in the database

Returns Campaign with matching campaignId in the database

Successful for BrandCampaign with BrandCampaign ID

Successful POST to create a Campaign under brand_campaigns

migrates data from one database to another using upsert functionality

Creates a PathMap. This route updates a PathMap on create, if the pathmapId already exists.

Returns path maps where they equal campaignId in the database

Successful GET for PathMaps by campaignId

Returns path maps where they equal brandId in the database

Soft deletes a path map from the database. This changes the path map "isDeleted" field to true.

Successful (soft) DELETE for PathMap by PathMapId

Returns analytics for specified path map by pathMapId

Successful GET for analytics by PathMapId

Successful POST for analytics by PathMapId

Error brandID not found where brandId = brandID

Successful GET of all Shopify Collections

Returns a Shopify Collections by collectionID

Successful GET of Shopify Collections by collectionID

Successful GET for for all Shopify products

Successful GET for Shopify product by productSlug

Returns all Template data in our database

Successful updates a template by pathMapID

Successful GET for all brand templates by brandId

Returns brand template by brandTemplateId

Successful GET for brand template by brandTemplateId

Returns all Template Preview data in our database

Returns preview Template data by templateId = previewId

Publishes the template by templateId by updating the isPulished field of the template by templateID

Successful UPDATE isPublished field by templateID

Revalidate

Uses GraphQL to get Shopify products.Uses Apollo library.

Get Shopify Products

Uses GraphQL to get a Shopify product where slug = [productSlug].

Get ONE Shopify Product

Shopify

Use mongoose to find all routes that depend on this product slug and revalidate

Revalidate Storefront Based on Product Slug

Shopify Hooks

Get Brand Profiles

Brand

Get Ecommerce Data

{          
id: /id,
          
productImage: /image,
          
productName: /productName,
          
productShortDescription: /productShortDescription,
          
productPrice: /productPrice,
          
itemCount: /itemCount,
          
inStock: /inStock,
          
productSlug: /productSlug,
          
rating: /rating,
          
tags: /tags,
          
productThumbnails: /productThumbnails,
          
productSwatches: /productSwatches,
          
sizes: /sizes,
          
totalRating: /totalRating,
          
testimonials: /testimonials,
          
badges: /badges,
        }

Create Ecommerce Product

Ecommerce Data

Get Path Map

{          
adId: /adId,
          
brandId: /brandId,
          
templateId: /templateId,
          
templateActive: /templateActive,
          
tags: /tags,
          
adName: /adName,
          
adBannerImage: /adBannerImage,
          
adHeader: /adHeader,
          
adFooter: /adFooter,
          
target: /target,
          
adPathMapActive: /adPathMapActive,
          
views: /views,
          
updatedAt: /updatedAt,
        }

Create Path Map

Get Path Maps by Brand Id

Get Path Map by Id

Delete Path Map by Id

Update Path Map by Id

Path Map

{          
pathMapID: /pathMapID,
          
pathMapType: /pathMapType,
          
pathMapScope: /pathMapScope,
          
template: /template,
        }