This documentation is in beta, and might contain errors. Contact us at integration@instabee.com with any questions.

Instabee API

Post Packing Flow

The Post Packing flow confirms that the parcel is physically packed and ready for home delivery pickup. Call this once the parcel is prepared in your warehouse. It follows the Post Purchase call and triggers the final delivery planning with Instabee.

API Endpoint

EndpointMethodContent-Type
api.integration.instabee.com/orders (production) · sandbox-api.integration.instabee.com/orders (sandbox)PUTapplication/json

When to Use

Call this endpoint after:

  1. A parcel has been registered with the Post Purchase API
  2. The order has been physically packed and prepared for shipping
  3. The final dimensions and weight are known (if different from initial estimates)

Integration Levels

Merchants can send information in different steps depending on their workflow:

  • Bare Minimum: If everything was sent in Post Purchase, just confirm packing
  • Minimum: Basic confirmation with essential parcel details
  • Maximum: Complete order details with final dimensions and product information

Key Benefits

  1. Pickup Scheduling: Triggers pickup scheduling and route optimization
  2. Label Generation: Provides shipping labels for the packed parcels
  3. Final Confirmation: Confirms actual dimensions and weight for accurate delivery
  4. Status Updates: Updates tracking status for customers

Integration Workflow

  1. Post Purchase: Initial prebooking reserves delivery capacity
  2. Physical Packing: Pack the order in your warehouse
  3. Post Packing: Confirm packing with this API (final dimensions, weight)
  4. Label Download: Download shipping labels from the response
  5. Pickup: Prepare parcels for scheduled pickup

Next Steps

Quick Links

Create Order API (Post Packing)

The Post Packing API is used to update a parcel's status after it has been physically packed and is ready for pickup and delivery. This is the final confirmation step after the initial Post Purchase prebooking.

Post Purchase vs Post Packing: The Post Purchase flow is like a prebooking that reserves delivery capacity. The Post Packing flow is the final confirmation after physical packing, providing actual dimensions and confirming the parcel is ready for pickup.

This endpoint should be called after:

  1. A parcel has been registered with the Post Purchase API
  2. The order has been physically packed and prepared for shipping
  3. The final dimensions and weight are known

Merchants can send information in different steps - some may provide all details in Post Purchase, others may provide minimal information initially and complete details in Post Packing.

Request Body

ParameterTypeRequiredDescriptionConstraintsComment
parcelPackingConfrimedbooleanoptional*1. Set to true if only the post packing call is made. 2. If you want to make more edits then actively set to false. 3. The post packing call will automatically set this param to true if nothing is sent.true or false
brandstringoptionalDefine brand of the delivery optionsinstabox or budbee
productstringrequiredDefine the product of the delivery optionsMust be oneLOCKER_EXPRESS, LOCKER_RETURN, HOME_DELIVERY, LOCKER_CAPACITY_SURPLUS, LOCKER_ALLOCATION, LOCKER_AREA
countryCodestringrequired*Recipient country code. Can be sent in query paramISO 3166 alpha 2
parcelPackingConfirmedbooleanconditional*Confirm parcel is packed and ready for pickupSee docs
availabilityTokenstringoptionalAvailability token from availability response
orderIdstringoptionalUnique order reference for subsequent calls
parcelIdstringoptionalUnique identifier/barcode for parcelAuto-generated if omitted
merchantBrandIdstringoptionalBrand identifier
communicationNamestringoptionalCommunication name override
senderobjectoptionalSender information objectMainly for C2C and LOCKER_RETURN
recipientobjectrequiredRecipient information object
isLabellessbooleanoptionalFor LOCKER_RETURN only. Indicates if the return is labelless (consumer does not attach a label)
associatedParcelIdstringoptionalFor LOCKER_RETURN only. The outbound parcel ID. If provided, the return order is created only after the outbound is delivered. If omitted, treated as a standalone return order.
dispatchobjectoptionalDispatch readiness and warehouse
optionsobjectoptionalResponse options / language
deliveryInstructionsobjectoptionalDelivery instruction details
additionalServicesobjectoptionalAdditional services
cartobjectoptionalParcel and/or product details

recipient

ParameterTypeRequiredDescriptionConstraintsComment
namestringrequiredRecipient name
emailstringrequiredRecipient email addressValid email formatUsed for delivery notifications
phonestringrequiredRecipient phone numberMin: 6 digits, Max 15 digitsCan be made optional with setting
ssnstringoptionalSocial security numberFor age verification services
streetstringrequiredRecipient street address
street2stringoptionalAdditional address informationFloor, apartment, etc.
postalCodestringrequiredRecipient postal code
citystringrequiredRecipient city
countryCodestringrequiredRecipient country codeISO 3166 alpha 2e.g., "SE", "DK", "NO"
coordinatesobjectoptionalGPS coordinatesFor precise location

recipient.coordinates

ParameterTypeRequiredDescription
latnumberoptionalLatitude
lonnumberoptionalLongitude

sender

ParameterTypeRequiredDescriptionConstraints
namestringoptionalSender/merchant name
emailstringoptionalSender email addressValid email format
phonestringoptionalSender phone number
streetstringoptionalSender street address
street2stringoptionalAdditional sender address info
postalCodestringoptionalSender postal code
citystringoptionalSender city
countryCodestringoptionalSender country codeISO 3166 alpha 2
coordinatesobjectoptionalSender GPS coordinates

sender.coordinates

ParameterTypeRequiredDescription
latnumberoptionalLatitude
lonnumberoptionalLongitude

deliveryOption

ParameterTypeRequiredDescriptionComment
sort_codestringrequiredSort code for the lockerIdentifies specific locker or specific home delivery time
etaIntervalobjectoptionalPreferred delivery time window

deliveryOption.etaInterval

ParameterTypeRequiredDescriptionConstraintsComment
fromstringoptionalStart of delivery windowISO-8601 datetime
tostringoptionalEnd of delivery windowISO-8601 datetimeWill default to best available if doesn't match

dispatch

ParameterTypeRequiredDescriptionConstraintsComment
readyToShipstringoptionalWhen parcel is ready for pickupISO-8601 datetimeOnly one of readyToShip/readyToPack/outOfStock
readyToPackstringoptionalWhen packing process will startISO-8601 datetimeInstabee adds packing time to this
outOfStockbooleanoptionalProduct is out of stocktrue/falseRemoves ETA from delivery options
packingTimenumberoptionalRequired packing time in minutes
collectionPointIdstringoptionalSpecific warehouse/pickup pointConfigured by Instabee
returnPointIdstringoptionalReturn address point IDFor failed deliveries

options

ParameterTypeRequiredDescriptionConstraintsComment
languageCodestringoptionalLanguage for customer communicationsISO 639-1e.g., "EN", "SE", "NO"
localEtasbooleanoptionalReturn local delivery termstrue/falseDifferent local terms for delivery promise
estimatedParcelTypebooleanoptionalReturn estimated parcel sizetrue/falseCalculated based on cart contents

deliveryInstructions

ParameterTypeRequiredDescriptionConstraintsComment
notifyBystringoptionalHow to notify recipient"ring_doorbell", "knock_on_door"
doorCodestringoptionalDoor or building access code
messagestringoptionalSpecial delivery instructionsFree text message
intercombooleanoptionalUse intercom if availabletrue/false

additionalServices

ParameterTypeRequiredDescriptionConstraintsComment
identificationobjectoptionalIdentity verification requirements
leaveByDoorstringoptionalAllow leaving parcel by door"allow", "disallow", "force"
leaveWithNeighbourstringoptionalAllow leaving with neighbor"allow", "disallow", "force"
numberOfMissRetriesnumberoptionalNumber of delivery retry attemptsMinimum: 1null = default

additionalServices.identification

ParameterTypeRequiredDescriptionConstraintsComment
typestringoptionalType of verification"age_limit", "age_limit_at_handover", "specific_person", "any_person"
ageLimitnumberoptionalMinimum age requiredUsed with age_limit types
ssnstringoptionalRequired SSN for verification
namestringoptionalRequired name for verification

cart

ParameterTypeRequiredDescriptionConstraintsComment
checkoutIdstringoptionalCheckout session IDOneOf this, orderNumber, or availabilityToken
orderNumberstringrequired*Your order numberOneOf this, checkoutId, or availabilityTokenUsed to link with your system
totalValueInCentsnumberoptionalTotal order value in centsUsed for insurance purposes
totalWeightGramnumberoptionalTotal weight in gramsFor logistics planning
parcelobjectoptionalParcel dimensions and contentsDetailed parcel information

cart.parcel

ParameterTypeRequiredDescriptionConstraintsComment
heightMmnumberoptionalParcel height in mm
widthMmnumberoptionalParcel width in mm
lengthMmnumberoptionalParcel length in mm
volumeDm3numberoptionalParcel volume in dm³
estimatedSizestringoptionalEstimated size category"small", "medium", "large"
weightGramnumberoptionalParcel weight in grams
typestringoptionalParcel type"box", "envelope", "bag"
productsarrayoptionalArray of products in parcelDetailed product information

cart.parcel.products[]

ParameterTypeRequiredDescription
namestringoptionalProduct name
quantitynumberoptionalQuantity of this product
productIdstringoptionalYour product identifier
detailsobjectoptionalDetailed product information

cart.parcel.products[].details

ParameterTypeRequiredDescriptionConstraints
productTypestringoptionalType of producte.g., "Prescription"
imgUrlstringoptionalProduct image URL
categorystringoptionalProduct category
brandstringoptionalProduct brand
descriptionstringoptionalProduct description
priceobjectoptionalPrice information
temperatureobjectoptionalTemperature requirements

cart.parcel.products[].details.price

ParameterTypeRequiredDescriptionConstraintsComment
priceInCentsnumberoptionalPrice in cents
taxRateInCentsnumberoptionalTax amount in cents
discountRateInCentsnumberoptionalDiscount amount in cents
currencystringoptionalCurrency codeISO 4217e.g., "SEK"

cart.parcel.products[].details.temperature

ParameterTypeRequiredDescription
minnumberoptionalMinimum temperature in Celsius
maxnumberoptionalMaximum temperature in Celsius

cart.parcel.products[]

ParameterTypeRequiredDescription
packagesarrayoptionalPhysical package information

cart.parcel.products[].packages[]

ParameterTypeRequiredDescriptionComment
widthMmnumberoptionalPackage width in mmNote: Different from Post Packing (widthMm)
heightMmnumberoptionalPackage height in mmNote: Different from Post Packing (heightMm)
lengthMmnumberoptionalPackage length in mmNote: Different from Post Packing (lengthMm)
weightMmnumberoptionalPackage weightNote: Different unit from Post Packing
volumeDm3numberoptionalPackage volume in mm³Note: Different from Post Packing (volumeDm3)
barcodesarrayoptionalBarcode information

cart.parcel.products[].packages[].barcodes[]

ParameterTypeRequiredDescriptionConstraintsComment
codestringoptionalBarcode value
typestringoptionalBarcode type"ean13", etc.Lowercase in Post Purchase

Response

The API returns an updated parcel object with:

FieldTypeDescription
parcelIdstringThe Instabee parcel ID
statusstringUpdated status (e.g., "PENDING_PACKING" or "FINALIZED")

links (object)

FieldTypeDescription
labelstringURL to download the shipping label
trackingstringURL to track the parcel

label URL parameters

The label URL supports optional query parameters to customize the output:

ParamTypeDefaultOptionsDescription
fileFormatstringpdfpng, zpl, pdfOutput file format
base64booleanfalsetrue, falseReturn label as base64-encoded string
templatestringa6a6, a7Label paper size
dpiinteger96Resolution in dots per inch
debugbooleanfalsetrue, falseEnable debug mode

Best Practices

  1. Accurate Measurements: Always provide accurate dimensions and weight
  2. Prompt Confirmation: Confirm packing as soon as possible after physical packing
  3. Error Handling: Implement proper error handling for failed confirmations
  4. Label Management: Download and store shipping labels immediately
  5. Status Tracking: Monitor the parcel status via the Instabee API or dashboard

Size Limitations

Each delivery method has maximum size and weight limitations:

Delivery TypeMax Length (cm)Max Width (cm)Max Height (cm)Max Weight (kg)
Locker - Small39395920
Home Delivery120XX (max total 300cm girth)20

Exceeding these limitations may result in additional charges or delivery refusal.

Command Palette

Search for a command to run...