Developer Centre > API References > Book Pickup

Starshipit

API change history

Book Pickup

Book pickup - notify a courier that you have one or more packages to be collected

Try it

Request URL


Request headers

string

Api key in your Starshipit account under Settings > API Key

(optional)
string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Profile.

Request body

{
  "order_reference": "2009",
  "tracking_number": "CPAHMIZ0005207001",
  "carrier_name": "CouriersPlease",
  "use_staging": true,
  "pickup_timeslot_start": "2020-04-30T22:47:02.543724+00:00",
  "collection_address": {
    "company_name": "Test Company",
    "contact_name": "John Smith",
    "contact_email": "john.smith@test.courierpickup.com.au",
    "contact_phone": "123412341234",
    "address_line1": "1508 Centre Rd",
    "address_line2": "Building 1",
    "address_line3": "Clayton Business Park",
    "postcode": "3169",
    "suburb": "CLAYTON"
  },
  "receiver_address": {
    "company_name": "Another Company",
    "contact_phone": "33334444",
    "address_line1": "147 Bourke Street",
    "address_line2": "Level 1",
    "postcode": "3000",
    "suburb": "MELBOURNE"
  },
  "dangerous_goods": false,
  "package_count": 2,
  "consignment_count": 1,
  "total_weight": 0.1,
  "max_package_length": 0,
  "max_package_width": 0,
  "max_package_height": 0,
  "max_package_weight": 0
}
{
  "required": [
    "carrier_name"
  ],
  "type": "object",
  "properties": {
    "order_reference": {
      "description": "Used to identify the order in the user's system",
      "type": "string"
    },
    "tracking_number": {
      "description": "The tracking number, consignment number or barcode of the order",
      "type": "string"
    },
    "carrier_name": {
      "description": "Name of the carrier used for shipment pickup and  delivery",
      "type": "string"
    },
    "use_staging": {
      "description": "Flag to indicate whether to call the carrier's staging or production api",
      "type": "boolean"
    },
    "sender_account": {
      "description": "The account that is held with the target carrier",
      "type": "string"
    },
    "receiver_account": {
      "description": "The account that is held with the target carrier by the receiver\r\nUsed when payer is receiver",
      "type": "string"
    },
    "pickup_timeslot_start": {
      "format": "date-time",
      "description": "Earliest time the order can be picked up in UTC",
      "type": "string"
    },
    "pickup_timeslot_end": {
      "format": "date-time",
      "description": "Latest time the order can be picked up in UTC (ignored by some carriers)",
      "type": "string"
    },
    "special_instructions": {
      "description": "Any pickup instructions eg \"Use side door\"",
      "type": "string"
    },
    "sender_address": {
      "type": "object",
      "properties": {
        "company_name": {
          "description": "The name of the company at the relevant address",
          "type": "string"
        },
        "contact_name": {
          "description": "The name of the contact person at the relevant address",
          "type": "string"
        },
        "contact_email": {
          "description": "The email address of the contact person at the relevant address",
          "type": "string"
        },
        "contact_phone_area_code": {
          "description": "The area code for the contact phone number at the relevant address",
          "type": "string"
        },
        "contact_phone": {
          "description": "The phone number for the contact at the relevant address",
          "type": "string"
        },
        "address_line1": {
          "description": "First address line of the elevant address",
          "type": "string"
        },
        "address_line2": {
          "description": "Second address line of the elevant address",
          "type": "string"
        },
        "address_line3": {
          "description": "Third address line of the elevant address",
          "type": "string"
        },
        "postcode": {
          "description": "The postcode of the elevant address",
          "type": "string"
        },
        "suburb": {
          "description": "The suburb of the elevant address",
          "type": "string"
        },
        "state": {
          "description": "The state code of the relevant address",
          "type": "string"
        }
      },
      "description": "The address where the order is being sent from"
    },
    "collection_address": {
      "type": "object",
      "properties": {
        "company_name": {
          "description": "The name of the company at the relevant address",
          "type": "string"
        },
        "contact_name": {
          "description": "The name of the contact person at the relevant address",
          "type": "string"
        },
        "contact_email": {
          "description": "The email address of the contact person at the relevant address",
          "type": "string"
        },
        "contact_phone_area_code": {
          "description": "The area code for the contact phone number at the relevant address",
          "type": "string"
        },
        "contact_phone": {
          "description": "The phone number for the contact at the relevant address",
          "type": "string"
        },
        "address_line1": {
          "description": "First address line of the elevant address",
          "type": "string"
        },
        "address_line2": {
          "description": "Second address line of the elevant address",
          "type": "string"
        },
        "address_line3": {
          "description": "Third address line of the elevant address",
          "type": "string"
        },
        "postcode": {
          "description": "The postcode of the elevant address",
          "type": "string"
        },
        "suburb": {
          "description": "The suburb of the elevant address",
          "type": "string"
        },
        "state": {
          "description": "The state code of the relevant address",
          "type": "string"
        }
      },
      "description": "The address where the order is being collected from"
    },
    "receiver_address": {
      "type": "object",
      "properties": {
        "company_name": {
          "description": "The name of the company at the relevant address",
          "type": "string"
        },
        "contact_name": {
          "description": "The name of the contact person at the relevant address",
          "type": "string"
        },
        "contact_email": {
          "description": "The email address of the contact person at the relevant address",
          "type": "string"
        },
        "contact_phone_area_code": {
          "description": "The area code for the contact phone number at the relevant address",
          "type": "string"
        },
        "contact_phone": {
          "description": "The phone number for the contact at the relevant address",
          "type": "string"
        },
        "address_line1": {
          "description": "First address line of the elevant address",
          "type": "string"
        },
        "address_line2": {
          "description": "Second address line of the elevant address",
          "type": "string"
        },
        "address_line3": {
          "description": "Third address line of the elevant address",
          "type": "string"
        },
        "postcode": {
          "description": "The postcode of the elevant address",
          "type": "string"
        },
        "suburb": {
          "description": "The suburb of the elevant address",
          "type": "string"
        },
        "state": {
          "description": "The state code of the relevant address",
          "type": "string"
        }
      },
      "description": "The address where the order is to be delivered"
    },
    "packaging_code": {
      "description": "Packaging code for the order being picked up e.g. Satchel, Bag, Carton",
      "type": "string"
    },
    "service_code": {
      "description": "Service code for the order being picked up",
      "type": "string"
    },
    "dangerous_goods": {
      "description": "Indicates if the shipment contains dangerous goods",
      "type": "boolean"
    },
    "dangerous_goods_un": {
      "description": "UN related to dangerous goods",
      "type": "string"
    },
    "dangerous_goods_packing_group": {
      "description": "Packing group related to dangerous goods",
      "type": "string"
    },
    "payer": {
      "description": "Who is paying for delivery of the order - Sender or Receiver",
      "type": "string"
    },
    "package_count": {
      "format": "int32",
      "description": "Total number of packages being collected",
      "pattern": "^\\d+$",
      "type": "integer"
    },
    "consignment_count": {
      "format": "int32",
      "description": "Total number of consignments being collected",
      "pattern": "^\\d+$",
      "type": "integer"
    },
    "total_weight": {
      "format": "double",
      "description": "Total combined weight of packages being collected",
      "pattern": "^[0-9]\\d*(\\.\\d+)?$",
      "type": "number"
    },
    "max_package_length": {
      "format": "double",
      "description": "Length of the largest package in cm",
      "pattern": "^[0-9]\\d*(\\.\\d+)?$",
      "type": "number"
    },
    "max_package_width": {
      "format": "double",
      "description": "Width of the largest package in cm",
      "pattern": "^[0-9]\\d*(\\.\\d+)?$",
      "type": "number"
    },
    "max_package_height": {
      "format": "double",
      "description": "Height of the largest package in cm",
      "pattern": "^[0-9]\\d*(\\.\\d+)?$",
      "type": "number"
    },
    "max_package_weight": {
      "format": "double",
      "description": "Weight of the largest package in kg",
      "pattern": "^[0-9]\\d*(\\.\\d+)?$",
      "type": "number"
    }
  },
  "example": {
    "order_reference": "2009",
    "tracking_number": "CPAHMIZ0005207001",
    "carrier_name": "CouriersPlease",
    "use_staging": true,
    "pickup_timeslot_start": "2020-04-30T22:47:02.543724Z",
    "collection_address": {
      "company_name": "Test Company",
      "contact_name": "John Smith",
      "contact_email": "john.smith@test.courierpickup.com.au",
      "contact_phone": "123412341234",
      "address_line1": "1508 Centre Rd",
      "address_line2": "Building 1",
      "address_line3": "Clayton Business Park",
      "postcode": "3169",
      "suburb": "CLAYTON"
    },
    "receiver_address": {
      "company_name": "Another Company",
      "contact_phone": "33334444",
      "address_line1": "147 Bourke Street",
      "address_line2": "Level 1",
      "postcode": "3000",
      "suburb": "MELBOURNE"
    },
    "dangerous_goods": false,
    "package_count": 2,
    "consignment_count": 1,
    "total_weight": 0.1,
    "max_package_length": 0,
    "max_package_width": 0,
    "max_package_height": 0,
    "max_package_weight": 0
  }
}
{
  "order_reference": "2009",
  "tracking_number": "CPAHMIZ0005207001",
  "carrier_name": "CouriersPlease",
  "use_staging": true,
  "pickup_timeslot_start": "2020-04-30T22:47:02.543724+00:00",
  "collection_address": {
    "company_name": "Test Company",
    "contact_name": "John Smith",
    "contact_email": "john.smith@test.courierpickup.com.au",
    "contact_phone": "123412341234",
    "address_line1": "1508 Centre Rd",
    "address_line2": "Building 1",
    "address_line3": "Clayton Business Park",
    "postcode": "3169",
    "suburb": "CLAYTON"
  },
  "receiver_address": {
    "company_name": "Another Company",
    "contact_phone": "33334444",
    "address_line1": "147 Bourke Street",
    "address_line2": "Level 1",
    "postcode": "3000",
    "suburb": "MELBOURNE"
  },
  "dangerous_goods": false,
  "package_count": 2,
  "consignment_count": 1,
  "total_weight": 0.1,
  "max_package_length": 0,
  "max_package_width": 0,
  "max_package_height": 0,
  "max_package_weight": 0
}
{
  "required": [
    "carrier_name"
  ],
  "type": "object",
  "properties": {
    "order_reference": {
      "description": "Used to identify the order in the user's system",
      "type": "string"
    },
    "tracking_number": {
      "description": "The tracking number, consignment number or barcode of the order",
      "type": "string"
    },
    "carrier_name": {
      "description": "Name of the carrier used for shipment pickup and  delivery",
      "type": "string"
    },
    "use_staging": {
      "description": "Flag to indicate whether to call the carrier's staging or production api",
      "type": "boolean"
    },
    "sender_account": {
      "description": "The account that is held with the target carrier",
      "type": "string"
    },
    "receiver_account": {
      "description": "The account that is held with the target carrier by the receiver\r\nUsed when payer is receiver",
      "type": "string"
    },
    "pickup_timeslot_start": {
      "format": "date-time",
      "description": "Earliest time the order can be picked up in UTC",
      "type": "string"
    },
    "pickup_timeslot_end": {
      "format": "date-time",
      "description": "Latest time the order can be picked up in UTC (ignored by some carriers)",
      "type": "string"
    },
    "special_instructions": {
      "description": "Any pickup instructions eg \"Use side door\"",
      "type": "string"
    },
    "sender_address": {
      "type": "object",
      "properties": {
        "company_name": {
          "description": "The name of the company at the relevant address",
          "type": "string"
        },
        "contact_name": {
          "description": "The name of the contact person at the relevant address",
          "type": "string"
        },
        "contact_email": {
          "description": "The email address of the contact person at the relevant address",
          "type": "string"
        },
        "contact_phone_area_code": {
          "description": "The area code for the contact phone number at the relevant address",
          "type": "string"
        },
        "contact_phone": {
          "description": "The phone number for the contact at the relevant address",
          "type": "string"
        },
        "address_line1": {
          "description": "First address line of the elevant address",
          "type": "string"
        },
        "address_line2": {
          "description": "Second address line of the elevant address",
          "type": "string"
        },
        "address_line3": {
          "description": "Third address line of the elevant address",
          "type": "string"
        },
        "postcode": {
          "description": "The postcode of the elevant address",
          "type": "string"
        },
        "suburb": {
          "description": "The suburb of the elevant address",
          "type": "string"
        },
        "state": {
          "description": "The state code of the relevant address",
          "type": "string"
        }
      },
      "description": "The address where the order is being sent from"
    },
    "collection_address": {
      "type": "object",
      "properties": {
        "company_name": {
          "description": "The name of the company at the relevant address",
          "type": "string"
        },
        "contact_name": {
          "description": "The name of the contact person at the relevant address",
          "type": "string"
        },
        "contact_email": {
          "description": "The email address of the contact person at the relevant address",
          "type": "string"
        },
        "contact_phone_area_code": {
          "description": "The area code for the contact phone number at the relevant address",
          "type": "string"
        },
        "contact_phone": {
          "description": "The phone number for the contact at the relevant address",
          "type": "string"
        },
        "address_line1": {
          "description": "First address line of the elevant address",
          "type": "string"
        },
        "address_line2": {
          "description": "Second address line of the elevant address",
          "type": "string"
        },
        "address_line3": {
          "description": "Third address line of the elevant address",
          "type": "string"
        },
        "postcode": {
          "description": "The postcode of the elevant address",
          "type": "string"
        },
        "suburb": {
          "description": "The suburb of the elevant address",
          "type": "string"
        },
        "state": {
          "description": "The state code of the relevant address",
          "type": "string"
        }
      },
      "description": "The address where the order is being collected from"
    },
    "receiver_address": {
      "type": "object",
      "properties": {
        "company_name": {
          "description": "The name of the company at the relevant address",
          "type": "string"
        },
        "contact_name": {
          "description": "The name of the contact person at the relevant address",
          "type": "string"
        },
        "contact_email": {
          "description": "The email address of the contact person at the relevant address",
          "type": "string"
        },
        "contact_phone_area_code": {
          "description": "The area code for the contact phone number at the relevant address",
          "type": "string"
        },
        "contact_phone": {
          "description": "The phone number for the contact at the relevant address",
          "type": "string"
        },
        "address_line1": {
          "description": "First address line of the elevant address",
          "type": "string"
        },
        "address_line2": {
          "description": "Second address line of the elevant address",
          "type": "string"
        },
        "address_line3": {
          "description": "Third address line of the elevant address",
          "type": "string"
        },
        "postcode": {
          "description": "The postcode of the elevant address",
          "type": "string"
        },
        "suburb": {
          "description": "The suburb of the elevant address",
          "type": "string"
        },
        "state": {
          "description": "The state code of the relevant address",
          "type": "string"
        }
      },
      "description": "The address where the order is to be delivered"
    },
    "packaging_code": {
      "description": "Packaging code for the order being picked up e.g. Satchel, Bag, Carton",
      "type": "string"
    },
    "service_code": {
      "description": "Service code for the order being picked up",
      "type": "string"
    },
    "dangerous_goods": {
      "description": "Indicates if the shipment contains dangerous goods",
      "type": "boolean"
    },
    "dangerous_goods_un": {
      "description": "UN related to dangerous goods",
      "type": "string"
    },
    "dangerous_goods_packing_group": {
      "description": "Packing group related to dangerous goods",
      "type": "string"
    },
    "payer": {
      "description": "Who is paying for delivery of the order - Sender or Receiver",
      "type": "string"
    },
    "package_count": {
      "format": "int32",
      "description": "Total number of packages being collected",
      "pattern": "^\\d+$",
      "type": "integer"
    },
    "consignment_count": {
      "format": "int32",
      "description": "Total number of consignments being collected",
      "pattern": "^\\d+$",
      "type": "integer"
    },
    "total_weight": {
      "format": "double",
      "description": "Total combined weight of packages being collected",
      "pattern": "^[0-9]\\d*(\\.\\d+)?$",
      "type": "number"
    },
    "max_package_length": {
      "format": "double",
      "description": "Length of the largest package in cm",
      "pattern": "^[0-9]\\d*(\\.\\d+)?$",
      "type": "number"
    },
    "max_package_width": {
      "format": "double",
      "description": "Width of the largest package in cm",
      "pattern": "^[0-9]\\d*(\\.\\d+)?$",
      "type": "number"
    },
    "max_package_height": {
      "format": "double",
      "description": "Height of the largest package in cm",
      "pattern": "^[0-9]\\d*(\\.\\d+)?$",
      "type": "number"
    },
    "max_package_weight": {
      "format": "double",
      "description": "Weight of the largest package in kg",
      "pattern": "^[0-9]\\d*(\\.\\d+)?$",
      "type": "number"
    }
  },
  "example": {
    "order_reference": "2009",
    "tracking_number": "CPAHMIZ0005207001",
    "carrier_name": "CouriersPlease",
    "use_staging": true,
    "pickup_timeslot_start": "2020-04-30T22:47:02.543724Z",
    "collection_address": {
      "company_name": "Test Company",
      "contact_name": "John Smith",
      "contact_email": "john.smith@test.courierpickup.com.au",
      "contact_phone": "123412341234",
      "address_line1": "1508 Centre Rd",
      "address_line2": "Building 1",
      "address_line3": "Clayton Business Park",
      "postcode": "3169",
      "suburb": "CLAYTON"
    },
    "receiver_address": {
      "company_name": "Another Company",
      "contact_phone": "33334444",
      "address_line1": "147 Bourke Street",
      "address_line2": "Level 1",
      "postcode": "3000",
      "suburb": "MELBOURNE"
    },
    "dangerous_goods": false,
    "package_count": 2,
    "consignment_count": 1,
    "total_weight": 0.1,
    "max_package_length": 0,
    "max_package_width": 0,
    "max_package_height": 0,
    "max_package_weight": 0
  }
}
{
  "order_reference": "2009",
  "tracking_number": "CPAHMIZ0005207001",
  "carrier_name": "CouriersPlease",
  "use_staging": true,
  "pickup_timeslot_start": "2020-04-30T22:47:02.543724+00:00",
  "collection_address": {
    "company_name": "Test Company",
    "contact_name": "John Smith",
    "contact_email": "john.smith@test.courierpickup.com.au",
    "contact_phone": "123412341234",
    "address_line1": "1508 Centre Rd",
    "address_line2": "Building 1",
    "address_line3": "Clayton Business Park",
    "postcode": "3169",
    "suburb": "CLAYTON"
  },
  "receiver_address": {
    "company_name": "Another Company",
    "contact_phone": "33334444",
    "address_line1": "147 Bourke Street",
    "address_line2": "Level 1",
    "postcode": "3000",
    "suburb": "MELBOURNE"
  },
  "dangerous_goods": false,
  "package_count": 2,
  "consignment_count": 1,
  "total_weight": 0.1,
  "max_package_length": 0,
  "max_package_width": 0,
  "max_package_height": 0,
  "max_package_weight": 0
}
{
  "required": [
    "carrier_name"
  ],
  "type": "object",
  "properties": {
    "order_reference": {
      "description": "Used to identify the order in the user's system",
      "type": "string"
    },
    "tracking_number": {
      "description": "The tracking number, consignment number or barcode of the order",
      "type": "string"
    },
    "carrier_name": {
      "description": "Name of the carrier used for shipment pickup and  delivery",
      "type": "string"
    },
    "use_staging": {
      "description": "Flag to indicate whether to call the carrier's staging or production api",
      "type": "boolean"
    },
    "sender_account": {
      "description": "The account that is held with the target carrier",
      "type": "string"
    },
    "receiver_account": {
      "description": "The account that is held with the target carrier by the receiver\r\nUsed when payer is receiver",
      "type": "string"
    },
    "pickup_timeslot_start": {
      "format": "date-time",
      "description": "Earliest time the order can be picked up in UTC",
      "type": "string"
    },
    "pickup_timeslot_end": {
      "format": "date-time",
      "description": "Latest time the order can be picked up in UTC (ignored by some carriers)",
      "type": "string"
    },
    "special_instructions": {
      "description": "Any pickup instructions eg \"Use side door\"",
      "type": "string"
    },
    "sender_address": {
      "type": "object",
      "properties": {
        "company_name": {
          "description": "The name of the company at the relevant address",
          "type": "string"
        },
        "contact_name": {
          "description": "The name of the contact person at the relevant address",
          "type": "string"
        },
        "contact_email": {
          "description": "The email address of the contact person at the relevant address",
          "type": "string"
        },
        "contact_phone_area_code": {
          "description": "The area code for the contact phone number at the relevant address",
          "type": "string"
        },
        "contact_phone": {
          "description": "The phone number for the contact at the relevant address",
          "type": "string"
        },
        "address_line1": {
          "description": "First address line of the elevant address",
          "type": "string"
        },
        "address_line2": {
          "description": "Second address line of the elevant address",
          "type": "string"
        },
        "address_line3": {
          "description": "Third address line of the elevant address",
          "type": "string"
        },
        "postcode": {
          "description": "The postcode of the elevant address",
          "type": "string"
        },
        "suburb": {
          "description": "The suburb of the elevant address",
          "type": "string"
        },
        "state": {
          "description": "The state code of the relevant address",
          "type": "string"
        }
      },
      "description": "The address where the order is being sent from"
    },
    "collection_address": {
      "type": "object",
      "properties": {
        "company_name": {
          "description": "The name of the company at the relevant address",
          "type": "string"
        },
        "contact_name": {
          "description": "The name of the contact person at the relevant address",
          "type": "string"
        },
        "contact_email": {
          "description": "The email address of the contact person at the relevant address",
          "type": "string"
        },
        "contact_phone_area_code": {
          "description": "The area code for the contact phone number at the relevant address",
          "type": "string"
        },
        "contact_phone": {
          "description": "The phone number for the contact at the relevant address",
          "type": "string"
        },
        "address_line1": {
          "description": "First address line of the elevant address",
          "type": "string"
        },
        "address_line2": {
          "description": "Second address line of the elevant address",
          "type": "string"
        },
        "address_line3": {
          "description": "Third address line of the elevant address",
          "type": "string"
        },
        "postcode": {
          "description": "The postcode of the elevant address",
          "type": "string"
        },
        "suburb": {
          "description": "The suburb of the elevant address",
          "type": "string"
        },
        "state": {
          "description": "The state code of the relevant address",
          "type": "string"
        }
      },
      "description": "The address where the order is being collected from"
    },
    "receiver_address": {
      "type": "object",
      "properties": {
        "company_name": {
          "description": "The name of the company at the relevant address",
          "type": "string"
        },
        "contact_name": {
          "description": "The name of the contact person at the relevant address",
          "type": "string"
        },
        "contact_email": {
          "description": "The email address of the contact person at the relevant address",
          "type": "string"
        },
        "contact_phone_area_code": {
          "description": "The area code for the contact phone number at the relevant address",
          "type": "string"
        },
        "contact_phone": {
          "description": "The phone number for the contact at the relevant address",
          "type": "string"
        },
        "address_line1": {
          "description": "First address line of the elevant address",
          "type": "string"
        },
        "address_line2": {
          "description": "Second address line of the elevant address",
          "type": "string"
        },
        "address_line3": {
          "description": "Third address line of the elevant address",
          "type": "string"
        },
        "postcode": {
          "description": "The postcode of the elevant address",
          "type": "string"
        },
        "suburb": {
          "description": "The suburb of the elevant address",
          "type": "string"
        },
        "state": {
          "description": "The state code of the relevant address",
          "type": "string"
        }
      },
      "description": "The address where the order is to be delivered"
    },
    "packaging_code": {
      "description": "Packaging code for the order being picked up e.g. Satchel, Bag, Carton",
      "type": "string"
    },
    "service_code": {
      "description": "Service code for the order being picked up",
      "type": "string"
    },
    "dangerous_goods": {
      "description": "Indicates if the shipment contains dangerous goods",
      "type": "boolean"
    },
    "dangerous_goods_un": {
      "description": "UN related to dangerous goods",
      "type": "string"
    },
    "dangerous_goods_packing_group": {
      "description": "Packing group related to dangerous goods",
      "type": "string"
    },
    "payer": {
      "description": "Who is paying for delivery of the order - Sender or Receiver",
      "type": "string"
    },
    "package_count": {
      "format": "int32",
      "description": "Total number of packages being collected",
      "pattern": "^\\d+$",
      "type": "integer"
    },
    "consignment_count": {
      "format": "int32",
      "description": "Total number of consignments being collected",
      "pattern": "^\\d+$",
      "type": "integer"
    },
    "total_weight": {
      "format": "double",
      "description": "Total combined weight of packages being collected",
      "pattern": "^[0-9]\\d*(\\.\\d+)?$",
      "type": "number"
    },
    "max_package_length": {
      "format": "double",
      "description": "Length of the largest package in cm",
      "pattern": "^[0-9]\\d*(\\.\\d+)?$",
      "type": "number"
    },
    "max_package_width": {
      "format": "double",
      "description": "Width of the largest package in cm",
      "pattern": "^[0-9]\\d*(\\.\\d+)?$",
      "type": "number"
    },
    "max_package_height": {
      "format": "double",
      "description": "Height of the largest package in cm",
      "pattern": "^[0-9]\\d*(\\.\\d+)?$",
      "type": "number"
    },
    "max_package_weight": {
      "format": "double",
      "description": "Weight of the largest package in kg",
      "pattern": "^[0-9]\\d*(\\.\\d+)?$",
      "type": "number"
    }
  },
  "example": {
    "order_reference": "2009",
    "tracking_number": "CPAHMIZ0005207001",
    "carrier_name": "CouriersPlease",
    "use_staging": true,
    "pickup_timeslot_start": "2020-04-30T22:47:02.543724Z",
    "collection_address": {
      "company_name": "Test Company",
      "contact_name": "John Smith",
      "contact_email": "john.smith@test.courierpickup.com.au",
      "contact_phone": "123412341234",
      "address_line1": "1508 Centre Rd",
      "address_line2": "Building 1",
      "address_line3": "Clayton Business Park",
      "postcode": "3169",
      "suburb": "CLAYTON"
    },
    "receiver_address": {
      "company_name": "Another Company",
      "contact_phone": "33334444",
      "address_line1": "147 Bourke Street",
      "address_line2": "Level 1",
      "postcode": "3000",
      "suburb": "MELBOURNE"
    },
    "dangerous_goods": false,
    "package_count": 2,
    "consignment_count": 1,
    "total_weight": 0.1,
    "max_package_length": 0,
    "max_package_width": 0,
    "max_package_height": 0,
    "max_package_weight": 0
  }
}
{
  "order_reference": "2009",
  "tracking_number": "CPAHMIZ0005207001",
  "carrier_name": "CouriersPlease",
  "use_staging": true,
  "pickup_timeslot_start": "2020-04-30T22:47:02.543724+00:00",
  "collection_address": {
    "company_name": "Test Company",
    "contact_name": "John Smith",
    "contact_email": "john.smith@test.courierpickup.com.au",
    "contact_phone": "123412341234",
    "address_line1": "1508 Centre Rd",
    "address_line2": "Building 1",
    "address_line3": "Clayton Business Park",
    "postcode": "3169",
    "suburb": "CLAYTON"
  },
  "receiver_address": {
    "company_name": "Another Company",
    "contact_phone": "33334444",
    "address_line1": "147 Bourke Street",
    "address_line2": "Level 1",
    "postcode": "3000",
    "suburb": "MELBOURNE"
  },
  "dangerous_goods": false,
  "package_count": 2,
  "consignment_count": 1,
  "total_weight": 0.1,
  "max_package_length": 0,
  "max_package_width": 0,
  "max_package_height": 0,
  "max_package_weight": 0
}
{
  "required": [
    "carrier_name"
  ],
  "type": "object",
  "properties": {
    "order_reference": {
      "description": "Used to identify the order in the user's system",
      "type": "string"
    },
    "tracking_number": {
      "description": "The tracking number, consignment number or barcode of the order",
      "type": "string"
    },
    "carrier_name": {
      "description": "Name of the carrier used for shipment pickup and  delivery",
      "type": "string"
    },
    "use_staging": {
      "description": "Flag to indicate whether to call the carrier's staging or production api",
      "type": "boolean"
    },
    "sender_account": {
      "description": "The account that is held with the target carrier",
      "type": "string"
    },
    "receiver_account": {
      "description": "The account that is held with the target carrier by the receiver\r\nUsed when payer is receiver",
      "type": "string"
    },
    "pickup_timeslot_start": {
      "format": "date-time",
      "description": "Earliest time the order can be picked up in UTC",
      "type": "string"
    },
    "pickup_timeslot_end": {
      "format": "date-time",
      "description": "Latest time the order can be picked up in UTC (ignored by some carriers)",
      "type": "string"
    },
    "special_instructions": {
      "description": "Any pickup instructions eg \"Use side door\"",
      "type": "string"
    },
    "sender_address": {
      "type": "object",
      "properties": {
        "company_name": {
          "description": "The name of the company at the relevant address",
          "type": "string"
        },
        "contact_name": {
          "description": "The name of the contact person at the relevant address",
          "type": "string"
        },
        "contact_email": {
          "description": "The email address of the contact person at the relevant address",
          "type": "string"
        },
        "contact_phone_area_code": {
          "description": "The area code for the contact phone number at the relevant address",
          "type": "string"
        },
        "contact_phone": {
          "description": "The phone number for the contact at the relevant address",
          "type": "string"
        },
        "address_line1": {
          "description": "First address line of the elevant address",
          "type": "string"
        },
        "address_line2": {
          "description": "Second address line of the elevant address",
          "type": "string"
        },
        "address_line3": {
          "description": "Third address line of the elevant address",
          "type": "string"
        },
        "postcode": {
          "description": "The postcode of the elevant address",
          "type": "string"
        },
        "suburb": {
          "description": "The suburb of the elevant address",
          "type": "string"
        },
        "state": {
          "description": "The state code of the relevant address",
          "type": "string"
        }
      },
      "description": "The address where the order is being sent from"
    },
    "collection_address": {
      "type": "object",
      "properties": {
        "company_name": {
          "description": "The name of the company at the relevant address",
          "type": "string"
        },
        "contact_name": {
          "description": "The name of the contact person at the relevant address",
          "type": "string"
        },
        "contact_email": {
          "description": "The email address of the contact person at the relevant address",
          "type": "string"
        },
        "contact_phone_area_code": {
          "description": "The area code for the contact phone number at the relevant address",
          "type": "string"
        },
        "contact_phone": {
          "description": "The phone number for the contact at the relevant address",
          "type": "string"
        },
        "address_line1": {
          "description": "First address line of the elevant address",
          "type": "string"
        },
        "address_line2": {
          "description": "Second address line of the elevant address",
          "type": "string"
        },
        "address_line3": {
          "description": "Third address line of the elevant address",
          "type": "string"
        },
        "postcode": {
          "description": "The postcode of the elevant address",
          "type": "string"
        },
        "suburb": {
          "description": "The suburb of the elevant address",
          "type": "string"
        },
        "state": {
          "description": "The state code of the relevant address",
          "type": "string"
        }
      },
      "description": "The address where the order is being collected from"
    },
    "receiver_address": {
      "type": "object",
      "properties": {
        "company_name": {
          "description": "The name of the company at the relevant address",
          "type": "string"
        },
        "contact_name": {
          "description": "The name of the contact person at the relevant address",
          "type": "string"
        },
        "contact_email": {
          "description": "The email address of the contact person at the relevant address",
          "type": "string"
        },
        "contact_phone_area_code": {
          "description": "The area code for the contact phone number at the relevant address",
          "type": "string"
        },
        "contact_phone": {
          "description": "The phone number for the contact at the relevant address",
          "type": "string"
        },
        "address_line1": {
          "description": "First address line of the elevant address",
          "type": "string"
        },
        "address_line2": {
          "description": "Second address line of the elevant address",
          "type": "string"
        },
        "address_line3": {
          "description": "Third address line of the elevant address",
          "type": "string"
        },
        "postcode": {
          "description": "The postcode of the elevant address",
          "type": "string"
        },
        "suburb": {
          "description": "The suburb of the elevant address",
          "type": "string"
        },
        "state": {
          "description": "The state code of the relevant address",
          "type": "string"
        }
      },
      "description": "The address where the order is to be delivered"
    },
    "packaging_code": {
      "description": "Packaging code for the order being picked up e.g. Satchel, Bag, Carton",
      "type": "string"
    },
    "service_code": {
      "description": "Service code for the order being picked up",
      "type": "string"
    },
    "dangerous_goods": {
      "description": "Indicates if the shipment contains dangerous goods",
      "type": "boolean"
    },
    "dangerous_goods_un": {
      "description": "UN related to dangerous goods",
      "type": "string"
    },
    "dangerous_goods_packing_group": {
      "description": "Packing group related to dangerous goods",
      "type": "string"
    },
    "payer": {
      "description": "Who is paying for delivery of the order - Sender or Receiver",
      "type": "string"
    },
    "package_count": {
      "format": "int32",
      "description": "Total number of packages being collected",
      "pattern": "^\\d+$",
      "type": "integer"
    },
    "consignment_count": {
      "format": "int32",
      "description": "Total number of consignments being collected",
      "pattern": "^\\d+$",
      "type": "integer"
    },
    "total_weight": {
      "format": "double",
      "description": "Total combined weight of packages being collected",
      "pattern": "^[0-9]\\d*(\\.\\d+)?$",
      "type": "number"
    },
    "max_package_length": {
      "format": "double",
      "description": "Length of the largest package in cm",
      "pattern": "^[0-9]\\d*(\\.\\d+)?$",
      "type": "number"
    },
    "max_package_width": {
      "format": "double",
      "description": "Width of the largest package in cm",
      "pattern": "^[0-9]\\d*(\\.\\d+)?$",
      "type": "number"
    },
    "max_package_height": {
      "format": "double",
      "description": "Height of the largest package in cm",
      "pattern": "^[0-9]\\d*(\\.\\d+)?$",
      "type": "number"
    },
    "max_package_weight": {
      "format": "double",
      "description": "Weight of the largest package in kg",
      "pattern": "^[0-9]\\d*(\\.\\d+)?$",
      "type": "number"
    }
  },
  "example": {
    "order_reference": "2009",
    "tracking_number": "CPAHMIZ0005207001",
    "carrier_name": "CouriersPlease",
    "use_staging": true,
    "pickup_timeslot_start": "2020-04-30T22:47:02.543724Z",
    "collection_address": {
      "company_name": "Test Company",
      "contact_name": "John Smith",
      "contact_email": "john.smith@test.courierpickup.com.au",
      "contact_phone": "123412341234",
      "address_line1": "1508 Centre Rd",
      "address_line2": "Building 1",
      "address_line3": "Clayton Business Park",
      "postcode": "3169",
      "suburb": "CLAYTON"
    },
    "receiver_address": {
      "company_name": "Another Company",
      "contact_phone": "33334444",
      "address_line1": "147 Bourke Street",
      "address_line2": "Level 1",
      "postcode": "3000",
      "suburb": "MELBOURNE"
    },
    "dangerous_goods": false,
    "package_count": 2,
    "consignment_count": 1,
    "total_weight": 0.1,
    "max_package_length": 0,
    "max_package_width": 0,
    "max_package_height": 0,
    "max_package_weight": 0
  }
}

Response 200

OK

{
  "job_number": "4500",
  "success": true
}
{
  "type": "object",
  "properties": {
    "job_number": {
      "type": "string"
    },
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}
{
  "job_number": "string",
  "success": true,
  "errors": [
    {
      "message": "string",
      "details": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "job_number": {
      "type": "string"
    },
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}
<BookPickupResponse>
  <job_number>string</job_number>
  <success>true</success>
  <errors>
    <message>string</message>
    <details>string</details>
  </errors>
</BookPickupResponse>
{
  "type": "object",
  "properties": {
    "job_number": {
      "type": "string"
    },
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}
<BookPickupResponse>
  <job_number>string</job_number>
  <success>true</success>
  <errors>
    <message>string</message>
    <details>string</details>
  </errors>
</BookPickupResponse>
{
  "type": "object",
  "properties": {
    "job_number": {
      "type": "string"
    },
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.starshipit.com/api/pickup/book"
-H "StarShipIT-Api-Key: "
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("StarShipIT-Api-Key", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://api.starshipit.com/api/pickup/book?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.starshipit.com/api/pickup/book");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("StarShipIT-Api-Key", "");
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api.starshipit.com/api/pickup/book?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("StarShipIT-Api-Key","");
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.starshipit.com/api/pickup/book";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"StarShipIT-Api-Key"];
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.starshipit.com/api/pickup/book');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'StarShipIT-Api-Key' => '',
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'StarShipIT-Api-Key': '',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.starshipit.com')
    conn.request("POST", "/api/pickup/book?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'StarShipIT-Api-Key': '',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.starshipit.com')
    conn.request("POST", "/api/pickup/book?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.starshipit.com/api/pickup/book')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['StarShipIT-Api-Key'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body