> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://api-docs.zippd.com/llms.txt. > For full documentation content, see https://api-docs.zippd.com/llms-full.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api-docs.zippd.com/_mcp/server. # Add a Location to an Order POST https://sandbox-api.deliveryapp.com/api/v1/orders-ecommerce/{orderId}/locations Content-Type: application/json Reference: https://api-docs.zippd.com/orders-e-commerce/post-api-v-1-orders-ecommerce-order-id-locations ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: collection version: 1.0.0 paths: /orders-ecommerce/{orderId}/locations: post: operationId: post-api-v-1-orders-ecommerce-order-id-locations summary: Add a Location to an Order description: '' tags: - subpackage_ordersECommerce parameters: - name: orderId in: path required: true schema: type: string - name: Authorization in: header description: '' required: true schema: type: string responses: '201': description: '' content: application/json: schema: $ref: >- #/components/schemas/Orders - eCommerce_post-api-v1-orders-ecommerce-orderId-locations_Response_201 '403': description: Forbidden content: application/json: schema: $ref: >- #/components/schemas/Post-api-v1-orders-ecommerce-orderId-locationsRequestForbiddenError '422': description: Invalid data was sent with the request content: application/json: schema: $ref: >- #/components/schemas/Post-api-v1-orders-ecommerce-orderId-locationsRequestUnprocessableEntityError requestBody: content: application/json: schema: type: object properties: item_count: type: integer description: The total number of items being delivered to this location. cost_of_goods: type: integer description: >- The total value (or a rough estimate) of all goods being delivered to this location. Value must be in lowest unit of currency, i.e. in pence for GBP. Defaults to `0` if not provided. Required if `item_count` is not empty. address: $ref: >- #/components/schemas/OrdersEcommerceOrderIdLocationsPostRequestBodyContentApplicationJsonSchemaAddress required: - address servers: - url: https://sandbox-api.deliveryapp.com/api/v1 components: schemas: OrdersEcommerceOrderIdLocationsPostRequestBodyContentApplicationJsonSchemaAddress: type: object properties: address_line_1: type: string description: The first line of the location's address. address_line_2: type: string description: The second line of the location's address. city: type: string description: The city of the location's address. postcode: type: string description: The postal code of the location's address. latitude: type: number format: double description: The latitude coordinate of the location's address. longitude: type: number format: double description: The longitude coordinate of the location's address. contact_name: type: string description: A contact name for the location. phone_number: type: string description: >- A contact number for this location that may be used by the delivery driver. email: type: string description: >- A contact email for the recipient. This may be used to provide delivery tracking updates to the recipient. company_name: type: string description: The name of the company at this location. required: - address_line_1 - city - postcode - latitude - longitude - contact_name - phone_number - email title: >- OrdersEcommerceOrderIdLocationsPostRequestBodyContentApplicationJsonSchemaAddress OrderLocationAddress: type: object properties: address_line_1: type: string description: The first line of the location's address. address_line_2: type: - string - 'null' description: The second line of the location's address. city: type: string description: The city of the location's address. postcode: type: string description: The postal code of the location's address. latitude: type: number format: double description: The latitude coordinate of the location's address. longitude: type: number format: double description: The longitude coordinate of the location's address. title: OrderLocationAddress OrderLocationContactDetails: type: object properties: contact_name: type: string description: A contact name for the location. phone_number: type: string description: >- A contact number for this location that may be used by the delivery driver. email: type: - string - 'null' description: A contact email for this location. company_name: type: - string - 'null' description: The name of the company at this location. title: OrderLocationContactDetails OrderLocationInstruction: type: string enum: - address - safe-place description: A key that determines how the delivery should be flfilled. title: OrderLocationInstruction Barcode: type: object properties: code: type: string description: >- The code representation of the barcode. Barcode codes will always be 20 characters in length. code_formatted: type: string description: The human-readable code representation of the barcode. order_location_id: type: integer description: The ID of the location that this barcode is linked to. pickup_latitude: type: - number - 'null' format: double description: >- The latitude coordinate of the location where this barcode was recorded as picked up by the delivery driver. pickup_longitude: type: - number - 'null' format: double description: >- The longitude coordinate of the location where this barcode was recorded as picked up by the delivery driver. pickup_datetime: type: - string - 'null' format: date-time description: >- The date/time at which the delivery driver recorded the barcode's pickup. drop_off_latitude: type: - number - 'null' format: double description: >- The latitude coordinate of the location where this barcode was recorded as dropped off by the delivery driver. drop_off_longitude: type: - number - 'null' format: double description: >- The longitude coordinate of the location where this barcode was recorded as dropped off by the delivery driver. drop_off_datetime: type: - string - 'null' format: date-time description: >- The date/time at which the delivery driver recorded the barcode's drop off. undeliverable: type: - boolean - 'null' description: >- Whether or not the parcel was successfully delivered. This will be `null` if delivery has not been attempted yet. undeliverable_reason: type: - string - 'null' description: A short description of why the parcel could not be delivered. printable_label_url: type: string description: An absolute URL to a PDF with the package label for this barcode. created_at: type: string format: date-time description: The date/time at which the barcode was generated by the API. updated_at: type: string format: date-time description: The date/time at which the barcode was last updated. description: Details about a barcode (parcel) delivery status. title: Barcode ProofOfDeliveryCoordinates: type: object properties: latitude: type: number format: double description: >- The latitude coordinate of the final location where the delivery was fulfilled. longitude: type: number format: double description: >- The longitude coordinate of the final location where the delivery was fulfilled. description: The coordinates of the final location where the delivery was fulfilled. title: ProofOfDeliveryCoordinates ProofOfDelivery: type: object properties: photo: type: string description: An absolute URL to the photo the driver took as proof of delivery. signature: type: string description: >- An absolute URL to the recipient's signature taken after delivery was fulfilled. signer_name: type: string description: The name of the delivery recipient. coordinates: oneOf: - $ref: '#/components/schemas/ProofOfDeliveryCoordinates' - type: 'null' description: >- The coordinates of the final location where the delivery was fulfilled. description: Data from the proof of delivery collected by the delivery driver. title: ProofOfDelivery OrderLocation: type: object properties: id: type: integer delivery_id: type: - integer - 'null' description: The ID of the delivery resource attributed to this location. time_from: type: string format: time description: >- The earliest time at which the driver should arrive at this location. Format 'H:i:s'. time_to: type: string format: time description: >- The latest time at which the driver should arrive at this location. Format 'H:i:s'. tracking_code: type: - string - 'null' description: The unique tracking code of the delivery for this location. web_tracking_url: type: - string - 'null' description: >- An absolute URL to a public web page that displays tracking information and options for the related delivery. address: $ref: '#/components/schemas/OrderLocationAddress' contact_details: $ref: '#/components/schemas/OrderLocationContactDetails' driver_arriving_time: type: - string - 'null' format: date-time description: The date/time at which the delivery driver arrived at the location. driver_leaving_time: type: - string - 'null' format: date-time description: The date/time at which the delivery driver left the location. requires_handballing: type: boolean description: >- Whether or not the delivery requires the driver to assist with loading/unloading items. This is only appropriate for `delivery` order types. Other order types will always be `false`. total_items: type: integer description: >- The total number of items (parcels) being delivered to this location. instruction: oneOf: - $ref: '#/components/schemas/OrderLocationInstruction' - type: 'null' description: A key that determines how the delivery should be flfilled. instruction_details: type: - string - 'null' description: >- Details relevant to the instruction. For example, for `safe-place`, you would provide the details of the safe place; for `address`, you might include a gate code for the driver. what3words: type: - string - 'null' description: The What3Words ID of the location's address. client_system_delivery_id: type: - string - 'null' description: An identifier for the client system that manages this delivery. barcodes: type: array items: $ref: '#/components/schemas/Barcode' description: >- A list of barcodes (parcels) that are to be delivered to this location. printable_label_url: type: - string - 'null' description: An absolute URL to a PDF with all package labels for this location. proof_of_delivery: $ref: '#/components/schemas/ProofOfDelivery' description: The data of a location that has been added as a point to an order. title: OrderLocation OrdersEcommerceOrderIdLocationsPostResponsesContentApplicationJsonSchemaLinksLinkObjectId: type: object properties: rel: type: string description: The identifying descriptor of the link. href: type: string description: An absolute URL. method: type: string description: The HTTP method of this link. title: >- OrdersEcommerceOrderIdLocationsPostResponsesContentApplicationJsonSchemaLinksLinkObjectId OrdersEcommerceOrderIdLocationsPostResponsesContentApplicationJsonSchemaLinks: type: object properties: '[link_object_id]': $ref: >- #/components/schemas/OrdersEcommerceOrderIdLocationsPostResponsesContentApplicationJsonSchemaLinksLinkObjectId title: >- OrdersEcommerceOrderIdLocationsPostResponsesContentApplicationJsonSchemaLinks Orders - eCommerce_post-api-v1-orders-ecommerce-orderId-locations_Response_201: type: object properties: data: $ref: '#/components/schemas/OrderLocation' links: $ref: >- #/components/schemas/OrdersEcommerceOrderIdLocationsPostResponsesContentApplicationJsonSchemaLinks title: >- Orders - eCommerce_post-api-v1-orders-ecommerce-orderId-locations_Response_201 Post-api-v1-orders-ecommerce-orderId-locationsRequestForbiddenError: type: object properties: error: type: string description: A description of the error. title: Post-api-v1-orders-ecommerce-orderId-locationsRequestForbiddenError OrdersEcommerceOrderIdLocationsPostResponsesContentApplicationJsonSchemaErrors: type: object properties: field_key_1: type: array items: type: string field_key_2: type: array items: type: string description: >- A list of errors. Each item will represent a single field and contain a simple array of error messages. title: >- OrdersEcommerceOrderIdLocationsPostResponsesContentApplicationJsonSchemaErrors Post-api-v1-orders-ecommerce-orderId-locationsRequestUnprocessableEntityError: type: object properties: message: type: string description: An overview of the error response. errors: $ref: >- #/components/schemas/OrdersEcommerceOrderIdLocationsPostResponsesContentApplicationJsonSchemaErrors description: >- A list of errors. Each item will represent a single field and contain a simple array of error messages. title: >- Post-api-v1-orders-ecommerce-orderId-locationsRequestUnprocessableEntityError securitySchemes: bearerAuth: type: http scheme: bearer description: '' ``` ## SDK Code Examples ```python import requests url = "https://sandbox-api.deliveryapp.com/api/v1/orders-ecommerce/orderId/locations" payload = { "address": { "address_line_1": "123 Grovesby Road", "city": "Manchester", "postcode": "M1 2AB", "latitude": 53.477582, "longitude": -2.255331, "contact_name": "Jane Doe", "phone_number": "07123456789", "email": "recipient@example.com" } } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://sandbox-api.deliveryapp.com/api/v1/orders-ecommerce/orderId/locations'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"address":{"address_line_1":"123 Grovesby Road","city":"Manchester","postcode":"M1 2AB","latitude":53.477582,"longitude":-2.255331,"contact_name":"Jane Doe","phone_number":"07123456789","email":"recipient@example.com"}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://sandbox-api.deliveryapp.com/api/v1/orders-ecommerce/orderId/locations" payload := strings.NewReader("{\n \"address\": {\n \"address_line_1\": \"123 Grovesby Road\",\n \"city\": \"Manchester\",\n \"postcode\": \"M1 2AB\",\n \"latitude\": 53.477582,\n \"longitude\": -2.255331,\n \"contact_name\": \"Jane Doe\",\n \"phone_number\": \"07123456789\",\n \"email\": \"recipient@example.com\"\n }\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://sandbox-api.deliveryapp.com/api/v1/orders-ecommerce/orderId/locations") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"address\": {\n \"address_line_1\": \"123 Grovesby Road\",\n \"city\": \"Manchester\",\n \"postcode\": \"M1 2AB\",\n \"latitude\": 53.477582,\n \"longitude\": -2.255331,\n \"contact_name\": \"Jane Doe\",\n \"phone_number\": \"07123456789\",\n \"email\": \"recipient@example.com\"\n }\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://sandbox-api.deliveryapp.com/api/v1/orders-ecommerce/orderId/locations") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"address\": {\n \"address_line_1\": \"123 Grovesby Road\",\n \"city\": \"Manchester\",\n \"postcode\": \"M1 2AB\",\n \"latitude\": 53.477582,\n \"longitude\": -2.255331,\n \"contact_name\": \"Jane Doe\",\n \"phone_number\": \"07123456789\",\n \"email\": \"recipient@example.com\"\n }\n}") .asString(); ``` ```php request('POST', 'https://sandbox-api.deliveryapp.com/api/v1/orders-ecommerce/orderId/locations', [ 'body' => '{ "address": { "address_line_1": "123 Grovesby Road", "city": "Manchester", "postcode": "M1 2AB", "latitude": 53.477582, "longitude": -2.255331, "contact_name": "Jane Doe", "phone_number": "07123456789", "email": "recipient@example.com" } }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://sandbox-api.deliveryapp.com/api/v1/orders-ecommerce/orderId/locations"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"address\": {\n \"address_line_1\": \"123 Grovesby Road\",\n \"city\": \"Manchester\",\n \"postcode\": \"M1 2AB\",\n \"latitude\": 53.477582,\n \"longitude\": -2.255331,\n \"contact_name\": \"Jane Doe\",\n \"phone_number\": \"07123456789\",\n \"email\": \"recipient@example.com\"\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["address": [ "address_line_1": "123 Grovesby Road", "city": "Manchester", "postcode": "M1 2AB", "latitude": 53.477582, "longitude": -2.255331, "contact_name": "Jane Doe", "phone_number": "07123456789", "email": "recipient@example.com" ]] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://sandbox-api.deliveryapp.com/api/v1/orders-ecommerce/orderId/locations")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```