All items will be validated using our validation rules. Only items that pass all rules will be inserted.
Product name. Example: “Coca Cola Classic”
Product category. Example: “Soda”
If an invalid category is sent, it will be automatically set to “Others”
Alcohol
Baby
Bakery
Bath & Beauty
Beer
Beverages
Breakfast
Candy
Chicken
Cleaning
Coffee
Deli Items
Energy Drinks & Electrolytes
Featured Favorites
Fresh Food
Frozen
Grocery
Health
Household
Ice Cream
Juice and Tea
Medicine
Milk
Original crust pizza
Others
Personal Care
Pet Care
Pizza
Prepared Foods
Quick Meals
Sandwiches
Seltzer
Sides
Single Beer
Snacks
Soda
Thin crust pizza
Water
Wine
Wing Bites
Wings
Product size. Example: “12 oz”
If product doesn’t contain a size, the text “NA” can be used instead
Product quantity in Store’s inventory. Example: 99
Minimum allowed quantity: 0
Send 0
to mark this product as Out of Stock
Product price in cents. Example: 265
Minimum allowed price: 0. Maximum allowed price: 34999
Product identification in your internal system. Example: “1234_5678”
If a product with same External ID already exists in your Store, it will be updated
Product UPC. Example: “49000012521”
Product location. Example: “Counter”
Product description. Example: “Soda. Pop. Soft drink. Sparkling beverage. Whatever you call it, nothing compares to the refreshing, crisp taste of Coca-Cola Original Taste”
Maximum allowed description length: 350 characters
Product brand. Example: “Coca Cola”
Product unit count. Example: “12 Pack”
Product status
If set to false
, the product will be considered removed from your Store
Body
Response
The id of the job which ingests the JSON file.
The store id for which the JSON file has been uploaded.
The S3 url where the JSON file has been uploaded.
The status of the job.
importing: The job's CSV is filed is being imported (only applies to CSV ingestion)
pending: The job is in the queue and will start being processed soon
processing: The job is being processed
validation_failed: The job finished but at least one item failed validation
success: The job finished and all items were successfully created, updated or removed
error: An unexpected error occurred when processing the job. Please contact us
The user by which the job was created.
The user by which the job was updated.
The timestamp at which the job is updated.
The timestamp at which job was created.
The updated JSON file, after applying validations.