Developer Centre > API References > Create Order

StarShipIT

API change history

Create Order

Create a new unshipped order

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": {
    "order_date": "2018-11-15T01:51:49.2314399Z",
    "order_number": "10001",
    "reference": "Online Order",
    "shipping_method": "Express Shipping",
    "signature_required": false,
    "destination": {
      "name": "John Smith",
      "phone": "0290988227",
      "street": "20 George Street",
      "suburb": "Sydney",
      "state": "NSW",
      "post_code": "2000",
      "country": "Australia",
      "delivery_instructions": "Leave at door"
    },
    "items": [
      {
        "description": "Mobile Phone",
        "sku": "MOBILE",
        "quantity": 1,
        "weight": 0.65,
        "value": 125
      },
      {
        "description": "Mobile Case (Black)",
        "sku": "MOBILE-CASE-BLK",
        "quantity": 1,
        "weight": 0.05,
        "value": 20
      }
    ]
  }
}
{
  "required": [
    "order"
  ],
  "type": "object",
  "properties": {
    "order": {
      "description": "The order details object",
      "required": [
        "order_number"
      ],
      "type": "object",
      "properties": {
        "order_id": {
          "format": "int32",
          "description": "The unique numeric identifier for the order.",
          "type": "integer"
        },
        "order_date": {
          "format": "date-time",
          "description": "The date when the order was created in UTC",
          "type": "string"
        },
        "order_number": {
          "description": "The identifier of the order pulled from source e-Commerce platform",
          "maxLength": 50,
          "minLength": 1,
          "type": "string"
        },
        "reference": {
          "description": "Customer's reference",
          "maxLength": 50,
          "minLength": 0,
          "type": "string"
        },
        "shipping_method": {
          "description": "Delivery method name",
          "maxLength": 100,
          "minLength": 0,
          "type": "string"
        },
        "shipping_description": {
          "description": "Delivery method description",
          "maxLength": 100,
          "minLength": 0,
          "type": "string"
        },
        "signature_required": {
          "description": "Determine whether signature is needed on delivery",
          "type": "boolean"
        },
        "currency": {
          "description": "Currency code for the order value (e.g. AUD)",
          "maxLength": 3,
          "minLength": 0,
          "type": "string"
        },
        "sender_details": {
          "description": "Pickup address and contact details",
          "required": [
            "name",
            "street",
            "suburb",
            "country"
          ],
          "type": "object",
          "properties": {
            "name": {
              "description": "Contact name of the sender",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "email": {
              "description": "Contact email address of the sender",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "phone": {
              "description": "Contact phone number of the sender",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "building": {
              "description": "Building name of the pickup address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "company": {
              "description": "Name of company that the parcel is being sent from",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "street": {
              "description": "Street number and name of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "suburb": {
              "description": "Suburb of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "city": {
              "description": "City of the pickup address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "state": {
              "description": "Regional, provincial or county name of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "post_code": {
              "description": "Postal or zip code of the pickup address",
              "maxLength": 10,
              "minLength": 0,
              "type": "string"
            },
            "country": {
              "description": "The country name of pickup address",
              "maxLength": 100,
              "minLength": 2,
              "type": "string"
            }
          }
        },
        "destination": {
          "description": "Shipping address and contact details",
          "required": [
            "name",
            "street",
            "suburb",
            "country"
          ],
          "type": "object",
          "properties": {
            "name": {
              "description": "Contact name of the receiver",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "email": {
              "description": "Contact email address of the receiver",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "phone": {
              "description": "Contact phone number of the receiver",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "building": {
              "description": "Building name of the delivery address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "company": {
              "description": "Name of company that the parcel is being delivered to",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "street": {
              "description": "Street number and name of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "suburb": {
              "description": "Suburb of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "city": {
              "description": "City of the delivery address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "state": {
              "description": "Regional, provincial or county name of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "post_code": {
              "description": "Postal or zip code of the delivery address",
              "maxLength": 10,
              "minLength": 0,
              "type": "string"
            },
            "country": {
              "description": "The country name of delivery address",
              "maxLength": 100,
              "minLength": 2,
              "type": "string"
            },
            "delivery_instructions": {
              "description": "Delivery instructions for courier",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            }
          }
        },
        "items": {
          "description": "Item list containing the order item details",
          "type": "array",
          "items": {
            "description": "Item list containing the order item details",
            "type": "object",
            "properties": {
              "description": {
                "description": "Product name or description",
                "type": "string"
              },
              "sku": {
                "description": "Product code or SKU",
                "maxLength": 50,
                "minLength": 0,
                "type": "string"
              },
              "tariff_code": {
                "description": "The harmonized system code that indicates the type of this order item",
                "maxLength": 18,
                "minLength": 0,
                "type": "string"
              },
              "country_of_origin": {
                "description": "The country in which this item was manufactured",
                "maxLength": 50,
                "minLength": 0,
                "type": "string"
              },
              "quantity": {
                "format": "double",
                "description": "The number of product ordered",
                "type": "number"
              },
              "weight": {
                "format": "double",
                "description": "Unit weight of the product in kilograms (kg)",
                "type": "number"
              },
              "value": {
                "format": "double",
                "description": "Unit price of the product",
                "type": "number"
              }
            }
          }
        },
        "packages": {
          "description": "Package list containing the parcel details",
          "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"
              }
            }
          }
        }
      }
    }
  },
  "example": {
    "order": {
      "order_date": "2018-11-15T01:51:49.2314399Z",
      "order_number": "10001",
      "reference": "Online Order",
      "shipping_method": "Express Shipping",
      "signature_required": false,
      "destination": {
        "name": "John Smith",
        "phone": "0290988227",
        "street": "20 George Street",
        "suburb": "Sydney",
        "state": "NSW",
        "post_code": "2000",
        "country": "Australia",
        "delivery_instructions": "Leave at door"
      },
      "items": [
        {
          "description": "Mobile Phone",
          "sku": "MOBILE",
          "quantity": 1,
          "weight": 0.65,
          "value": 125
        },
        {
          "description": "Mobile Case (Black)",
          "sku": "MOBILE-CASE-BLK",
          "quantity": 1,
          "weight": 0.05,
          "value": 20
        }
      ]
    }
  }
}
{
  "order": {
    "order_date": "2018-11-15T01:51:49.2314399Z",
    "order_number": "10001",
    "reference": "Online Order",
    "shipping_method": "Express Shipping",
    "signature_required": false,
    "destination": {
      "name": "John Smith",
      "phone": "0290988227",
      "street": "20 George Street",
      "suburb": "Sydney",
      "state": "NSW",
      "post_code": "2000",
      "country": "Australia",
      "delivery_instructions": "Leave at door"
    },
    "items": [
      {
        "description": "Mobile Phone",
        "sku": "MOBILE",
        "quantity": 1,
        "weight": 0.65,
        "value": 125
      },
      {
        "description": "Mobile Case (Black)",
        "sku": "MOBILE-CASE-BLK",
        "quantity": 1,
        "weight": 0.05,
        "value": 20
      }
    ]
  }
}
{
  "required": [
    "order"
  ],
  "type": "object",
  "properties": {
    "order": {
      "description": "The order details object",
      "required": [
        "order_number"
      ],
      "type": "object",
      "properties": {
        "order_id": {
          "format": "int32",
          "description": "The unique numeric identifier for the order.",
          "type": "integer"
        },
        "order_date": {
          "format": "date-time",
          "description": "The date when the order was created in UTC",
          "type": "string"
        },
        "order_number": {
          "description": "The identifier of the order pulled from source e-Commerce platform",
          "maxLength": 50,
          "minLength": 1,
          "type": "string"
        },
        "reference": {
          "description": "Customer's reference",
          "maxLength": 50,
          "minLength": 0,
          "type": "string"
        },
        "shipping_method": {
          "description": "Delivery method name",
          "maxLength": 100,
          "minLength": 0,
          "type": "string"
        },
        "shipping_description": {
          "description": "Delivery method description",
          "maxLength": 100,
          "minLength": 0,
          "type": "string"
        },
        "signature_required": {
          "description": "Determine whether signature is needed on delivery",
          "type": "boolean"
        },
        "currency": {
          "description": "Currency code for the order value (e.g. AUD)",
          "maxLength": 3,
          "minLength": 0,
          "type": "string"
        },
        "sender_details": {
          "description": "Pickup address and contact details",
          "required": [
            "name",
            "street",
            "suburb",
            "country"
          ],
          "type": "object",
          "properties": {
            "name": {
              "description": "Contact name of the sender",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "email": {
              "description": "Contact email address of the sender",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "phone": {
              "description": "Contact phone number of the sender",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "building": {
              "description": "Building name of the pickup address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "company": {
              "description": "Name of company that the parcel is being sent from",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "street": {
              "description": "Street number and name of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "suburb": {
              "description": "Suburb of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "city": {
              "description": "City of the pickup address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "state": {
              "description": "Regional, provincial or county name of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "post_code": {
              "description": "Postal or zip code of the pickup address",
              "maxLength": 10,
              "minLength": 0,
              "type": "string"
            },
            "country": {
              "description": "The country name of pickup address",
              "maxLength": 100,
              "minLength": 2,
              "type": "string"
            }
          }
        },
        "destination": {
          "description": "Shipping address and contact details",
          "required": [
            "name",
            "street",
            "suburb",
            "country"
          ],
          "type": "object",
          "properties": {
            "name": {
              "description": "Contact name of the receiver",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "email": {
              "description": "Contact email address of the receiver",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "phone": {
              "description": "Contact phone number of the receiver",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "building": {
              "description": "Building name of the delivery address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "company": {
              "description": "Name of company that the parcel is being delivered to",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "street": {
              "description": "Street number and name of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "suburb": {
              "description": "Suburb of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "city": {
              "description": "City of the delivery address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "state": {
              "description": "Regional, provincial or county name of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "post_code": {
              "description": "Postal or zip code of the delivery address",
              "maxLength": 10,
              "minLength": 0,
              "type": "string"
            },
            "country": {
              "description": "The country name of delivery address",
              "maxLength": 100,
              "minLength": 2,
              "type": "string"
            },
            "delivery_instructions": {
              "description": "Delivery instructions for courier",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            }
          }
        },
        "items": {
          "description": "Item list containing the order item details",
          "type": "array",
          "items": {
            "description": "Item list containing the order item details",
            "type": "object",
            "properties": {
              "description": {
                "description": "Product name or description",
                "type": "string"
              },
              "sku": {
                "description": "Product code or SKU",
                "maxLength": 50,
                "minLength": 0,
                "type": "string"
              },
              "tariff_code": {
                "description": "The harmonized system code that indicates the type of this order item",
                "maxLength": 18,
                "minLength": 0,
                "type": "string"
              },
              "country_of_origin": {
                "description": "The country in which this item was manufactured",
                "maxLength": 50,
                "minLength": 0,
                "type": "string"
              },
              "quantity": {
                "format": "double",
                "description": "The number of product ordered",
                "type": "number"
              },
              "weight": {
                "format": "double",
                "description": "Unit weight of the product in kilograms (kg)",
                "type": "number"
              },
              "value": {
                "format": "double",
                "description": "Unit price of the product",
                "type": "number"
              }
            }
          }
        },
        "packages": {
          "description": "Package list containing the parcel details",
          "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"
              }
            }
          }
        }
      }
    }
  },
  "example": {
    "order": {
      "order_date": "2018-11-15T01:51:49.2314399Z",
      "order_number": "10001",
      "reference": "Online Order",
      "shipping_method": "Express Shipping",
      "signature_required": false,
      "destination": {
        "name": "John Smith",
        "phone": "0290988227",
        "street": "20 George Street",
        "suburb": "Sydney",
        "state": "NSW",
        "post_code": "2000",
        "country": "Australia",
        "delivery_instructions": "Leave at door"
      },
      "items": [
        {
          "description": "Mobile Phone",
          "sku": "MOBILE",
          "quantity": 1,
          "weight": 0.65,
          "value": 125
        },
        {
          "description": "Mobile Case (Black)",
          "sku": "MOBILE-CASE-BLK",
          "quantity": 1,
          "weight": 0.05,
          "value": 20
        }
      ]
    }
  }
}
{
  "order": {
    "order_date": "2018-11-15T01:51:49.2314399Z",
    "order_number": "10001",
    "reference": "Online Order",
    "shipping_method": "Express Shipping",
    "signature_required": false,
    "destination": {
      "name": "John Smith",
      "phone": "0290988227",
      "street": "20 George Street",
      "suburb": "Sydney",
      "state": "NSW",
      "post_code": "2000",
      "country": "Australia",
      "delivery_instructions": "Leave at door"
    },
    "items": [
      {
        "description": "Mobile Phone",
        "sku": "MOBILE",
        "quantity": 1,
        "weight": 0.65,
        "value": 125
      },
      {
        "description": "Mobile Case (Black)",
        "sku": "MOBILE-CASE-BLK",
        "quantity": 1,
        "weight": 0.05,
        "value": 20
      }
    ]
  }
}
{
  "required": [
    "order"
  ],
  "type": "object",
  "properties": {
    "order": {
      "description": "The order details object",
      "required": [
        "order_number"
      ],
      "type": "object",
      "properties": {
        "order_id": {
          "format": "int32",
          "description": "The unique numeric identifier for the order.",
          "type": "integer"
        },
        "order_date": {
          "format": "date-time",
          "description": "The date when the order was created in UTC",
          "type": "string"
        },
        "order_number": {
          "description": "The identifier of the order pulled from source e-Commerce platform",
          "maxLength": 50,
          "minLength": 1,
          "type": "string"
        },
        "reference": {
          "description": "Customer's reference",
          "maxLength": 50,
          "minLength": 0,
          "type": "string"
        },
        "shipping_method": {
          "description": "Delivery method name",
          "maxLength": 100,
          "minLength": 0,
          "type": "string"
        },
        "shipping_description": {
          "description": "Delivery method description",
          "maxLength": 100,
          "minLength": 0,
          "type": "string"
        },
        "signature_required": {
          "description": "Determine whether signature is needed on delivery",
          "type": "boolean"
        },
        "currency": {
          "description": "Currency code for the order value (e.g. AUD)",
          "maxLength": 3,
          "minLength": 0,
          "type": "string"
        },
        "sender_details": {
          "description": "Pickup address and contact details",
          "required": [
            "name",
            "street",
            "suburb",
            "country"
          ],
          "type": "object",
          "properties": {
            "name": {
              "description": "Contact name of the sender",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "email": {
              "description": "Contact email address of the sender",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "phone": {
              "description": "Contact phone number of the sender",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "building": {
              "description": "Building name of the pickup address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "company": {
              "description": "Name of company that the parcel is being sent from",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "street": {
              "description": "Street number and name of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "suburb": {
              "description": "Suburb of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "city": {
              "description": "City of the pickup address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "state": {
              "description": "Regional, provincial or county name of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "post_code": {
              "description": "Postal or zip code of the pickup address",
              "maxLength": 10,
              "minLength": 0,
              "type": "string"
            },
            "country": {
              "description": "The country name of pickup address",
              "maxLength": 100,
              "minLength": 2,
              "type": "string"
            }
          }
        },
        "destination": {
          "description": "Shipping address and contact details",
          "required": [
            "name",
            "street",
            "suburb",
            "country"
          ],
          "type": "object",
          "properties": {
            "name": {
              "description": "Contact name of the receiver",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "email": {
              "description": "Contact email address of the receiver",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "phone": {
              "description": "Contact phone number of the receiver",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "building": {
              "description": "Building name of the delivery address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "company": {
              "description": "Name of company that the parcel is being delivered to",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "street": {
              "description": "Street number and name of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "suburb": {
              "description": "Suburb of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "city": {
              "description": "City of the delivery address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "state": {
              "description": "Regional, provincial or county name of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "post_code": {
              "description": "Postal or zip code of the delivery address",
              "maxLength": 10,
              "minLength": 0,
              "type": "string"
            },
            "country": {
              "description": "The country name of delivery address",
              "maxLength": 100,
              "minLength": 2,
              "type": "string"
            },
            "delivery_instructions": {
              "description": "Delivery instructions for courier",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            }
          }
        },
        "items": {
          "description": "Item list containing the order item details",
          "type": "array",
          "items": {
            "description": "Item list containing the order item details",
            "type": "object",
            "properties": {
              "description": {
                "description": "Product name or description",
                "type": "string"
              },
              "sku": {
                "description": "Product code or SKU",
                "maxLength": 50,
                "minLength": 0,
                "type": "string"
              },
              "tariff_code": {
                "description": "The harmonized system code that indicates the type of this order item",
                "maxLength": 18,
                "minLength": 0,
                "type": "string"
              },
              "country_of_origin": {
                "description": "The country in which this item was manufactured",
                "maxLength": 50,
                "minLength": 0,
                "type": "string"
              },
              "quantity": {
                "format": "double",
                "description": "The number of product ordered",
                "type": "number"
              },
              "weight": {
                "format": "double",
                "description": "Unit weight of the product in kilograms (kg)",
                "type": "number"
              },
              "value": {
                "format": "double",
                "description": "Unit price of the product",
                "type": "number"
              }
            }
          }
        },
        "packages": {
          "description": "Package list containing the parcel details",
          "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"
              }
            }
          }
        }
      }
    }
  },
  "example": {
    "order": {
      "order_date": "2018-11-15T01:51:49.2314399Z",
      "order_number": "10001",
      "reference": "Online Order",
      "shipping_method": "Express Shipping",
      "signature_required": false,
      "destination": {
        "name": "John Smith",
        "phone": "0290988227",
        "street": "20 George Street",
        "suburb": "Sydney",
        "state": "NSW",
        "post_code": "2000",
        "country": "Australia",
        "delivery_instructions": "Leave at door"
      },
      "items": [
        {
          "description": "Mobile Phone",
          "sku": "MOBILE",
          "quantity": 1,
          "weight": 0.65,
          "value": 125
        },
        {
          "description": "Mobile Case (Black)",
          "sku": "MOBILE-CASE-BLK",
          "quantity": 1,
          "weight": 0.05,
          "value": 20
        }
      ]
    }
  }
}
{
  "order": {
    "order_date": "2018-11-15T01:51:49.2314399Z",
    "order_number": "10001",
    "reference": "Online Order",
    "shipping_method": "Express Shipping",
    "signature_required": false,
    "destination": {
      "name": "John Smith",
      "phone": "0290988227",
      "street": "20 George Street",
      "suburb": "Sydney",
      "state": "NSW",
      "post_code": "2000",
      "country": "Australia",
      "delivery_instructions": "Leave at door"
    },
    "items": [
      {
        "description": "Mobile Phone",
        "sku": "MOBILE",
        "quantity": 1,
        "weight": 0.65,
        "value": 125
      },
      {
        "description": "Mobile Case (Black)",
        "sku": "MOBILE-CASE-BLK",
        "quantity": 1,
        "weight": 0.05,
        "value": 20
      }
    ]
  }
}
{
  "required": [
    "order"
  ],
  "type": "object",
  "properties": {
    "order": {
      "description": "The order details object",
      "required": [
        "order_number"
      ],
      "type": "object",
      "properties": {
        "order_id": {
          "format": "int32",
          "description": "The unique numeric identifier for the order.",
          "type": "integer"
        },
        "order_date": {
          "format": "date-time",
          "description": "The date when the order was created in UTC",
          "type": "string"
        },
        "order_number": {
          "description": "The identifier of the order pulled from source e-Commerce platform",
          "maxLength": 50,
          "minLength": 1,
          "type": "string"
        },
        "reference": {
          "description": "Customer's reference",
          "maxLength": 50,
          "minLength": 0,
          "type": "string"
        },
        "shipping_method": {
          "description": "Delivery method name",
          "maxLength": 100,
          "minLength": 0,
          "type": "string"
        },
        "shipping_description": {
          "description": "Delivery method description",
          "maxLength": 100,
          "minLength": 0,
          "type": "string"
        },
        "signature_required": {
          "description": "Determine whether signature is needed on delivery",
          "type": "boolean"
        },
        "currency": {
          "description": "Currency code for the order value (e.g. AUD)",
          "maxLength": 3,
          "minLength": 0,
          "type": "string"
        },
        "sender_details": {
          "description": "Pickup address and contact details",
          "required": [
            "name",
            "street",
            "suburb",
            "country"
          ],
          "type": "object",
          "properties": {
            "name": {
              "description": "Contact name of the sender",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "email": {
              "description": "Contact email address of the sender",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "phone": {
              "description": "Contact phone number of the sender",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "building": {
              "description": "Building name of the pickup address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "company": {
              "description": "Name of company that the parcel is being sent from",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "street": {
              "description": "Street number and name of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "suburb": {
              "description": "Suburb of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "city": {
              "description": "City of the pickup address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "state": {
              "description": "Regional, provincial or county name of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "post_code": {
              "description": "Postal or zip code of the pickup address",
              "maxLength": 10,
              "minLength": 0,
              "type": "string"
            },
            "country": {
              "description": "The country name of pickup address",
              "maxLength": 100,
              "minLength": 2,
              "type": "string"
            }
          }
        },
        "destination": {
          "description": "Shipping address and contact details",
          "required": [
            "name",
            "street",
            "suburb",
            "country"
          ],
          "type": "object",
          "properties": {
            "name": {
              "description": "Contact name of the receiver",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "email": {
              "description": "Contact email address of the receiver",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "phone": {
              "description": "Contact phone number of the receiver",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "building": {
              "description": "Building name of the delivery address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "company": {
              "description": "Name of company that the parcel is being delivered to",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "street": {
              "description": "Street number and name of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "suburb": {
              "description": "Suburb of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "city": {
              "description": "City of the delivery address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "state": {
              "description": "Regional, provincial or county name of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "post_code": {
              "description": "Postal or zip code of the delivery address",
              "maxLength": 10,
              "minLength": 0,
              "type": "string"
            },
            "country": {
              "description": "The country name of delivery address",
              "maxLength": 100,
              "minLength": 2,
              "type": "string"
            },
            "delivery_instructions": {
              "description": "Delivery instructions for courier",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            }
          }
        },
        "items": {
          "description": "Item list containing the order item details",
          "type": "array",
          "items": {
            "description": "Item list containing the order item details",
            "type": "object",
            "properties": {
              "description": {
                "description": "Product name or description",
                "type": "string"
              },
              "sku": {
                "description": "Product code or SKU",
                "maxLength": 50,
                "minLength": 0,
                "type": "string"
              },
              "tariff_code": {
                "description": "The harmonized system code that indicates the type of this order item",
                "maxLength": 18,
                "minLength": 0,
                "type": "string"
              },
              "country_of_origin": {
                "description": "The country in which this item was manufactured",
                "maxLength": 50,
                "minLength": 0,
                "type": "string"
              },
              "quantity": {
                "format": "double",
                "description": "The number of product ordered",
                "type": "number"
              },
              "weight": {
                "format": "double",
                "description": "Unit weight of the product in kilograms (kg)",
                "type": "number"
              },
              "value": {
                "format": "double",
                "description": "Unit price of the product",
                "type": "number"
              }
            }
          }
        },
        "packages": {
          "description": "Package list containing the parcel details",
          "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"
              }
            }
          }
        }
      }
    }
  },
  "example": {
    "order": {
      "order_date": "2018-11-15T01:51:49.2314399Z",
      "order_number": "10001",
      "reference": "Online Order",
      "shipping_method": "Express Shipping",
      "signature_required": false,
      "destination": {
        "name": "John Smith",
        "phone": "0290988227",
        "street": "20 George Street",
        "suburb": "Sydney",
        "state": "NSW",
        "post_code": "2000",
        "country": "Australia",
        "delivery_instructions": "Leave at door"
      },
      "items": [
        {
          "description": "Mobile Phone",
          "sku": "MOBILE",
          "quantity": 1,
          "weight": 0.65,
          "value": 125
        },
        {
          "description": "Mobile Case (Black)",
          "sku": "MOBILE-CASE-BLK",
          "quantity": 1,
          "weight": 0.05,
          "value": 20
        }
      ]
    }
  }
}

Response 200

OK

{
  "order": {
    "order_id": 1020304051,
    "order_date": "2018-11-15T01:51:49.2314399Z",
    "order_number": "10001",
    "reference": "Online Order",
    "carrier": "AusPost",
    "carrier_name": "Australia Post",
    "carrier_service_code": "7B05",
    "shipping_method": "Express Shipping",
    "signature_required": false,
    "destination": {
      "name": "John Smith",
      "phone": "0290988227",
      "street": "20 George Street",
      "suburb": "Sydney",
      "state": "NSW",
      "post_code": "2000",
      "country": "Australia",
      "delivery_instructions": "Leave at door"
    },
    "items": [
      {
        "item_id": 1065580746,
        "description": "Mobile Phone",
        "sku": "MOBILE",
        "quantity": 1,
        "quantity_to_ship": 0,
        "weight": 0.65,
        "value": 125
      },
      {
        "item_id": 1065580747,
        "description": "Mobile Case (Black)",
        "sku": "MOBILE-CASE-BLK",
        "quantity": 1,
        "quantity_to_ship": 0,
        "weight": 0.05,
        "value": 20
      }
    ],
    "packages": [
      {
        "package_id": 1035548017,
        "weight": 0.7,
        "height": 0.04,
        "width": 0.08,
        "length": 0.12
      }
    ]
  },
  "success": true
}
{
  "type": "object",
  "properties": {
    "order": {
      "description": "The details of the created order",
      "type": "object",
      "properties": {
        "order_id": {
          "format": "int32",
          "description": "The unique numeric identifier for the order.",
          "type": "integer"
        },
        "order_date": {
          "format": "date-time",
          "description": "The date when the order was created in UTC",
          "type": "string"
        },
        "order_number": {
          "description": "The identifier of the order pulled from source e-Commerce platform",
          "maxLength": 50,
          "minLength": 0,
          "type": "string"
        },
        "reference": {
          "description": "Customer's reference",
          "maxLength": 50,
          "minLength": 0,
          "type": "string"
        },
        "carrier": {
          "description": "The carrier that will be used when creating shipment",
          "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",
            "None"
          ],
          "type": "string"
        },
        "carrier_name": {
          "description": "Name of the carrier used for shipment delivery",
          "type": "string"
        },
        "carrier_service_code": {
          "description": "Carrier service code for delivery",
          "type": "string"
        },
        "shipping_method": {
          "description": "Delivery method name",
          "maxLength": 100,
          "minLength": 0,
          "type": "string"
        },
        "shipping_description": {
          "description": "Delivery method description",
          "maxLength": 100,
          "minLength": 0,
          "type": "string"
        },
        "signature_required": {
          "description": "Determine whether signature is needed on delivery",
          "type": "boolean"
        },
        "currency": {
          "description": "Currency code for the order value (e.g. AUD)",
          "maxLength": 3,
          "minLength": 0,
          "type": "string"
        },
        "sender_details": {
          "description": "Pickup address and contact details",
          "required": [
            "name",
            "street",
            "suburb",
            "country"
          ],
          "type": "object",
          "properties": {
            "name": {
              "description": "Contact name of the sender",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "email": {
              "description": "Contact email address of the sender",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "phone": {
              "description": "Contact phone number of the sender",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "building": {
              "description": "Building name of the pickup address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "company": {
              "description": "Name of company that the parcel is being sent from",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "street": {
              "description": "Street number and name of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "suburb": {
              "description": "Suburb of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "city": {
              "description": "City of the pickup address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "state": {
              "description": "Regional, provincial or county name of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "post_code": {
              "description": "Postal or zip code of the pickup address",
              "maxLength": 10,
              "minLength": 0,
              "type": "string"
            },
            "country": {
              "description": "The country name of pickup address",
              "maxLength": 100,
              "minLength": 2,
              "type": "string"
            }
          }
        },
        "destination": {
          "description": "Shipping address and contact details",
          "required": [
            "name",
            "street",
            "suburb",
            "country"
          ],
          "type": "object",
          "properties": {
            "name": {
              "description": "Contact name of the receiver",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "email": {
              "description": "Contact email address of the receiver",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "phone": {
              "description": "Contact phone number of the receiver",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "building": {
              "description": "Building name of the delivery address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "company": {
              "description": "Name of company that the parcel is being delivered to",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "street": {
              "description": "Street number and name of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "suburb": {
              "description": "Suburb of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "city": {
              "description": "City of the delivery address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "state": {
              "description": "Regional, provincial or county name of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "post_code": {
              "description": "Postal or zip code of the delivery address",
              "maxLength": 10,
              "minLength": 0,
              "type": "string"
            },
            "country": {
              "description": "The country name of delivery address",
              "maxLength": 100,
              "minLength": 2,
              "type": "string"
            },
            "delivery_instructions": {
              "description": "Delivery instructions for courier",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            }
          }
        },
        "items": {
          "description": "Item list containing the order item details",
          "type": "array",
          "items": {
            "description": "Item list containing the order item details",
            "type": "object",
            "properties": {
              "item_id": {
                "format": "int32",
                "description": "The unique numeric identifier for the order item.",
                "type": "integer"
              },
              "description": {
                "description": "Product name or description",
                "type": "string"
              },
              "sku": {
                "description": "Product code or SKU",
                "maxLength": 50,
                "minLength": 0,
                "type": "string"
              },
              "tariff_code": {
                "description": "The harmonized system code that indicates the type of this order item",
                "maxLength": 18,
                "minLength": 0,
                "type": "string"
              },
              "country_of_origin": {
                "description": "The country in which this item was manufactured",
                "maxLength": 50,
                "minLength": 0,
                "type": "string"
              },
              "quantity": {
                "format": "int32",
                "description": "The number of product ordered",
                "type": "integer"
              },
              "quantity_to_ship": {
                "format": "int32",
                "description": "The number of items to ship",
                "type": "integer"
              },
              "weight": {
                "format": "double",
                "description": "Unit weight of the product in kilograms (kg)",
                "type": "number"
              },
              "value": {
                "format": "double",
                "description": "Unit price of the product",
                "type": "number"
              }
            }
          }
        },
        "packages": {
          "description": "Package list containing the parcel details",
          "type": "array",
          "items": {
            "description": "Package list containing the parcel details",
            "type": "object",
            "properties": {
              "package_id": {
                "format": "int32",
                "description": "The unique numeric identifier for the package.",
                "type": "integer"
              },
              "name": {
                "description": "Name of the package",
                "type": "string"
              },
              "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"
              },
              "packaging_type": {
                "description": "The packaging type for this parcel. Example valid values: Carton, Box, Envelope, Item, Jiffy, Pallet, Satchel, Skid or Bag.",
                "type": "string"
              },
              "carrier_service_code": {
                "description": "Carrier service code for delivery",
                "type": "string"
              },
              "carrier_service_name": {
                "description": "Carrier service name for delivery",
                "type": "string"
              },
              "tracking_number": {
                "description": "Carrier tracking number",
                "type": "string"
              },
              "tracking_url": {
                "description": "Carrier tracking url",
                "type": "string"
              },
              "delivery_status": {
                "description": "Current delivery status of this parcel",
                "type": "string"
              },
              "shipment_type": {
                "description": "Type of shipment: outgoing, return or transfer",
                "type": "string"
              },
              "label_created_date": {
                "format": "date-time",
                "description": "The date and time when the label was generated in UTC",
                "type": "string"
              },
              "labels": {
                "description": "List of label files associated with this package",
                "type": "array",
                "items": {
                  "description": "The details of the label",
                  "type": "object",
                  "properties": {
                    "label_type": {
                      "type": "string"
                    },
                    "label_url": {
                      "type": "string"
                    },
                    "label_base64_string": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "metadatas": {
          "description": "Additional meta data for the order",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "metafield_key": {
                "description": "The unique identifier for the meta field key",
                "type": "string"
              },
              "value": {
                "description": "The information stored for the meta field",
                "type": "string"
              }
            }
          }
        },
        "events": {
          "description": "Historical events associated with this order",
          "type": "array",
          "items": {
            "description": "Historical event associated with the order",
            "type": "object",
            "properties": {
              "time": {
                "format": "date-time",
                "type": "string"
              },
              "category": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "method": {
                "type": "string"
              },
              "description": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}
{
  "order": {
    "order_id": 0,
    "order_date": "string",
    "order_number": "string",
    "reference": "string",
    "carrier": "CourierPost",
    "carrier_name": "string",
    "carrier_service_code": "string",
    "shipping_method": "string",
    "shipping_description": "string",
    "signature_required": true,
    "currency": "string",
    "sender_details": {
      "name": "string",
      "email": "string",
      "phone": "string",
      "building": "string",
      "company": "string",
      "street": "string",
      "suburb": "string",
      "city": "string",
      "state": "string",
      "post_code": "string",
      "country": "string"
    },
    "destination": {
      "name": "string",
      "email": "string",
      "phone": "string",
      "building": "string",
      "company": "string",
      "street": "string",
      "suburb": "string",
      "city": "string",
      "state": "string",
      "post_code": "string",
      "country": "string",
      "delivery_instructions": "string"
    },
    "items": [
      {
        "item_id": 0,
        "description": "string",
        "sku": "string",
        "tariff_code": "string",
        "country_of_origin": "string",
        "quantity": 0,
        "quantity_to_ship": 0,
        "weight": 0.0,
        "value": 0.0
      }
    ],
    "packages": [
      {
        "package_id": 0,
        "name": "string",
        "weight": 0.0,
        "height": 0.0,
        "width": 0.0,
        "length": 0.0,
        "packaging_type": "string",
        "carrier_service_code": "string",
        "carrier_service_name": "string",
        "tracking_number": "string",
        "tracking_url": "string",
        "delivery_status": "string",
        "shipment_type": "string",
        "label_created_date": "string",
        "labels": [
          {
            "label_type": "string",
            "label_url": "string",
            "label_base64_string": "string"
          }
        ]
      }
    ],
    "metadatas": [
      {
        "metafield_key": "string",
        "value": "string"
      }
    ],
    "events": [
      {
        "time": "string",
        "category": "string",
        "name": "string",
        "method": "string",
        "description": "string"
      }
    ]
  },
  "success": true,
  "errors": [
    {
      "message": "string",
      "details": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "order": {
      "description": "The details of the created order",
      "type": "object",
      "properties": {
        "order_id": {
          "format": "int32",
          "description": "The unique numeric identifier for the order.",
          "type": "integer"
        },
        "order_date": {
          "format": "date-time",
          "description": "The date when the order was created in UTC",
          "type": "string"
        },
        "order_number": {
          "description": "The identifier of the order pulled from source e-Commerce platform",
          "maxLength": 50,
          "minLength": 0,
          "type": "string"
        },
        "reference": {
          "description": "Customer's reference",
          "maxLength": 50,
          "minLength": 0,
          "type": "string"
        },
        "carrier": {
          "description": "The carrier that will be used when creating shipment",
          "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",
            "None"
          ],
          "type": "string"
        },
        "carrier_name": {
          "description": "Name of the carrier used for shipment delivery",
          "type": "string"
        },
        "carrier_service_code": {
          "description": "Carrier service code for delivery",
          "type": "string"
        },
        "shipping_method": {
          "description": "Delivery method name",
          "maxLength": 100,
          "minLength": 0,
          "type": "string"
        },
        "shipping_description": {
          "description": "Delivery method description",
          "maxLength": 100,
          "minLength": 0,
          "type": "string"
        },
        "signature_required": {
          "description": "Determine whether signature is needed on delivery",
          "type": "boolean"
        },
        "currency": {
          "description": "Currency code for the order value (e.g. AUD)",
          "maxLength": 3,
          "minLength": 0,
          "type": "string"
        },
        "sender_details": {
          "description": "Pickup address and contact details",
          "required": [
            "name",
            "street",
            "suburb",
            "country"
          ],
          "type": "object",
          "properties": {
            "name": {
              "description": "Contact name of the sender",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "email": {
              "description": "Contact email address of the sender",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "phone": {
              "description": "Contact phone number of the sender",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "building": {
              "description": "Building name of the pickup address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "company": {
              "description": "Name of company that the parcel is being sent from",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "street": {
              "description": "Street number and name of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "suburb": {
              "description": "Suburb of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "city": {
              "description": "City of the pickup address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "state": {
              "description": "Regional, provincial or county name of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "post_code": {
              "description": "Postal or zip code of the pickup address",
              "maxLength": 10,
              "minLength": 0,
              "type": "string"
            },
            "country": {
              "description": "The country name of pickup address",
              "maxLength": 100,
              "minLength": 2,
              "type": "string"
            }
          }
        },
        "destination": {
          "description": "Shipping address and contact details",
          "required": [
            "name",
            "street",
            "suburb",
            "country"
          ],
          "type": "object",
          "properties": {
            "name": {
              "description": "Contact name of the receiver",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "email": {
              "description": "Contact email address of the receiver",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "phone": {
              "description": "Contact phone number of the receiver",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "building": {
              "description": "Building name of the delivery address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "company": {
              "description": "Name of company that the parcel is being delivered to",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "street": {
              "description": "Street number and name of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "suburb": {
              "description": "Suburb of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "city": {
              "description": "City of the delivery address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "state": {
              "description": "Regional, provincial or county name of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "post_code": {
              "description": "Postal or zip code of the delivery address",
              "maxLength": 10,
              "minLength": 0,
              "type": "string"
            },
            "country": {
              "description": "The country name of delivery address",
              "maxLength": 100,
              "minLength": 2,
              "type": "string"
            },
            "delivery_instructions": {
              "description": "Delivery instructions for courier",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            }
          }
        },
        "items": {
          "description": "Item list containing the order item details",
          "type": "array",
          "items": {
            "description": "Item list containing the order item details",
            "type": "object",
            "properties": {
              "item_id": {
                "format": "int32",
                "description": "The unique numeric identifier for the order item.",
                "type": "integer"
              },
              "description": {
                "description": "Product name or description",
                "type": "string"
              },
              "sku": {
                "description": "Product code or SKU",
                "maxLength": 50,
                "minLength": 0,
                "type": "string"
              },
              "tariff_code": {
                "description": "The harmonized system code that indicates the type of this order item",
                "maxLength": 18,
                "minLength": 0,
                "type": "string"
              },
              "country_of_origin": {
                "description": "The country in which this item was manufactured",
                "maxLength": 50,
                "minLength": 0,
                "type": "string"
              },
              "quantity": {
                "format": "int32",
                "description": "The number of product ordered",
                "type": "integer"
              },
              "quantity_to_ship": {
                "format": "int32",
                "description": "The number of items to ship",
                "type": "integer"
              },
              "weight": {
                "format": "double",
                "description": "Unit weight of the product in kilograms (kg)",
                "type": "number"
              },
              "value": {
                "format": "double",
                "description": "Unit price of the product",
                "type": "number"
              }
            }
          }
        },
        "packages": {
          "description": "Package list containing the parcel details",
          "type": "array",
          "items": {
            "description": "Package list containing the parcel details",
            "type": "object",
            "properties": {
              "package_id": {
                "format": "int32",
                "description": "The unique numeric identifier for the package.",
                "type": "integer"
              },
              "name": {
                "description": "Name of the package",
                "type": "string"
              },
              "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"
              },
              "packaging_type": {
                "description": "The packaging type for this parcel. Example valid values: Carton, Box, Envelope, Item, Jiffy, Pallet, Satchel, Skid or Bag.",
                "type": "string"
              },
              "carrier_service_code": {
                "description": "Carrier service code for delivery",
                "type": "string"
              },
              "carrier_service_name": {
                "description": "Carrier service name for delivery",
                "type": "string"
              },
              "tracking_number": {
                "description": "Carrier tracking number",
                "type": "string"
              },
              "tracking_url": {
                "description": "Carrier tracking url",
                "type": "string"
              },
              "delivery_status": {
                "description": "Current delivery status of this parcel",
                "type": "string"
              },
              "shipment_type": {
                "description": "Type of shipment: outgoing, return or transfer",
                "type": "string"
              },
              "label_created_date": {
                "format": "date-time",
                "description": "The date and time when the label was generated in UTC",
                "type": "string"
              },
              "labels": {
                "description": "List of label files associated with this package",
                "type": "array",
                "items": {
                  "description": "The details of the label",
                  "type": "object",
                  "properties": {
                    "label_type": {
                      "type": "string"
                    },
                    "label_url": {
                      "type": "string"
                    },
                    "label_base64_string": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "metadatas": {
          "description": "Additional meta data for the order",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "metafield_key": {
                "description": "The unique identifier for the meta field key",
                "type": "string"
              },
              "value": {
                "description": "The information stored for the meta field",
                "type": "string"
              }
            }
          }
        },
        "events": {
          "description": "Historical events associated with this order",
          "type": "array",
          "items": {
            "description": "Historical event associated with the order",
            "type": "object",
            "properties": {
              "time": {
                "format": "date-time",
                "type": "string"
              },
              "category": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "method": {
                "type": "string"
              },
              "description": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}
<CreateOrderResponse>
  <order>
    <order_id>0</order_id>
    <order_date>string</order_date>
    <order_number>string</order_number>
    <reference>string</reference>
    <carrier>CourierPost</carrier>
    <carrier_name>string</carrier_name>
    <carrier_service_code>string</carrier_service_code>
    <shipping_method>string</shipping_method>
    <shipping_description>string</shipping_description>
    <signature_required>true</signature_required>
    <currency>string</currency>
    <sender_details>
      <name>string</name>
      <email>string</email>
      <phone>string</phone>
      <building>string</building>
      <company>string</company>
      <street>string</street>
      <suburb>string</suburb>
      <city>string</city>
      <state>string</state>
      <post_code>string</post_code>
      <country>string</country>
    </sender_details>
    <destination>
      <name>string</name>
      <email>string</email>
      <phone>string</phone>
      <building>string</building>
      <company>string</company>
      <street>string</street>
      <suburb>string</suburb>
      <city>string</city>
      <state>string</state>
      <post_code>string</post_code>
      <country>string</country>
      <delivery_instructions>string</delivery_instructions>
    </destination>
    <items>
      <item_id>0</item_id>
      <description>string</description>
      <sku>string</sku>
      <tariff_code>string</tariff_code>
      <country_of_origin>string</country_of_origin>
      <quantity>0</quantity>
      <quantity_to_ship>0</quantity_to_ship>
      <weight>0</weight>
      <value>0</value>
    </items>
    <packages>
      <package_id>0</package_id>
      <name>string</name>
      <weight>0</weight>
      <height>0</height>
      <width>0</width>
      <length>0</length>
      <packaging_type>string</packaging_type>
      <carrier_service_code>string</carrier_service_code>
      <carrier_service_name>string</carrier_service_name>
      <tracking_number>string</tracking_number>
      <tracking_url>string</tracking_url>
      <delivery_status>string</delivery_status>
      <shipment_type>string</shipment_type>
      <label_created_date>string</label_created_date>
      <labels>
        <label_type>string</label_type>
        <label_url>string</label_url>
        <label_base64_string>string</label_base64_string>
      </labels>
    </packages>
    <metadatas>
      <metafield_key>string</metafield_key>
      <value>string</value>
    </metadatas>
    <events>
      <time>string</time>
      <category>string</category>
      <name>string</name>
      <method>string</method>
      <description>string</description>
    </events>
  </order>
  <success>true</success>
  <errors>
    <message>string</message>
    <details>string</details>
  </errors>
</CreateOrderResponse>
{
  "type": "object",
  "properties": {
    "order": {
      "description": "The details of the created order",
      "type": "object",
      "properties": {
        "order_id": {
          "format": "int32",
          "description": "The unique numeric identifier for the order.",
          "type": "integer"
        },
        "order_date": {
          "format": "date-time",
          "description": "The date when the order was created in UTC",
          "type": "string"
        },
        "order_number": {
          "description": "The identifier of the order pulled from source e-Commerce platform",
          "maxLength": 50,
          "minLength": 0,
          "type": "string"
        },
        "reference": {
          "description": "Customer's reference",
          "maxLength": 50,
          "minLength": 0,
          "type": "string"
        },
        "carrier": {
          "description": "The carrier that will be used when creating shipment",
          "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",
            "None"
          ],
          "type": "string"
        },
        "carrier_name": {
          "description": "Name of the carrier used for shipment delivery",
          "type": "string"
        },
        "carrier_service_code": {
          "description": "Carrier service code for delivery",
          "type": "string"
        },
        "shipping_method": {
          "description": "Delivery method name",
          "maxLength": 100,
          "minLength": 0,
          "type": "string"
        },
        "shipping_description": {
          "description": "Delivery method description",
          "maxLength": 100,
          "minLength": 0,
          "type": "string"
        },
        "signature_required": {
          "description": "Determine whether signature is needed on delivery",
          "type": "boolean"
        },
        "currency": {
          "description": "Currency code for the order value (e.g. AUD)",
          "maxLength": 3,
          "minLength": 0,
          "type": "string"
        },
        "sender_details": {
          "description": "Pickup address and contact details",
          "required": [
            "name",
            "street",
            "suburb",
            "country"
          ],
          "type": "object",
          "properties": {
            "name": {
              "description": "Contact name of the sender",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "email": {
              "description": "Contact email address of the sender",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "phone": {
              "description": "Contact phone number of the sender",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "building": {
              "description": "Building name of the pickup address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "company": {
              "description": "Name of company that the parcel is being sent from",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "street": {
              "description": "Street number and name of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "suburb": {
              "description": "Suburb of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "city": {
              "description": "City of the pickup address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "state": {
              "description": "Regional, provincial or county name of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "post_code": {
              "description": "Postal or zip code of the pickup address",
              "maxLength": 10,
              "minLength": 0,
              "type": "string"
            },
            "country": {
              "description": "The country name of pickup address",
              "maxLength": 100,
              "minLength": 2,
              "type": "string"
            }
          }
        },
        "destination": {
          "description": "Shipping address and contact details",
          "required": [
            "name",
            "street",
            "suburb",
            "country"
          ],
          "type": "object",
          "properties": {
            "name": {
              "description": "Contact name of the receiver",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "email": {
              "description": "Contact email address of the receiver",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "phone": {
              "description": "Contact phone number of the receiver",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "building": {
              "description": "Building name of the delivery address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "company": {
              "description": "Name of company that the parcel is being delivered to",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "street": {
              "description": "Street number and name of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "suburb": {
              "description": "Suburb of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "city": {
              "description": "City of the delivery address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "state": {
              "description": "Regional, provincial or county name of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "post_code": {
              "description": "Postal or zip code of the delivery address",
              "maxLength": 10,
              "minLength": 0,
              "type": "string"
            },
            "country": {
              "description": "The country name of delivery address",
              "maxLength": 100,
              "minLength": 2,
              "type": "string"
            },
            "delivery_instructions": {
              "description": "Delivery instructions for courier",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            }
          }
        },
        "items": {
          "description": "Item list containing the order item details",
          "type": "array",
          "items": {
            "description": "Item list containing the order item details",
            "type": "object",
            "properties": {
              "item_id": {
                "format": "int32",
                "description": "The unique numeric identifier for the order item.",
                "type": "integer"
              },
              "description": {
                "description": "Product name or description",
                "type": "string"
              },
              "sku": {
                "description": "Product code or SKU",
                "maxLength": 50,
                "minLength": 0,
                "type": "string"
              },
              "tariff_code": {
                "description": "The harmonized system code that indicates the type of this order item",
                "maxLength": 18,
                "minLength": 0,
                "type": "string"
              },
              "country_of_origin": {
                "description": "The country in which this item was manufactured",
                "maxLength": 50,
                "minLength": 0,
                "type": "string"
              },
              "quantity": {
                "format": "int32",
                "description": "The number of product ordered",
                "type": "integer"
              },
              "quantity_to_ship": {
                "format": "int32",
                "description": "The number of items to ship",
                "type": "integer"
              },
              "weight": {
                "format": "double",
                "description": "Unit weight of the product in kilograms (kg)",
                "type": "number"
              },
              "value": {
                "format": "double",
                "description": "Unit price of the product",
                "type": "number"
              }
            }
          }
        },
        "packages": {
          "description": "Package list containing the parcel details",
          "type": "array",
          "items": {
            "description": "Package list containing the parcel details",
            "type": "object",
            "properties": {
              "package_id": {
                "format": "int32",
                "description": "The unique numeric identifier for the package.",
                "type": "integer"
              },
              "name": {
                "description": "Name of the package",
                "type": "string"
              },
              "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"
              },
              "packaging_type": {
                "description": "The packaging type for this parcel. Example valid values: Carton, Box, Envelope, Item, Jiffy, Pallet, Satchel, Skid or Bag.",
                "type": "string"
              },
              "carrier_service_code": {
                "description": "Carrier service code for delivery",
                "type": "string"
              },
              "carrier_service_name": {
                "description": "Carrier service name for delivery",
                "type": "string"
              },
              "tracking_number": {
                "description": "Carrier tracking number",
                "type": "string"
              },
              "tracking_url": {
                "description": "Carrier tracking url",
                "type": "string"
              },
              "delivery_status": {
                "description": "Current delivery status of this parcel",
                "type": "string"
              },
              "shipment_type": {
                "description": "Type of shipment: outgoing, return or transfer",
                "type": "string"
              },
              "label_created_date": {
                "format": "date-time",
                "description": "The date and time when the label was generated in UTC",
                "type": "string"
              },
              "labels": {
                "description": "List of label files associated with this package",
                "type": "array",
                "items": {
                  "description": "The details of the label",
                  "type": "object",
                  "properties": {
                    "label_type": {
                      "type": "string"
                    },
                    "label_url": {
                      "type": "string"
                    },
                    "label_base64_string": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "metadatas": {
          "description": "Additional meta data for the order",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "metafield_key": {
                "description": "The unique identifier for the meta field key",
                "type": "string"
              },
              "value": {
                "description": "The information stored for the meta field",
                "type": "string"
              }
            }
          }
        },
        "events": {
          "description": "Historical events associated with this order",
          "type": "array",
          "items": {
            "description": "Historical event associated with the order",
            "type": "object",
            "properties": {
              "time": {
                "format": "date-time",
                "type": "string"
              },
              "category": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "method": {
                "type": "string"
              },
              "description": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}
<CreateOrderResponse>
  <order>
    <order_id>0</order_id>
    <order_date>string</order_date>
    <order_number>string</order_number>
    <reference>string</reference>
    <carrier>CourierPost</carrier>
    <carrier_name>string</carrier_name>
    <carrier_service_code>string</carrier_service_code>
    <shipping_method>string</shipping_method>
    <shipping_description>string</shipping_description>
    <signature_required>true</signature_required>
    <currency>string</currency>
    <sender_details>
      <name>string</name>
      <email>string</email>
      <phone>string</phone>
      <building>string</building>
      <company>string</company>
      <street>string</street>
      <suburb>string</suburb>
      <city>string</city>
      <state>string</state>
      <post_code>string</post_code>
      <country>string</country>
    </sender_details>
    <destination>
      <name>string</name>
      <email>string</email>
      <phone>string</phone>
      <building>string</building>
      <company>string</company>
      <street>string</street>
      <suburb>string</suburb>
      <city>string</city>
      <state>string</state>
      <post_code>string</post_code>
      <country>string</country>
      <delivery_instructions>string</delivery_instructions>
    </destination>
    <items>
      <item_id>0</item_id>
      <description>string</description>
      <sku>string</sku>
      <tariff_code>string</tariff_code>
      <country_of_origin>string</country_of_origin>
      <quantity>0</quantity>
      <quantity_to_ship>0</quantity_to_ship>
      <weight>0</weight>
      <value>0</value>
    </items>
    <packages>
      <package_id>0</package_id>
      <name>string</name>
      <weight>0</weight>
      <height>0</height>
      <width>0</width>
      <length>0</length>
      <packaging_type>string</packaging_type>
      <carrier_service_code>string</carrier_service_code>
      <carrier_service_name>string</carrier_service_name>
      <tracking_number>string</tracking_number>
      <tracking_url>string</tracking_url>
      <delivery_status>string</delivery_status>
      <shipment_type>string</shipment_type>
      <label_created_date>string</label_created_date>
      <labels>
        <label_type>string</label_type>
        <label_url>string</label_url>
        <label_base64_string>string</label_base64_string>
      </labels>
    </packages>
    <metadatas>
      <metafield_key>string</metafield_key>
      <value>string</value>
    </metadatas>
    <events>
      <time>string</time>
      <category>string</category>
      <name>string</name>
      <method>string</method>
      <description>string</description>
    </events>
  </order>
  <success>true</success>
  <errors>
    <message>string</message>
    <details>string</details>
  </errors>
</CreateOrderResponse>
{
  "type": "object",
  "properties": {
    "order": {
      "description": "The details of the created order",
      "type": "object",
      "properties": {
        "order_id": {
          "format": "int32",
          "description": "The unique numeric identifier for the order.",
          "type": "integer"
        },
        "order_date": {
          "format": "date-time",
          "description": "The date when the order was created in UTC",
          "type": "string"
        },
        "order_number": {
          "description": "The identifier of the order pulled from source e-Commerce platform",
          "maxLength": 50,
          "minLength": 0,
          "type": "string"
        },
        "reference": {
          "description": "Customer's reference",
          "maxLength": 50,
          "minLength": 0,
          "type": "string"
        },
        "carrier": {
          "description": "The carrier that will be used when creating shipment",
          "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",
            "None"
          ],
          "type": "string"
        },
        "carrier_name": {
          "description": "Name of the carrier used for shipment delivery",
          "type": "string"
        },
        "carrier_service_code": {
          "description": "Carrier service code for delivery",
          "type": "string"
        },
        "shipping_method": {
          "description": "Delivery method name",
          "maxLength": 100,
          "minLength": 0,
          "type": "string"
        },
        "shipping_description": {
          "description": "Delivery method description",
          "maxLength": 100,
          "minLength": 0,
          "type": "string"
        },
        "signature_required": {
          "description": "Determine whether signature is needed on delivery",
          "type": "boolean"
        },
        "currency": {
          "description": "Currency code for the order value (e.g. AUD)",
          "maxLength": 3,
          "minLength": 0,
          "type": "string"
        },
        "sender_details": {
          "description": "Pickup address and contact details",
          "required": [
            "name",
            "street",
            "suburb",
            "country"
          ],
          "type": "object",
          "properties": {
            "name": {
              "description": "Contact name of the sender",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "email": {
              "description": "Contact email address of the sender",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "phone": {
              "description": "Contact phone number of the sender",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "building": {
              "description": "Building name of the pickup address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "company": {
              "description": "Name of company that the parcel is being sent from",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "street": {
              "description": "Street number and name of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "suburb": {
              "description": "Suburb of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "city": {
              "description": "City of the pickup address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "state": {
              "description": "Regional, provincial or county name of the pickup address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "post_code": {
              "description": "Postal or zip code of the pickup address",
              "maxLength": 10,
              "minLength": 0,
              "type": "string"
            },
            "country": {
              "description": "The country name of pickup address",
              "maxLength": 100,
              "minLength": 2,
              "type": "string"
            }
          }
        },
        "destination": {
          "description": "Shipping address and contact details",
          "required": [
            "name",
            "street",
            "suburb",
            "country"
          ],
          "type": "object",
          "properties": {
            "name": {
              "description": "Contact name of the receiver",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "email": {
              "description": "Contact email address of the receiver",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "phone": {
              "description": "Contact phone number of the receiver",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "building": {
              "description": "Building name of the delivery address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "company": {
              "description": "Name of company that the parcel is being delivered to",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "street": {
              "description": "Street number and name of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "suburb": {
              "description": "Suburb of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "city": {
              "description": "City of the delivery address",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            },
            "state": {
              "description": "Regional, provincial or county name of the delivery address",
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "post_code": {
              "description": "Postal or zip code of the delivery address",
              "maxLength": 10,
              "minLength": 0,
              "type": "string"
            },
            "country": {
              "description": "The country name of delivery address",
              "maxLength": 100,
              "minLength": 2,
              "type": "string"
            },
            "delivery_instructions": {
              "description": "Delivery instructions for courier",
              "maxLength": 100,
              "minLength": 0,
              "type": "string"
            }
          }
        },
        "items": {
          "description": "Item list containing the order item details",
          "type": "array",
          "items": {
            "description": "Item list containing the order item details",
            "type": "object",
            "properties": {
              "item_id": {
                "format": "int32",
                "description": "The unique numeric identifier for the order item.",
                "type": "integer"
              },
              "description": {
                "description": "Product name or description",
                "type": "string"
              },
              "sku": {
                "description": "Product code or SKU",
                "maxLength": 50,
                "minLength": 0,
                "type": "string"
              },
              "tariff_code": {
                "description": "The harmonized system code that indicates the type of this order item",
                "maxLength": 18,
                "minLength": 0,
                "type": "string"
              },
              "country_of_origin": {
                "description": "The country in which this item was manufactured",
                "maxLength": 50,
                "minLength": 0,
                "type": "string"
              },
              "quantity": {
                "format": "int32",
                "description": "The number of product ordered",
                "type": "integer"
              },
              "quantity_to_ship": {
                "format": "int32",
                "description": "The number of items to ship",
                "type": "integer"
              },
              "weight": {
                "format": "double",
                "description": "Unit weight of the product in kilograms (kg)",
                "type": "number"
              },
              "value": {
                "format": "double",
                "description": "Unit price of the product",
                "type": "number"
              }
            }
          }
        },
        "packages": {
          "description": "Package list containing the parcel details",
          "type": "array",
          "items": {
            "description": "Package list containing the parcel details",
            "type": "object",
            "properties": {
              "package_id": {
                "format": "int32",
                "description": "The unique numeric identifier for the package.",
                "type": "integer"
              },
              "name": {
                "description": "Name of the package",
                "type": "string"
              },
              "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"
              },
              "packaging_type": {
                "description": "The packaging type for this parcel. Example valid values: Carton, Box, Envelope, Item, Jiffy, Pallet, Satchel, Skid or Bag.",
                "type": "string"
              },
              "carrier_service_code": {
                "description": "Carrier service code for delivery",
                "type": "string"
              },
              "carrier_service_name": {
                "description": "Carrier service name for delivery",
                "type": "string"
              },
              "tracking_number": {
                "description": "Carrier tracking number",
                "type": "string"
              },
              "tracking_url": {
                "description": "Carrier tracking url",
                "type": "string"
              },
              "delivery_status": {
                "description": "Current delivery status of this parcel",
                "type": "string"
              },
              "shipment_type": {
                "description": "Type of shipment: outgoing, return or transfer",
                "type": "string"
              },
              "label_created_date": {
                "format": "date-time",
                "description": "The date and time when the label was generated in UTC",
                "type": "string"
              },
              "labels": {
                "description": "List of label files associated with this package",
                "type": "array",
                "items": {
                  "description": "The details of the label",
                  "type": "object",
                  "properties": {
                    "label_type": {
                      "type": "string"
                    },
                    "label_url": {
                      "type": "string"
                    },
                    "label_base64_string": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "metadatas": {
          "description": "Additional meta data for the order",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "metafield_key": {
                "description": "The unique identifier for the meta field key",
                "type": "string"
              },
              "value": {
                "description": "The information stored for the meta field",
                "type": "string"
              }
            }
          }
        },
        "events": {
          "description": "Historical events associated with this order",
          "type": "array",
          "items": {
            "description": "Historical event associated with the order",
            "type": "object",
            "properties": {
              "time": {
                "format": "date-time",
                "type": "string"
              },
              "category": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "method": {
                "type": "string"
              },
              "description": {
                "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/orders"
-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/orders?" + 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/orders");


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


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