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 pickup. For Locker Light, you have two options at this stage:

  • Option 1 — Use our label: Create the order using the special sortCode from the availability response. We will return a label URL with the correct sort code already printed.
  • Option 2 — Use your own label: Before calling Post Packing, call the Resolve sortCode endpoint first. This returns the real sortCode representing the actual delivery locker. Use this on both your label and in the Post Packing request.

Create Order API (Post Packing)

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 parcel is packed and ready for pickup

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

Request Body

ParameterTypeRequiredDescriptionConstraintsComment
parcelPackingConfirmedbooleanrequiredConfirm parcel is packed and ready for pickupCan be set to false, and order can be updated unlimited amount of times. If omitted then we will default to packing confirmed if we have a post purchase order.
brandstringoptionalDefine brand of the delivery options.instabox or budbee
productstringrequiredDefine the product of the delivery optionsMust be oneLOCKER_AREA
availabilityTokenstringrequiredAvailability token from availability responseCan be optional if agreed with your Implementation Manager
orderIdstringoptionalUnique order reference for subsequent calls. This is returned in the post purchase response
parcelIdstringoptionalUnique identifier/barcode for parcelAuto-generated if omitted
merchantBrandIdstringoptionalMerchant brand identifierThis is a feature to use multiple brands without using multiple credentials. Needs to be configured if used. Talk to your Implementation Manager
communicationNamestringoptionalCommunication name overrideNote! This will only change the name in Instabee communication such as notifications, SMS or email. Will not change partner name in our partner portal nor change any specs on invoices
recipientobjectrequiredRecipient information object
dispatchobjectoptionalDispatch readiness and warehouse
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

sortCode

ParameterTypeRequiredDescriptionComment
sortCodestringrequiredTemporary sort code received from the Availability API. Send at the top level of the request body — do not wrap in a deliveryOption object.Must be sent exactly as received, do not truncate

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
collectionPointIdstringoptionalSpecific warehouse/pickup pointConfigured by Instabee
returnPointIdstringoptionalNot yet implemented. Return address point IDFor failed deliveries

additionalServices

ParameterTypeRequiredDescription
identificationobjectoptionalIdentity verification requirements

additionalServices.identification

ParameterTypeRequiredDescriptionConstraintsComment
typestringoptionalType of verification"age_limit", "age_limit_at_handover", "specific_person", "specific_person_at_handover" "any_person"Age veritification and specific person is currently only live in Sweden. Any person verification is live in Sweden, Denmark, Norway
ageLimitnumberoptionalMinimum age requiredUsed with age_limit types
ssnstringoptionalRequired SSN for verification
namestringoptionalRequired name for verification
type explanations
TypeDescription
age_limitVerify the consumer age. This verification will be triggered when the parcel is created. Only live with Swedish BankID
age_limit_at_handoverVerify the consumer age when they pickup the parcel (at handover). Only live with Swedish BankID
specific_personVerify the consumer identify by matching SSN sent on the order with the SSN from the verification. Only live with Swedish BankID
specific_person_at_handoverVerify the consumer identify by matching SSN sent on the order with the SSN from the verification when they pickup the parcel (at handover). Only live with Swedish BankID
any_personVerify the consumer identify by matching doing a BankID or NemID verification. Currently live in Sweden, Denmark and Norway

cart

ParameterTypeRequiredDescriptionComment
checkoutIdstringoptionalCheckout session IDUsed as a link in Instabee system
orderNumberstringrequired*Your order numberUsed as a link in Instabee system
totalValueInCentsnumberoptionalTotal order value in centsThis helps us with claims process
totalWeightGramnumberoptionalTotal weight in gramsThis helps us with claims process
parcelobjectoptionalParcel dimensions and contentsDetailed parcel information

cart.parcel

ParameterTypeRequiredDescriptionConstraintsComment
heightMmnumberoptionalParcel height in mmIf you do not have this data, do not send anything
widthMmnumberoptionalParcel width in mmIf you do not have this data, do not send anything
lengthMmnumberoptionalParcel length in mmIf you do not have this data, do not send anything
volumeDm3numberoptionalParcel volume in dm³If you do not have this data, do not send anything
estimatedSizestringoptionalEstimated size category"small", "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 8. Temperature in Celsius
maxnumberoptionalMaximum 15. Temperature in Celsius

cart.parcel.products[]

ParameterTypeRequiredDescription
packagesarrayoptionalPhysical package information

cart.parcel.products[].packages[]

ParameterTypeRequiredDescriptionComment
widthMmnumberoptionalPackage width in mmIf you do not have this data, do not send anything
heightMmnumberoptionalPackage height in mmIf you do not have this data, do not send anything
lengthMmnumberoptionalPackage length in mmIf you do not have this data, do not send anything
weightMmnumberoptionalPackage weightIf you do not have this data, do not send anything
volumeDm3numberoptionalPackage volume in mm³If you do not have this data, do not send anything
barcodesarrayoptionalBarcode informationIf you do not have this data, do not send anything

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

ParameterTypeRequiredDescriptionConstraints
codestringoptionalBarcode value
typestringoptionalBarcode type"ean13", etc.

Response

The API returns an updated parcel object with:

FieldTypeDescription
orderIdstringThe Instabee order ID
parcelIdstringThe parcel ID
statestringUpdated status ("FINALIZED" after packing confirmation)
attributesobjectAdditional attributes including the resolved label code

links (object)

FieldTypeDescription
labelstringURL to download the shipping label (contains the correct sort code)
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

attributes (object)

FieldTypeDescription
labelCodestringThe resolved label code (e.g., "IN30")

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

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

Quick Links

Command Palette

Search for a command to run...