Raw schema
{
"type": "object",
"properties": {
"shipper_contact_name": {
"type": "string",
"description": "Business/shipper name shown to the courier. Optional โ defaults to the origin contact name."
},
"origin_contact_name": {
"type": "string",
"description": "Pickup contact person name. Required."
},
"origin_contact_phone": {
"type": "string",
"description": "Pickup contact phone (Indonesian number). Required."
},
"origin_address": {
"type": "string",
"description": "Full pickup street address. Required."
},
"origin_note": {
"type": "string",
"description": "Note for the courier at pickup. Optional."
},
"origin_postal_code": {
"type": "string",
"description": "Pickup 5-digit postal code. Provide this OR origin_area_id."
},
"origin_area_id": {
"type": "string",
"description": "Biteship area_id for the pickup location. Alternative to origin_postal_code."
},
"destination_contact_name": {
"type": "string",
"description": "Recipient name. Required."
},
"destination_contact_phone": {
"type": "string",
"description": "Recipient phone (Indonesian number). Required."
},
"destination_contact_email": {
"type": "string",
"description": "Recipient email. Optional."
},
"destination_address": {
"type": "string",
"description": "Full recipient street address. Required."
},
"destination_note": {
"type": "string",
"description": "Delivery note for the courier. Optional."
},
"destination_postal_code": {
"type": "string",
"description": "Recipient 5-digit postal code. Provide this OR destination_area_id."
},
"destination_area_id": {
"type": "string",
"description": "Biteship area_id for the recipient. Alternative to destination_postal_code."
},
"courier_company": {
"type": "string",
"description": "Courier code from check_rates (courier_code), e.g. \"jne\", \"jnt\", \"sicepat\", \"anteraja\", \"gojek\", \"grab\". Required."
},
"courier_type": {
"type": "string",
"description": "Courier service type from check_rates (courier_service_code), e.g. \"reg\", \"yes\", \"instant\", \"same_day\". Required."
},
"delivery_type": {
"type": "string",
"description": "\"now\" (immediate pickup, default) or \"scheduled\" (with delivery_date + delivery_time)."
},
"delivery_date": {
"type": "string",
"description": "Scheduled pickup date \"YYYY-MM-DD\" (only when delivery_type=scheduled)."
},
"delivery_time": {
"type": "string",
"description": "Scheduled pickup time \"HH:mm\" (only when delivery_type=scheduled)."
},
"order_note": {
"type": "string",
"description": "Free-text note for the whole order. Optional."
},
"reference_id": {
"type": "string",
"description": "Your own order reference (any unique string). Optional."
},
"destination_cash_on_delivery": {
"type": "number",
"description": "COD amount to collect in IDR. Optional โ omit for prepaid."
},
"courier_insurance": {
"type": "number",
"description": "Declared insurance amount in IDR. Optional."
},
"items": {
"type": "array",
"description": "Parcel line items. At least one. Each: { name (required), value (required, IDR), weight (required, GRAMS), quantity (required int), description?, sku?, length?/width?/height? (cm) }.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Product name."
},
"description": {
"type": "string",
"description": "Item description. Optional."
},
"sku": {
"type": "string",
"description": "Stock keeping unit / product code. Optional."
},
"value": {
"type": "number",
"description": "Item value in IDR. Required (used for insurance/COD and the owner policy gate)."
},
"weight": {
"type": "number",
"description": "Item weight in GRAMS (g). Required."
},
"quantity": {
"type": "number",
"description": "Quantity (integer >= 1). Required."
},
"length": {
"type": "number",
"description": "Item length in CENTIMETRES (cm). Optional."
},
"width": {
"type": "number",
"description": "Item width in CENTIMETRES (cm). Optional."
},
"height": {
"type": "number",
"description": "Item height in CENTIMETRES (cm). Optional."
}
},
"required": [
"name",
"value",
"weight",
"quantity"
]
}
}
},
"required": [
"origin_contact_name",
"origin_contact_phone",
"origin_address",
"destination_contact_name",
"destination_contact_phone",
"destination_address",
"courier_company",
"courier_type",
"items"
]
}