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

Instabee API

Create Parcel - Post Packing API

Complete parameter reference for confirming parcels in the Post Packing flow. This API confirms that a parcel has been physically packed and is ready for pickup and delivery.

API Endpoint

MethodEndpointContent-Type
PUTapi.integration.instabee.com/orders (production)
sandbox-api.integration.instabee.com/orders (sandbox)
application/json

Integration Levels

You can integrate at different levels depending on your workflow:

Bare Minimum Integration

If everything was sent in the Post Purchase call, you only need:

{
  "availabilityToken": "b4a9c200-c02a-4186-b3e8-6271a0be2190",
  "parcelPackingConfirmed": true
}

Minimum Integration

Basic confirmation with essential parcel details:

{
  "parcelId": "PREFIX1234567890",
  "brand": "instabox",
  "product": "LOCKER_EXPRESS",
  "parcelPackingConfirmed": true,
  "recipient": {
    "name": "Test Testsson",
    "email": "test@instabee.com",
    "phone": "0701234567",
    "street": "Hälsingegatan 40",
    "street2": "Floor 10",
    "postalCode": "12345",
    "city": "Stockholm",
    "countryCode": "SE"
  },
  "deliveryOption": {
    "sort_code": "IN123"
  },
  "cart": {
    "orderNumber": "12345"
  }
}

Root Parameters

ParameterTypeRequiredDescriptionExample
parcelPackingConfirmedbooleanrequiredConfirms that the parcel has been packed and is ready for pickuptrue
availabilityTokenstringconditionalToken from Availability API or Post Purchase response"b4a9c200-c02a-4186-b3e8-6271a0be2190"
parcelIdstringconditionalParcel identifier from Post Purchase response"PREFIX1234567890"
brandstringconditionalDelivery brand (required if not sent in Post Purchase)"instabox", "budbee"
productstringconditionalProduct type for delivery (required if not sent in Post Purchase)"LOCKER_EXPRESS", "LOCKER_RETURN", "HOME_DELIVERY", "LOCKER_CAPACITY_SURPLUS", "LOCKER_ALLOCATION", "LOCKER_AREA"

LOCKER_RETURN Parameters

The following parameters are specific to the LOCKER_RETURN product type. For locker returns, parcelPackingConfirmed should always be set to true as the order is sent as completed.

ParameterTypeRequiredDescriptionExample
isLabellessbooleanoptionalIndicates if the return is labelless. When true, the consumer does not need to attach a label to the parcel. When false or omitted, a label is expected to be attached by the consumer.true
associatedParcelIdstringoptionalThe parcel ID of the outbound delivery. When provided, the return order will not be created until the outbound parcel has been delivered. If omitted, the order is treated as a standalone return order."PREFIX1234567890"

Example: LOCKER_RETURN with Associated Parcel

{
  "parcelId": "PREFIX1234567891",
  "brand": "instabox",
  "product": "LOCKER_RETURN",
  "parcelPackingConfirmed": true,
  "isLabelless": true,
  "associatedParcelId": "PREFIX1234567890",
  "sender": {
    "name": "Test Testsson",
    "email": "test@instabee.com",
    "phone": "0701234567",
    "street": "Hälsingegatan 40",
    "postalCode": "12345",
    "city": "Stockholm",
    "countryCode": "SE"
  },
  "deliveryOption": {
    "sort_code": "IN123"
  },
  "cart": {
    "orderNumber": "12345"
  }
}

Parcel Dimensions (Optional)

If the actual dimensions differ from your initial estimates, you can update them:

ParameterTypeRequiredDescriptionExample
cart.parcel.heightMmnumberoptionalFinal height in centimeters10
cart.parcel.widthMmnumberoptionalFinal width in centimeters10
cart.parcel.lengthMmnumberoptionalFinal length in centimeters10
cart.parcel.weightGramnumberoptionalFinal weight in grams2000
cart.parcel.volumeDm3numberoptionalFinal volume in liters1

Response

The Post Packing API response includes:

  • Shipping Labels - Download URLs for shipping labels
  • Pickup Information - When and where the parcel will be collected
  • Tracking Information - Tracking numbers and status updates
  • Delivery Details - Final delivery information for the customer

Next Steps

Command Palette

Search for a command to run...