Jump to Content
Guides
Guides
API Endpoints
v2.2
Guides
API Endpoints
Moon (Dark Mode)
Sun (Light Mode)
New Version
Guides
API Endpoints
Get Formats By sku
Search
JUMP TO
InstaLeap Logistics API
Instaleap Dev Center - v 2.2
Job Creation
Availability (Time Slots) V2
post
Create a Job
post
Slot Queries
Check slot
get
Extend slot expiration time
put
Job Queries
Get job by id
get
Job Actions
Add new item
post
Update existing item
put
Payment info
put
Report potential fraud
put
Report a custom flag
put
Update job comment
put
Replace external data
put
Create new packages
post
Cancel a job
delete
Adds a set of items to a job.
post
Removes a set of items from a job by canceling the ones that match the references sent.
delete
EVENTS, WEBHOOKS, REPLACEMENTS AND STOCK
Client Provided (You)
Webhook 1: Job Tracking Statuses
post
Webhook 2: Chat Notifications
post
Endpoint: Item Search V2 (Replacements)
get
Endpoint: Get Stock (For Picker App Stock Info)
post
Get payment methods (for live ops)
get
Widgets
Intro Live Status Widget V3.x
Live Status Widget V3.X Library JS Mode
Banner
Show promotional image
Display modes
Show replacement products Modal
Colors
Font family
Language
Currency code
Decimals
Prices separeted by comma
Chat Tab
State Tab
Detail Tab
Full screen
Header
Header
Order number
Order status title
Order status
Cancel order
Show cancel button in order late
Show picker phone
Download Invoice
Going To Destination On Transferring status
Cancel Order Text
Order status - steps
Step Confirmed
Step Confirmed Icon
Step picking
Step Picking Icon
Step Going To Destination
Step Going To Destination Icon
Step Ready To Pickup
Step Ready To Pickup Icon
Step Delivered
Step Delivered Icon
Step Picked Up
Step Picked Up Icon
Step Cancel
Step Cancel Icon
Order status - substeps
Sub Steps Names Pick & Delivery
Sub Steps Names Pick & Collect
Sub Steps Icon Pick&Delivery
Sub Steps Icon Pick&Collect
Sub Step Picking Icon Active
Sub Step Picking Icon Inactive
Sub Step Going To Destination Icon Active
Sub Step Going To Destination Icon Inactive
Sub Step Ready To Pickup Icon Active
Sub Step Ready To Pickup Icon Inactive
Sub Step Delivered Icon Active
Sub Step Delivered Icon Inactive
Sub Step Picked Up Icon Active
Sub Step Picked Up Icon Inactive
Order Detail
Order detail
Shipping text
Hide Shipping
Hide Taxes
Discounts text
Hide Discounts
Order Total text
Hide Order Detail
Hide Order Help
Order Help Title
Order Help (HTML)
Curbside
Hide Curbside Parking Place
Curbside field
Curbside open module
Payment method
Payment Method text
Hide Payment Method
Order Payment text
Hide Payment Status
Hide Order transactions
Prepaid
Payment link
Cash
Terminal
Loyalty card
Transfer
Delivery
Delivery code text
Hide Delivery Code
QR and Qr Help
Delivery date and time
Change delivery date
Delivery Address
Origin and destination information
Contactless
Order Late text
Hide Order Late
Products in orden
Products title
Hide Products
Add products
Update products quantities
Products Removed title
Delete Product Button
Change products replacement suggestions
View Products text
Hide Presentation Unit
Limit Change Quantities Products
Help Center
Help Center title
Hide Help Center
Specific chat tab
Custom title chat
Hide Chat with support
Hide Chat with picker
Hide Chat Tab With Driver
Maps
Map
Order map
Custom icons on map
Show images in Pick and collect
Rating order
Can Rate
Rate Question Text
Comment order
Hide Comment Form
Add Comment Title
Comment Help Text
Hide Comment help text
HomeBar
Steps
Step View Title
Show Address
HomeBar Font Size Title
HomeBar Font Size Subtitle
HomeBar Font Size Steps
HomeBar Icon Size
Step Picking Icon Active
Step Picking Icon Inactive
Step Going To Destination Icon Active
Step Going To Destination Icon Inactive
Step Ready To Pickup Icon Active
Step Ready To Pickup Icon Inactive
Step Picked Up Icon Active
Step Picked Up Icon Inactive
Step Delivered Icon Active
Step Delivered Icon Inactive
Live Status Widget V3.x URL Mode
Banner
Show promotional image
Display modes
Show replacement products Modal
Colors
Font family
Language
Currency code
Decimals
Prices separeted by comma
Chat Tab
State Tab
Detail Tab
Full screen
Header
Header
Order number
Order status title
Order status
Cancel order
Show cancel button in order late
Show picker phone
Download Invoice
Going To Destination On Transferring status
Cancel Order Text
Order status - steps
Step Confirmed
Step Confirmed Icon
Step Picking
Step Picking Icon
Step Going To Destination
Step Going To Destination Icon
Step Ready To Pickup
Step Ready To Pickup Icon
Step Delivered
Step Delivered Icon
Step Picked Up
Step Picked Up Icon
Step Cancel
Step Cancel Icon
Order status - substeps
Sub Steps Names Pick & Delivery
Sub Steps Names Pick & Collect
Sub Steps Icon Pick&Delivery
Sub Steps Icon Pick&Collect
Sub Step Picking Icon Active
Sub Step Picking Icon Inactive
Sub Step Going To Destination Icon Active
Sub Step Going To Destination Icon Inactive
Sub Step Ready To Pickup Icon Active
Sub Step Ready To Pickup Icon Inactive
Sub Step Delivered Icon Active
Sub Step Delivered Icon Inactive
Sub Step Picked Up Icon Active
Sub Step Picked Up Icon Inactive
Order Detail
Order Detail
Shipping text
Hide Shipping
Hide Taxes
Discounts text
Hide Discounts
Order Total text
Hide Order Detail
Hide Order Help
Order Help Title
Order Help (HTML)
Curbside
Hide Curbside Parking Place
Curbside Field
Curbside open module
Payment method
Payment Method text
Hide Payment Method
Order Payment text
Hide Payment Status
Hide Order transactions
Prepaid
Payment link
Cash
Terminal
Loyalty card
Transfer
Delivery
Delivery code text
Hide Delivery Code
QR and Qr Help
Delivery date and time
Change delivery date
Delivery Address
Origin and destination information
Contactless
Order Late text
Hide Order Late
Products in orden
Products title
Hide Products
Add products
Update products quantities
Products Removed title
Delete Product Button
Hide Change products replacement suggestions
View Products text
Hide Presentation Unit
Limit Change Quantities Products
Help Center
Help Center title
Hide Help Center
Specific chat tab
Custom title chat
Hide Chat with support
Hide Chat with picker
Hide Chat Tab With Driver
Maps
Map
Order Map
Custom icons on map
Show images in Pick and collect
Rating order
Can Rate
Rate Question Text
Comment order
Hide Comment Form
Add Comment Title
Comment Help Text
Hide Comment help text
HomeBar
steps
Step View Title
Show Address
HomeBar Font Size Title
HomeBar Font Size Subtitle
HomeBar Font Size Steps
HomeBar Icon Size
Step Picking Icon Active
Step Picking Icon Inactive
Step Going To Destination Icon Active
Step Going To Destination Icon Inactive
Step Ready To Pickup Icon Active
Step Ready To Pickup Icon Inactive
Step Picked Up Icon Active
Step Picked Up Icon Inactive
Step Delivered Icon Active
Step Delivered Icon Inactive
Map Widget Library JS Mode
Map Widget URL Mode
DELIVERY LAYER
Intro
Creation
Update
Status
Position update
VTEX Integration
Order references to Job Id
Order references to jobIds
post
Redbook Api official
Intro Catalog Instaleap
Product
Create Product
post
Get Product
get
Update Product by Sku
put
Create Batch Product
post
Update Batch Product
put
Catalog
Create Catalog
post
List Catalog
get
Create Batch Catalog
post
Update Batch Catalog
put
Update Catalog by Sku and Store Reference
put
Store
List Store
get
Promotions
Create Promotions
post
Get Promotions
get
Formats
Create format
post
Get Formats By sku
get
Categories
List Category
get
Tags
Create Tag
post
List Tags
get
Update Tag by Tag Reference
put
Segments
Create segments in catalogs
post
Variants
Creation of Variants
post
List Variants
get
Updates a variant using the variantReference
put
Deletes a variant using the variantReference
delete
E-Commerce Engine
Customer Segments
Client Provided (You)
Customer Segments Gateway
get
SEGMENTS
Create segment
post
Update Segment
put
Powered by
Get Formats By sku
get
https://redbook.instaleap.io/format/formats
Language
Shell
Node
Ruby
PHP
Python
URL
Base URL
https://redbook.instaleap.io
/format/formats
RESPONSE
Click
Try It!
to start a request and see the response here!
