Developer Centre > API References > Delivery Services

StarShipIT

API change history

Delivery Services

Get a list of available carrier delivery services

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

{
  "street": "string",
  "suburb": "string",
  "city": "string",
  "state": "string",
  "post_code": "string",
  "country_code": "string",
  "packages": [
    {
      "weight": 0.0,
      "height": 0.0,
      "width": 0.0,
      "length": 0.0
    }
  ]
}
{
  "required": [
    "street",
    "post_code",
    "country_code",
    "packages"
  ],
  "type": "object",
  "properties": {
    "street": {
      "description": "Street number and name of the delivery address",
      "type": "string"
    },
    "suburb": {
      "description": "Suburb of the delivery address",
      "type": "string"
    },
    "city": {
      "description": "City of the delivery address",
      "type": "string"
    },
    "state": {
      "description": "State, regional, provincial or county name of the delivery address",
      "type": "string"
    },
    "post_code": {
      "description": "Postal or zip code of the delivery address",
      "type": "string"
    },
    "country_code": {
      "description": "The country code of the delivery address",
      "type": "string"
    },
    "packages": {
      "description": "Packages of the order",
      "type": "array",
      "items": {
        "description": "Package list containing the parcel details",
        "type": "object",
        "properties": {
          "weight": {
            "format": "double",
            "description": "Physical weight of the parcel in kilograms (kg)",
            "type": "number"
          },
          "height": {
            "format": "double",
            "description": "Height of the parcel in meters (m)",
            "type": "number"
          },
          "width": {
            "format": "double",
            "description": "Width of the parcel in meters (m)",
            "type": "number"
          },
          "length": {
            "format": "double",
            "description": "Length of the parcel in meters (m)",
            "type": "number"
          }
        }
      }
    }
  }
}
{
  "street": "string",
  "suburb": "string",
  "city": "string",
  "state": "string",
  "post_code": "string",
  "country_code": "string",
  "packages": [
    {
      "weight": 0.0,
      "height": 0.0,
      "width": 0.0,
      "length": 0.0
    }
  ]
}
{
  "required": [
    "street",
    "post_code",
    "country_code",
    "packages"
  ],
  "type": "object",
  "properties": {
    "street": {
      "description": "Street number and name of the delivery address",
      "type": "string"
    },
    "suburb": {
      "description": "Suburb of the delivery address",
      "type": "string"
    },
    "city": {
      "description": "City of the delivery address",
      "type": "string"
    },
    "state": {
      "description": "State, regional, provincial or county name of the delivery address",
      "type": "string"
    },
    "post_code": {
      "description": "Postal or zip code of the delivery address",
      "type": "string"
    },
    "country_code": {
      "description": "The country code of the delivery address",
      "type": "string"
    },
    "packages": {
      "description": "Packages of the order",
      "type": "array",
      "items": {
        "description": "Package list containing the parcel details",
        "type": "object",
        "properties": {
          "weight": {
            "format": "double",
            "description": "Physical weight of the parcel in kilograms (kg)",
            "type": "number"
          },
          "height": {
            "format": "double",
            "description": "Height of the parcel in meters (m)",
            "type": "number"
          },
          "width": {
            "format": "double",
            "description": "Width of the parcel in meters (m)",
            "type": "number"
          },
          "length": {
            "format": "double",
            "description": "Length of the parcel in meters (m)",
            "type": "number"
          }
        }
      }
    }
  }
}
<GetDeliveryServicesRequest>
  <street>string</street>
  <suburb>string</suburb>
  <city>string</city>
  <state>string</state>
  <post_code>string</post_code>
  <country_code>string</country_code>
  <packages>
    <weight>0</weight>
    <height>0</height>
    <width>0</width>
    <length>0</length>
  </packages>
</GetDeliveryServicesRequest>
{
  "required": [
    "street",
    "post_code",
    "country_code",
    "packages"
  ],
  "type": "object",
  "properties": {
    "street": {
      "description": "Street number and name of the delivery address",
      "type": "string"
    },
    "suburb": {
      "description": "Suburb of the delivery address",
      "type": "string"
    },
    "city": {
      "description": "City of the delivery address",
      "type": "string"
    },
    "state": {
      "description": "State, regional, provincial or county name of the delivery address",
      "type": "string"
    },
    "post_code": {
      "description": "Postal or zip code of the delivery address",
      "type": "string"
    },
    "country_code": {
      "description": "The country code of the delivery address",
      "type": "string"
    },
    "packages": {
      "description": "Packages of the order",
      "type": "array",
      "items": {
        "description": "Package list containing the parcel details",
        "type": "object",
        "properties": {
          "weight": {
            "format": "double",
            "description": "Physical weight of the parcel in kilograms (kg)",
            "type": "number"
          },
          "height": {
            "format": "double",
            "description": "Height of the parcel in meters (m)",
            "type": "number"
          },
          "width": {
            "format": "double",
            "description": "Width of the parcel in meters (m)",
            "type": "number"
          },
          "length": {
            "format": "double",
            "description": "Length of the parcel in meters (m)",
            "type": "number"
          }
        }
      }
    }
  }
}
<GetDeliveryServicesRequest>
  <street>string</street>
  <suburb>string</suburb>
  <city>string</city>
  <state>string</state>
  <post_code>string</post_code>
  <country_code>string</country_code>
  <packages>
    <weight>0</weight>
    <height>0</height>
    <width>0</width>
    <length>0</length>
  </packages>
</GetDeliveryServicesRequest>
{
  "required": [
    "street",
    "post_code",
    "country_code",
    "packages"
  ],
  "type": "object",
  "properties": {
    "street": {
      "description": "Street number and name of the delivery address",
      "type": "string"
    },
    "suburb": {
      "description": "Suburb of the delivery address",
      "type": "string"
    },
    "city": {
      "description": "City of the delivery address",
      "type": "string"
    },
    "state": {
      "description": "State, regional, provincial or county name of the delivery address",
      "type": "string"
    },
    "post_code": {
      "description": "Postal or zip code of the delivery address",
      "type": "string"
    },
    "country_code": {
      "description": "The country code of the delivery address",
      "type": "string"
    },
    "packages": {
      "description": "Packages of the order",
      "type": "array",
      "items": {
        "description": "Package list containing the parcel details",
        "type": "object",
        "properties": {
          "weight": {
            "format": "double",
            "description": "Physical weight of the parcel in kilograms (kg)",
            "type": "number"
          },
          "height": {
            "format": "double",
            "description": "Height of the parcel in meters (m)",
            "type": "number"
          },
          "width": {
            "format": "double",
            "description": "Width of the parcel in meters (m)",
            "type": "number"
          },
          "length": {
            "format": "double",
            "description": "Length of the parcel in meters (m)",
            "type": "number"
          }
        }
      }
    }
  }
}

Response 200

OK

{
  "services": [
    {
      "carrier": "CourierPost",
      "carrier_name": "string",
      "service_name": "string",
      "service_code": "string",
      "total_price": 0.0,
      "metafields": [
        {
          "key": "string",
          "name": "string",
          "description": "string",
          "display_type": "string",
          "value": "string",
          "default_value": "string",
          "available_values": [
            "string"
          ],
          "value_type": "string"
        }
      ]
    }
  ],
  "default_service": {
    "carrier": "CourierPost",
    "carrier_name": "string",
    "service_name": "string",
    "service_code": "string",
    "total_price": 0.0,
    "metafields": [
      {
        "key": "string",
        "name": "string",
        "description": "string",
        "display_type": "string",
        "value": "string",
        "default_value": "string",
        "available_values": [
          "string"
        ],
        "value_type": "string"
      }
    ]
  },
  "success": true,
  "errors": [
    {
      "message": "string",
      "details": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "services": {
      "description": "A list of available delivery services",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "carrier": {
            "description": "The carrier code",
            "enum": [
              "CourierPost",
              "NZPost",
              "DHL",
              "Fastways",
              "PostHaste",
              "CastleParcels",
              "NZCouriers",
              "NOW",
              "Sub60",
              "PlainLabel",
              "AusPost",
              "UPS",
              "Urgent",
              "DPD",
              "PBT",
              "TollPriority",
              "DHLGlobalMail",
              "CouriersPlease",
              "StarTrack",
              "Pace",
              "StarTrackCourier",
              "TollIPEC",
              "TNT",
              "Sendle",
              "HunterExpress",
              "InXpress",
              "QuantiumSolutions",
              "PickupInStore",
              "PackAndSend",
              "Seko",
              "Zoom2u",
              "QuantiumSolutionsNZ",
              "PlainLabel2",
              "PlainLabel3",
              "PlainLabel4",
              "PlainLabel5",
              "DHLeCommerceEU",
              "DPDLocalUK",
              "None"
            ],
            "type": "string"
          },
          "carrier_name": {
            "description": "The carrier name",
            "type": "string"
          },
          "service_name": {
            "description": "Description of the carrier service",
            "type": "string"
          },
          "service_code": {
            "description": "Carrier service/product code",
            "type": "string"
          },
          "total_price": {
            "format": "double",
            "description": "Price of service",
            "type": "number"
          },
          "metafields": {
            "description": "Additional options available for the carrier service",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "display_type": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                },
                "default_value": {
                  "type": "string"
                },
                "available_values": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "value_type": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "default_service": {
      "type": "object",
      "properties": {
        "carrier": {
          "description": "The carrier code",
          "enum": [
            "CourierPost",
            "NZPost",
            "DHL",
            "Fastways",
            "PostHaste",
            "CastleParcels",
            "NZCouriers",
            "NOW",
            "Sub60",
            "PlainLabel",
            "AusPost",
            "UPS",
            "Urgent",
            "DPD",
            "PBT",
            "TollPriority",
            "DHLGlobalMail",
            "CouriersPlease",
            "StarTrack",
            "Pace",
            "StarTrackCourier",
            "TollIPEC",
            "TNT",
            "Sendle",
            "HunterExpress",
            "InXpress",
            "QuantiumSolutions",
            "PickupInStore",
            "PackAndSend",
            "Seko",
            "Zoom2u",
            "QuantiumSolutionsNZ",
            "PlainLabel2",
            "PlainLabel3",
            "PlainLabel4",
            "PlainLabel5",
            "DHLeCommerceEU",
            "DPDLocalUK",
            "None"
          ],
          "type": "string"
        },
        "carrier_name": {
          "description": "The carrier name",
          "type": "string"
        },
        "service_name": {
          "description": "Description of the carrier service",
          "type": "string"
        },
        "service_code": {
          "description": "Carrier service/product code",
          "type": "string"
        },
        "total_price": {
          "format": "double",
          "description": "Price of service",
          "type": "number"
        },
        "metafields": {
          "description": "Additional options available for the carrier service",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "display_type": {
                "type": "string"
              },
              "value": {
                "type": "string"
              },
              "default_value": {
                "type": "string"
              },
              "available_values": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "value_type": {
                "type": "string"
              }
            }
          }
        }
      },
      "description": "The name of the default service, if avialable, as configured by the user."
    },
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}
{
  "services": [
    {
      "carrier": "CourierPost",
      "carrier_name": "string",
      "service_name": "string",
      "service_code": "string",
      "total_price": 0.0,
      "metafields": [
        {
          "key": "string",
          "name": "string",
          "description": "string",
          "display_type": "string",
          "value": "string",
          "default_value": "string",
          "available_values": [
            "string"
          ],
          "value_type": "string"
        }
      ]
    }
  ],
  "default_service": {
    "carrier": "CourierPost",
    "carrier_name": "string",
    "service_name": "string",
    "service_code": "string",
    "total_price": 0.0,
    "metafields": [
      {
        "key": "string",
        "name": "string",
        "description": "string",
        "display_type": "string",
        "value": "string",
        "default_value": "string",
        "available_values": [
          "string"
        ],
        "value_type": "string"
      }
    ]
  },
  "success": true,
  "errors": [
    {
      "message": "string",
      "details": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "services": {
      "description": "A list of available delivery services",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "carrier": {
            "description": "The carrier code",
            "enum": [
              "CourierPost",
              "NZPost",
              "DHL",
              "Fastways",
              "PostHaste",
              "CastleParcels",
              "NZCouriers",
              "NOW",
              "Sub60",
              "PlainLabel",
              "AusPost",
              "UPS",
              "Urgent",
              "DPD",
              "PBT",
              "TollPriority",
              "DHLGlobalMail",
              "CouriersPlease",
              "StarTrack",
              "Pace",
              "StarTrackCourier",
              "TollIPEC",
              "TNT",
              "Sendle",
              "HunterExpress",
              "InXpress",
              "QuantiumSolutions",
              "PickupInStore",
              "PackAndSend",
              "Seko",
              "Zoom2u",
              "QuantiumSolutionsNZ",
              "PlainLabel2",
              "PlainLabel3",
              "PlainLabel4",
              "PlainLabel5",
              "DHLeCommerceEU",
              "DPDLocalUK",
              "None"
            ],
            "type": "string"
          },
          "carrier_name": {
            "description": "The carrier name",
            "type": "string"
          },
          "service_name": {
            "description": "Description of the carrier service",
            "type": "string"
          },
          "service_code": {
            "description": "Carrier service/product code",
            "type": "string"
          },
          "total_price": {
            "format": "double",
            "description": "Price of service",
            "type": "number"
          },
          "metafields": {
            "description": "Additional options available for the carrier service",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "display_type": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                },
                "default_value": {
                  "type": "string"
                },
                "available_values": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "value_type": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "default_service": {
      "type": "object",
      "properties": {
        "carrier": {
          "description": "The carrier code",
          "enum": [
            "CourierPost",
            "NZPost",
            "DHL",
            "Fastways",
            "PostHaste",
            "CastleParcels",
            "NZCouriers",
            "NOW",
            "Sub60",
            "PlainLabel",
            "AusPost",
            "UPS",
            "Urgent",
            "DPD",
            "PBT",
            "TollPriority",
            "DHLGlobalMail",
            "CouriersPlease",
            "StarTrack",
            "Pace",
            "StarTrackCourier",
            "TollIPEC",
            "TNT",
            "Sendle",
            "HunterExpress",
            "InXpress",
            "QuantiumSolutions",
            "PickupInStore",
            "PackAndSend",
            "Seko",
            "Zoom2u",
            "QuantiumSolutionsNZ",
            "PlainLabel2",
            "PlainLabel3",
            "PlainLabel4",
            "PlainLabel5",
            "DHLeCommerceEU",
            "DPDLocalUK",
            "None"
          ],
          "type": "string"
        },
        "carrier_name": {
          "description": "The carrier name",
          "type": "string"
        },
        "service_name": {
          "description": "Description of the carrier service",
          "type": "string"
        },
        "service_code": {
          "description": "Carrier service/product code",
          "type": "string"
        },
        "total_price": {
          "format": "double",
          "description": "Price of service",
          "type": "number"
        },
        "metafields": {
          "description": "Additional options available for the carrier service",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "display_type": {
                "type": "string"
              },
              "value": {
                "type": "string"
              },
              "default_value": {
                "type": "string"
              },
              "available_values": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "value_type": {
                "type": "string"
              }
            }
          }
        }
      },
      "description": "The name of the default service, if avialable, as configured by the user."
    },
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}
<GetDeliveryServicesResponse>
  <services>
    <carrier>CourierPost</carrier>
    <carrier_name>string</carrier_name>
    <service_name>string</service_name>
    <service_code>string</service_code>
    <total_price>0</total_price>
    <metafields>
      <key>string</key>
      <name>string</name>
      <description>string</description>
      <display_type>string</display_type>
      <value>string</value>
      <default_value>string</default_value>
      <available_values>string</available_values>
      <value_type>string</value_type>
    </metafields>
  </services>
  <default_service>
    <carrier>CourierPost</carrier>
    <carrier_name>string</carrier_name>
    <service_name>string</service_name>
    <service_code>string</service_code>
    <total_price>0</total_price>
    <metafields>
      <key>string</key>
      <name>string</name>
      <description>string</description>
      <display_type>string</display_type>
      <value>string</value>
      <default_value>string</default_value>
      <available_values>string</available_values>
      <value_type>string</value_type>
    </metafields>
  </default_service>
  <success>true</success>
  <errors>
    <message>string</message>
    <details>string</details>
  </errors>
</GetDeliveryServicesResponse>
{
  "type": "object",
  "properties": {
    "services": {
      "description": "A list of available delivery services",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "carrier": {
            "description": "The carrier code",
            "enum": [
              "CourierPost",
              "NZPost",
              "DHL",
              "Fastways",
              "PostHaste",
              "CastleParcels",
              "NZCouriers",
              "NOW",
              "Sub60",
              "PlainLabel",
              "AusPost",
              "UPS",
              "Urgent",
              "DPD",
              "PBT",
              "TollPriority",
              "DHLGlobalMail",
              "CouriersPlease",
              "StarTrack",
              "Pace",
              "StarTrackCourier",
              "TollIPEC",
              "TNT",
              "Sendle",
              "HunterExpress",
              "InXpress",
              "QuantiumSolutions",
              "PickupInStore",
              "PackAndSend",
              "Seko",
              "Zoom2u",
              "QuantiumSolutionsNZ",
              "PlainLabel2",
              "PlainLabel3",
              "PlainLabel4",
              "PlainLabel5",
              "DHLeCommerceEU",
              "DPDLocalUK",
              "None"
            ],
            "type": "string"
          },
          "carrier_name": {
            "description": "The carrier name",
            "type": "string"
          },
          "service_name": {
            "description": "Description of the carrier service",
            "type": "string"
          },
          "service_code": {
            "description": "Carrier service/product code",
            "type": "string"
          },
          "total_price": {
            "format": "double",
            "description": "Price of service",
            "type": "number"
          },
          "metafields": {
            "description": "Additional options available for the carrier service",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "display_type": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                },
                "default_value": {
                  "type": "string"
                },
                "available_values": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "value_type": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "default_service": {
      "type": "object",
      "properties": {
        "carrier": {
          "description": "The carrier code",
          "enum": [
            "CourierPost",
            "NZPost",
            "DHL",
            "Fastways",
            "PostHaste",
            "CastleParcels",
            "NZCouriers",
            "NOW",
            "Sub60",
            "PlainLabel",
            "AusPost",
            "UPS",
            "Urgent",
            "DPD",
            "PBT",
            "TollPriority",
            "DHLGlobalMail",
            "CouriersPlease",
            "StarTrack",
            "Pace",
            "StarTrackCourier",
            "TollIPEC",
            "TNT",
            "Sendle",
            "HunterExpress",
            "InXpress",
            "QuantiumSolutions",
            "PickupInStore",
            "PackAndSend",
            "Seko",
            "Zoom2u",
            "QuantiumSolutionsNZ",
            "PlainLabel2",
            "PlainLabel3",
            "PlainLabel4",
            "PlainLabel5",
            "DHLeCommerceEU",
            "DPDLocalUK",
            "None"
          ],
          "type": "string"
        },
        "carrier_name": {
          "description": "The carrier name",
          "type": "string"
        },
        "service_name": {
          "description": "Description of the carrier service",
          "type": "string"
        },
        "service_code": {
          "description": "Carrier service/product code",
          "type": "string"
        },
        "total_price": {
          "format": "double",
          "description": "Price of service",
          "type": "number"
        },
        "metafields": {
          "description": "Additional options available for the carrier service",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "display_type": {
                "type": "string"
              },
              "value": {
                "type": "string"
              },
              "default_value": {
                "type": "string"
              },
              "available_values": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "value_type": {
                "type": "string"
              }
            }
          }
        }
      },
      "description": "The name of the default service, if avialable, as configured by the user."
    },
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}
<GetDeliveryServicesResponse>
  <services>
    <carrier>CourierPost</carrier>
    <carrier_name>string</carrier_name>
    <service_name>string</service_name>
    <service_code>string</service_code>
    <total_price>0</total_price>
    <metafields>
      <key>string</key>
      <name>string</name>
      <description>string</description>
      <display_type>string</display_type>
      <value>string</value>
      <default_value>string</default_value>
      <available_values>string</available_values>
      <value_type>string</value_type>
    </metafields>
  </services>
  <default_service>
    <carrier>CourierPost</carrier>
    <carrier_name>string</carrier_name>
    <service_name>string</service_name>
    <service_code>string</service_code>
    <total_price>0</total_price>
    <metafields>
      <key>string</key>
      <name>string</name>
      <description>string</description>
      <display_type>string</display_type>
      <value>string</value>
      <default_value>string</default_value>
      <available_values>string</available_values>
      <value_type>string</value_type>
    </metafields>
  </default_service>
  <success>true</success>
  <errors>
    <message>string</message>
    <details>string</details>
  </errors>
</GetDeliveryServicesResponse>
{
  "type": "object",
  "properties": {
    "services": {
      "description": "A list of available delivery services",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "carrier": {
            "description": "The carrier code",
            "enum": [
              "CourierPost",
              "NZPost",
              "DHL",
              "Fastways",
              "PostHaste",
              "CastleParcels",
              "NZCouriers",
              "NOW",
              "Sub60",
              "PlainLabel",
              "AusPost",
              "UPS",
              "Urgent",
              "DPD",
              "PBT",
              "TollPriority",
              "DHLGlobalMail",
              "CouriersPlease",
              "StarTrack",
              "Pace",
              "StarTrackCourier",
              "TollIPEC",
              "TNT",
              "Sendle",
              "HunterExpress",
              "InXpress",
              "QuantiumSolutions",
              "PickupInStore",
              "PackAndSend",
              "Seko",
              "Zoom2u",
              "QuantiumSolutionsNZ",
              "PlainLabel2",
              "PlainLabel3",
              "PlainLabel4",
              "PlainLabel5",
              "DHLeCommerceEU",
              "DPDLocalUK",
              "None"
            ],
            "type": "string"
          },
          "carrier_name": {
            "description": "The carrier name",
            "type": "string"
          },
          "service_name": {
            "description": "Description of the carrier service",
            "type": "string"
          },
          "service_code": {
            "description": "Carrier service/product code",
            "type": "string"
          },
          "total_price": {
            "format": "double",
            "description": "Price of service",
            "type": "number"
          },
          "metafields": {
            "description": "Additional options available for the carrier service",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "display_type": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                },
                "default_value": {
                  "type": "string"
                },
                "available_values": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "value_type": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "default_service": {
      "type": "object",
      "properties": {
        "carrier": {
          "description": "The carrier code",
          "enum": [
            "CourierPost",
            "NZPost",
            "DHL",
            "Fastways",
            "PostHaste",
            "CastleParcels",
            "NZCouriers",
            "NOW",
            "Sub60",
            "PlainLabel",
            "AusPost",
            "UPS",
            "Urgent",
            "DPD",
            "PBT",
            "TollPriority",
            "DHLGlobalMail",
            "CouriersPlease",
            "StarTrack",
            "Pace",
            "StarTrackCourier",
            "TollIPEC",
            "TNT",
            "Sendle",
            "HunterExpress",
            "InXpress",
            "QuantiumSolutions",
            "PickupInStore",
            "PackAndSend",
            "Seko",
            "Zoom2u",
            "QuantiumSolutionsNZ",
            "PlainLabel2",
            "PlainLabel3",
            "PlainLabel4",
            "PlainLabel5",
            "DHLeCommerceEU",
            "DPDLocalUK",
            "None"
          ],
          "type": "string"
        },
        "carrier_name": {
          "description": "The carrier name",
          "type": "string"
        },
        "service_name": {
          "description": "Description of the carrier service",
          "type": "string"
        },
        "service_code": {
          "description": "Carrier service/product code",
          "type": "string"
        },
        "total_price": {
          "format": "double",
          "description": "Price of service",
          "type": "number"
        },
        "metafields": {
          "description": "Additional options available for the carrier service",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "display_type": {
                "type": "string"
              },
              "value": {
                "type": "string"
              },
              "default_value": {
                "type": "string"
              },
              "available_values": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "value_type": {
                "type": "string"
              }
            }
          }
        }
      },
      "description": "The name of the default service, if avialable, as configured by the user."
    },
    "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/deliveryservices"
-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/deliveryservices?" + 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/deliveryservices");


            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/deliveryservices?" + $.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/deliveryservices";
    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/deliveryservices');
$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/deliveryservices?%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/deliveryservices?%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/deliveryservices')


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