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

Instabee API

Create Locker to Locker Order

This endpoint creates a consumer-to-consumer order. The sender drops off the parcel at their chosen locker, and Instabee delivers it to the recipient's chosen locker. Both the sender's drop-off locker (dropOffDeliveryOption) and the recipient's delivery locker (deliveryOption) are required, with their respective sortCode values from the availability call. Parcel dimensions are required for all Locker to Locker orders.

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:

  • Minimum: Basic confirmation with essential parcel details
  • Maximum: Complete order details with final dimensions and product information

Request Body

ParameterTypeRequiredDescriptionConstraintsEnumComment
brandstringoptionalDefine brand of the delivery options.instabox or budbee
productstringrequiredDefine the product of the delivery optionsMust be oneLOCKER_TO_LOCKER
parcelPackingConfirmedbooleanrequiredConfirm parcel is packed and ready for pickupmust be trueOrder is created and confirmed in a single call
availabilityTokenstringoptionalAvailability token from the recipient availability responseCan be optional if agreed with your Implementation Manager
senderAvailabilityTokenstringoptionalAvailability token from the sender (drop-off) availability responseCan be optional if agreed with your Implementation Manager
parcelIdstringoptionalUnique identifier/barcode for parcelAuto-generated if omitted
communicationNamestringoptionalCommunication name overrideNote! This will only change the name in Instabee communication such as notifications, SMS or email for locker deliveries. Will not change partner name in our partner portal nor change any specs on invoices
senderobjectrequiredSender (consumer) information object
recipientobjectoptionalRecipient (merchant) information object. Will default to configuration
dropOffDeliveryOptionobjectrequired*The selected locker from checkout. Can be discussed to sent as empty with your Implementation Manager
deliveryOptionobjectrequired*The selected locker from checkout.
dispatchobjectoptionalReturn warehouse information
cartobjectrequired*Parcel and/or product details. Size of parcel is required for returns

sender

ParameterTypeRequiredDescriptionConstraintsEnumComment
namestringrequiredSender name
emailstringrequiredSender email addressValid email formatUsed for delivery notifications
phonestringrequiredSender phone numberBox: Min 6 digits, Home delivery: Min 10 digits, Max 15 digitsCan be made optional with setting
ssnstringoptionalSocial security numberFor age verification services
streetstringrequiredSender street address
street2stringoptionalAdditional address informationFloor, apartment, etc.
postalCodestringrequiredSender postal code
citystringrequiredSender city
countryCodestringrequiredSender country codeISO 3166 alpha 2BE, DK, FI, NL, NO, SE
coordinatesobjectoptionalGPS coordinatesFor precise location

recipient

ParameterTypeRequiredDescriptionConstraintsEnumComment
namestringrequiredRecipient name
emailstringrequiredRecipient email addressValid email formatUsed for delivery notifications
phonestringrequiredRecipient phone numberBox: Min 6 digits, Home delivery: Min 10 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 2BE, DK, FI, NL, NO, SE
coordinatesobjectoptionalGPS coordinatesFor precise location

dropOffDeliveryOption

ParameterTypeRequiredDescriptionEnumComment
sortCodestringrequiredSort code for the dropoff lockerIdentifies the specific locker

deliveryOption

ParameterTypeRequiredDescriptionEnumComment
sortCodestringrequiredSort code for the dropoff lockerIdentifies the specific locker

dispatch

ParameterTypeRequiredDescriptionEnumComment
returnPointIdstringoptionalNot yet implemented. Return address point IDFor failed deliveries

cart

ParameterTypeRequiredDescriptionEnumComment
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
totalWeightInGramsnumberoptionalTotal weight in gramsThis helps us with claims process
parcelobjectrequiredParcel dimensions and contentsDetailed parcel information

cart.parcel

ParameterTypeRequiredDescriptionEnumComment
heightMmnumberrequiredParcel height in mmIf you do not have this data, do not send anything
widthMmnumberrequiredParcel width in mmIf you do not have this data, do not send anything
lengthMmnumberrequiredParcel 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 of the parcel. The sizes will be configured together with InstabeeSMALL, LARGE, TOOLARGE
weightGramnumberoptionalParcel weight in grams
typestringoptionalParcel typeBOX, BAG
productsarrayoptionalArray of products in parcelDetailed product information

cart.parcel.products[]

ParameterTypeRequiredDescriptionEnumComment
namestringoptionalProduct name
quantitystringoptionalQuantity of this productSent as a string, not a number
productIdstringoptionalYour product identifier
detailsobjectoptionalDetailed product information
temperatureobjectoptionalTemperature requirements for the product
packagesarrayoptionalPhysical packages the product is shipped in

cart.parcel.products[].details

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

cart.parcel.products[].details.price

ParameterTypeRequiredDescriptionConstraintsEnumComment
priceInCentsnumberoptionalPrice in cents
taxValueInCentsnumberoptionalTax amount in cents
discountRateInCentsnumberoptionalDiscount amount in cents
currencystringoptionalCurrency codeISO 4217e.g., "SEK"

cart.parcel.products[].temperature

ParameterTypeRequiredDescriptionEnum
minnumberoptionalMinimum 8. Temperature in Celsius
maxnumberoptionalMaximum 15. Temperature in Celsius

cart.parcel.products[].packages[]

ParameterTypeRequiredDescriptionEnumComment
widthMmstringoptionalPackage width in mmIf you do not have this data, do not send anything
heightMmstringoptionalPackage height in mmIf you do not have this data, do not send anything
lengthMmstringoptionalPackage length in mmIf you do not have this data, do not send anything
weightGramstringoptionalPackage weight in gramsIf you do not have this data, do not send anything
volumeDm3stringoptionalPackage volume in dm³ (liters)If you do not have this data, do not send anything
barcodesobjectoptionalBarcode object for the packageSingle object, not an array

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

ParameterTypeRequiredDescriptionEnum
codestringoptionalBarcode value
typestringoptionalThe barcode typeEAN13

Response

The create-order API returns the order and parcel identifiers needed to continue the flow.

FieldTypeDescription
orderIdstringThe Instabee order ID — save it, you need it to fetch the tracking links
parcelIdstringThe Instabee parcel ID
statestringParcel state (e.g. "FINALIZED")

links (object)

FieldTypeDescription
trackingstringPreliminary tracking URL — see the note below

The create-order response does not contain the sender and recipient tracking links. It only contains a preliminary tracking link, which is generated before the parcel exists in our tracking system and therefore does not resolve yet — opening it gives a broken link.

senderTracking and recipientTracking are generated once the full order has been sent with parcelPackingConfirmed: true. When they are ready they replace the preliminary tracking link in the Fetch Order response, so fetch them with Fetch Order using the orderId from this response.

Production: GET https://api.integration.instabee.com/orders/{orderId}

Sandbox: GET https://sandbox-api.integration.instabee.com/orders/{orderId}

Headers:

1Authorization: Bearer {token}

Example Fetch Order Response (masked)

1{
2	"orderId": "019f1d06-a091-756b-91cb-90e42f2e50d0",
3	"parcels": [
4		{
5			"orderId": "019f1d06-a091-756b-91cb-90e42f2e50d0",
6			"parcelId": "XX01000001230644",
7			"links": {
8				"recipientTracking": "https://budbee.com/s/we8K2mP",
9				"senderTracking": "https://budbee.com/s/sw4nQ9tL"
10			},
11			"state": "FINALIZED",
12			"product": "LOCKER_TO_LOCKER",
13			"brand": "BUDBEE",
14			"countryCode": "SE",
15			"recipient": {
16				"city": "Stockholm",
17				"countryCode": "SE",
18				"email": "recipient@example.com",
19				"name": "Anna Svensson",
20				"phone": "+46701234567",
21				"postalCode": "11327",
22				"street": "Upplandsgatan 42"
23			},
24			"sender": {
25				"city": "Stockholm",
26				"countryCode": "SE",
27				"email": "sender@example.com",
28				"name": "Erik Johansson",
29				"phone": "+46707654321",
30				"postalCode": "11157",
31				"street": "Sveavagen 10"
32			},
33			"deliveryOption": {
34				"sortCode": "IN456wOx9dJ"
35			}
36		}
37	]
38}

Read parcels[].links.recipientTracking and parcels[].links.senderTracking when present. Tracking links are only available for parcels in active/trackable states — a cancelled parcel has an empty links object.

See Fetch Tracking Links for the full flow.

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. 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.

Command Palette

Search for a command to run...