Skip to main content
POST
https://api-staging.luladelivery.store
/
inventory
/
ingestion
Upload JSON file for item ingestion
curl --request POST \
  --url https://api-staging.luladelivery.store/inventory/ingestion/ \
  --header 'Content-Type: application/json' \
  --data '{}'
{
    "id": 330,
    "store_id": "7e3154b3-9460-4c68-802c-0f7122cb7a58",
    "original_file_path": "s3://lula-inventory-service-staging/Upsert/Input_files/Json_files/7e3154b3-9460-4c68-802c-0f7122cb7a58/9f1bacb2-55cc-4abe-8aac-12e6e54a74d8.json",
    "status": "pending",
    "created_by": "unknown",
    "updated_by": "unknown",
    "updated_at": "2023-07-15T12:53:27.693Z",
    "created_at": "2023-07-15T12:53:27.693Z",
    "validate_file_path": null,
    "oneschema_embed_id": null
}
All items will be validated using our validation rules. Only items that pass all rules will be inserted.
​
name
string
required
Product name. Example: “Coca Cola Classic”
​
category
string
required
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
  • Hot Foods
  • Automotive
  • Fountain
  • Tobacco
​
size
string
required
Product size. Example: “12 oz”
If product doesn’t contain a size, the text “NA” can be used instead
​
quantity
number
required
Product quantity in Store’s inventory. Example: 99
Minimum allowed quantity: 0
Send 0 to mark this product as Out of Stock
​
price
number
required
Product price in cents. Example: 265
Minimum allowed price: 0. Maximum allowed price: 34999
​
external_id
string
required
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
​
upc
string
Product UPC. Example: “49000012521”
​
image_url
string
Product image URL. Example: “https://go-upc.s3.amazonaws.com/images/68916944.jpeg”
We prefer images with size 1600x900
​
location
string
Product location. Example: “Counter”
​
description
string
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
​
brand
string
Product brand. Example: “Coca Cola”
​
unit_count
string
Product unit count. Example: “12 Pack”
​
active
boolean
default:true
Product status
If set to false, the product will be considered removed from your Store

​
Body

​
file
file
required
​
store_id
string
required

​
Response

​
id
number
The id of the job which ingests the JSON file.
​
store_id
string
The store id for which the JSON file has been uploaded.
​
original_file_path
string
The S3 url where the JSON file has been uploaded.
​
status
string
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
​
created_by
string
The user by which the job was created.
​
updated_by
string
The user by which the job was updated.
​
updated_at
datetime
The timestamp at which the job is updated.
​
created_at
datetime
The timestamp at which job was created.
​
validate_file_path
string
The updated JSON file, after applying validations.
​
oneschema_embed_id
number
Not applicable
{
    "id": 330,
    "store_id": "7e3154b3-9460-4c68-802c-0f7122cb7a58",
    "original_file_path": "s3://lula-inventory-service-staging/Upsert/Input_files/Json_files/7e3154b3-9460-4c68-802c-0f7122cb7a58/9f1bacb2-55cc-4abe-8aac-12e6e54a74d8.json",
    "status": "pending",
    "created_by": "unknown",
    "updated_by": "unknown",
    "updated_at": "2023-07-15T12:53:27.693Z",
    "created_at": "2023-07-15T12:53:27.693Z",
    "validate_file_path": null,
    "oneschema_embed_id": null
}