---
title: Easy Load Create (Ocean)
slug: fourkites-api-reference/easy-load-create-ocean
description: The Booking API allows customers to easily create ocean loads by providing limited information, with FourKites fetching the remaining load data. It integrates with shipping lines and data platforms, using a set of essential fields such as tracking referen
icon: {"apiMethod":"POST"}
createdAt: 2023-08-04T07:20:04.000Z
---
Ocean Booking/Easy Load Create API or Reference Based Load Creation API will allow users to create loads based on the reference numbers such as Booking Number, Bill of Lading, and/or container number.
:::hint{type="danger"}
### ⚠️ Important Update:
The Pallets structure is being deprecated. Please transition to for product details. [Learn more](https://docs.fourkites.com/api-reference/BXk7-create-shipment#ICU0Y)
:::
:::hint{type="info"}
**Note**: This documentation provides load mode-specific API payloads for this transportation type. For a comprehensive reference of **all available API parameters** that can be applied to these payloads, including parameters across all load modes, please refer to the [Create Shipment](https://docs.fourkites.com/api-reference/BXk7-create-shipment) / [Update Shipment](https://docs.fourkites.com/api-reference/update-shipment) documentation.
:::
:::hint{type="warning"}
This API is called after the carrier has accepted the tender for the load. FourKites does not limit customers from creating more than one load with the same load number or PRO number -- creation of more than one load with the same load or PRO number will cause duplication of loads, which will end up affecting the tracking performance. Customers are advised to handle this on their side. To learn more about Idempotency Protection, [refer here](https://docs.fourkites.com/api-reference/idempotency-protection).
:::
:::hint{type="info"}
### Rate Limit
**1 request per second**
:::
:::hint{type="info"}
### Format Supported
**JSON**
:::
:::hint{type="info"}
### Authenticated Resource
Users can make use of their application login credentials (**Username and Password**) as the means of authenticating (**Basic Auth**).
:::
For more information on Authentication, [click here](https://docs.fourkites.com/api-reference/authentication).
:::hint{type="warning"}
If you are sending '**c\_id**' as the `trackingReferenceIdentifier`, you will have to share `pickup` & `delivery` parameters as well for better Tracking Quality.
:::
:::ApiMethodV2
```json
{
"name": "Production",
"method": "POST",
"url": "https://booking-api.fourkites.com/api/v1/add_references",
"description": "",
"tab": "examples",
"examples": {
"languages": [
{
"id": "9pJbYuFgbw6VKLR9FVaz4",
"language": "curl",
"code": "curl --location --request POST 'https://booking-api.fourkites.com/api/v1/add_references' \\\n--header 'Authorization: Basic cmFqa2lyYW4ubWFub2hhcmFuQGZvdXJraXRlcy5jb206UmFqa2lyYW5tMg==' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"id\": 880723,\n \"trackingReferenceIdentifier\": \"c_id\",\n \"trackingReferenceNumber\": \"reference_number\",\n \"shipperPermalink\": \"shipper_perma_link\",\n \"carrierScac\": \"SCAC\",\n \"operatingCarrierScac\": \"\",\n \"consignmentReference\": \"\",\n \"consignmentSequence\": null,\n \"containerNumber\": \"\",\n \"carrierPermalink\": \"\",\n \"tags\": \"\",\n \"loadNumber\": \"Load_Number\",\n \"loadReferences\": \"\",\n \"autoCreatePickup\": \"\",\n \"autoCreateDelivery\": \"A\",\n \"portOfDischarge\": {\n \"wantTime\": \"2024-12-20T11:36:51Z\",\n \"estimatedArrivalTime\": \"2025-03-02T11:36:51Z\"\n },\n \"placeOfDelivery\": {\n \"estimatedArrivalTime\": \"2025-03-04T11:36:51Z\"\n },\n \"sku\": [\n {\n \"parts\": [\n {\n \"shipperPartNumber\": \"Sample part\",\n \"customerPartNumber\": \"Sample\",\n \"quantity\": \"129\",\n \"weight\": \"100\"\n },\n {\n \"shipperPartNumber\": \"Sample part 2\",\n \"customerPartNumber\": \"Sample 2\",\n \"quantity\": \"100\",\n \"weight\": \"299 KG\"\n }\n ]\n }\n ],\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Ocean Freight Item\",\n \"productDescription\": \"Ocean shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 129,\n \"measurementUnitCode\": \"PCE\",\n \"netWeight\": 100,\n \"weightUnit\": \"KGM\",\n \"unitCost\": 25.0,\n \"currencyCode\": \"USD\",\n \"extendedCost\": 625.00,\n \"freightCost\": 20.00,\n \"additionalCharges\": 5.00,\n \"tariffCost\": 2.50,\n \"fourKitesCalculatedTariffCost\": 2.50,\n \"totalLandedCost\": 655.00,\n \"countryOfOrigin\": \"US\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"OCEAN_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"Load_Number\",\n \"deliveryNumber\": \"DN-Sample\",\n \"handlingUnitId\": \"Sample part\",\n \"barcode\": \"Sample\",\n \"containerType\": \"pallet\",\n \"gtin\": \"00012345678905\",\n \"customerPartNumber\": \"Sample\",\n \"supplierPartNumber\": \"Sample part\",\n \"manufacturerPartNumber\": \"MFG-Sample\",\n \"itemNumber\": \"ITM-Sample\",\n \"productUpc\": \"012345678905\",\n \"deliveryReferences\": [\"reference_number\"],\n \"orderReferences\": [\"Load_Number\"],\n \"brandName\": \"Generic Ocean Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-Sample\",\n \"productTrackingNumber\": \"reference_number\",\n \"deviceType\": \"RFID_TAG\"\n }\n ],\n \"pickup\": {\n \"addressLine\": \"\",\n \"location\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"locationId\": \"\",\n \"arrivalTime\": \"\",\n \"earliestArrivalTime\": \"\",\n \"latestArrivalTime\": \"\",\n \"wantTime\": \"\",\n \"earliestWantTime\": \"\",\n \"latestWantTime\": \"\",\n \"postalCode\": \"\"\n },\n \"delivery\": {\n \"addressLine\": \"\",\n \"location\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"locationId\": \"\",\n \"arrivalTime\": \"\",\n \"earliestArrivalTime\": \"\",\n \"latestArrivalTime\": \"\",\n \"wantTime\": \"\",\n \"earliestWantTime\": \"\",\n \"latestWantTime\": \"\",\n \"postalCode\": \"\"\n }\n}'",
"customLabel": ""
}
],
"selectedLanguageId": "9pJbYuFgbw6VKLR9FVaz4"
},
"results": {
"languages": [
{
"id": "dPeg7RypvjUNHtgyJxNGU",
"language": "200",
"customLabel": "",
"code": "{\n \"code\": 200,\n \"data\": {\n \"totalCount\": 1,\n \"successfulCount\": 1,\n \"failedCount\": 0,\n \"failedSequences\": [],\n \"bookingId\": [\n 975187\n ]\n },\n \"request_id\": \"c85v1ul2u8op8muqee7g\"\n}"
},
{
"id": "NAIqehaZ1cImvrrOlDtxd",
"language": "401",
"code": "{\n\"statusCode\": 401,\n\"message\": \"User not authorized for this resource\"\n}",
"customLabel": ""
},
{
"id": "gLZpCFOa_Od5DjP2-r8is",
"language": "403",
"code": "{\n\"statusCode\": 403,\n\"message\": \"Invalid Session, please login\"\n}",
"customLabel": ""
},
{
"id": "toEGudTb7OZ2mRaga_K6-",
"language": "500",
"code": "{\n \"message\": \"An Internal Error Has Occurred\",\n \"statusCode\": 500\n}",
"customLabel": ""
}
],
"selectedLanguageId": "dPeg7RypvjUNHtgyJxNGU"
},
"request": {
"pathParameters": [],
"queryParameters": [],
"headerParameters": [],
"bodyDataParameters": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "Unique identifier for the customer in the system",
"": "integer"
},
{
"name": "trackingReferenceIdentifier",
"kind": "required",
"type": "string",
"description": "The code indicating the type of reference used for load creation. Accepted values are ‘b_id’ (booking number), ‘m_bl’ (bill of lading), ‘c_id’ (container number)",
"children": []
},
{
"name": "trackingReferenceNumber",
"kind": "required",
"type": "string",
"description": "The actual booking reference",
"children": []
},
{
"name": "shipperPermalink",
"kind": "required",
"type": "string",
"description": "Permalink of the customer",
"children": []
},
{
"name": "carrierScac",
"kind": "required",
"type": "string",
"description": "The carrier SCAC configured for the customer",
"children": []
},
{
"name": "carrierPermalink",
"kind": "optional",
"type": "string",
"description": "Permalink of the carrier",
"children": []
},
{
"name": "consignmentReference",
"kind": "optional",
"type": "string",
"description": "Unique consignment reference number for the set of consignment loads. Should not be container number as it gets repeated.",
"children": []
},
{
"name": "consignmentSequence",
"kind": "optional",
"type": "string",
"description": "Sequence number for the Ocean leg. Should be a number.",
"children": []
},
{
"name": "containerNumber",
"kind": "optional",
"type": "string",
"description": "The container number to which all data from the row should be applied to. Only this container will be created for the booking or bill of lading and the data from the row will be applied to this. Mandatory field when consignment reference and number are provided.",
"children": []
},
{
"name": "tags",
"kind": "optional",
"type": "string",
"description": "comma separated tags, given as a string and not an array",
"children": []
},
{
"name": "loadNumber",
"kind": "optional",
"type": "string",
"description": "The value provided here will be applied to every load created using the reference provided in that row. If a booking is provided and it has 8 containers, all 8 loads will be assigned this same ID.",
"children": []
},
{
"name": "loadReferences",
"kind": "optional",
"type": "string",
"description": "Comma separated load references, given as a string and not an array. The reference used to create the load (booking number/bill of lading) automatically gets added to the references. No need to add it under references explicitly.",
"children": []
},
{
"name": "autoCreatePickup",
"kind": "optional",
"type": "string",
"description": "Accepted values are ‘Yes’ and blank.",
"children": []
},
{
"name": "autoCreateDelivery",
"kind": "optional",
"type": "string",
"description": "Accepted values are ‘Yes’ and blank.",
"children": []
},
{
"name": "portOfDischarge",
"kind": "optional",
"type": "object",
"description": "Information about the discharge port",
"": "object",
"children": [
{
"name": "wantTime",
"kind": "optional",
"type": "string",
"description": "ISO 8601 DateTime String - Requested/desired time for discharge at the port"
},
{
"name": "estimatedArrivalTime",
"kind": "optional",
"type": "string",
"description": "ISO 8601 DateTime String - Predicted time of arrival at the discharge port"
}
],
"schema": [
{
"name": "wantTime",
"kind": "optional",
"type": "string",
"description": "ISO 8601 DateTime String - Requested/desired time for discharge at the port"
},
{
"name": "estimatedArrivalTime",
"kind": "optional",
"type": "string",
"description": "ISO 8601 DateTime String - Predicted time of arrival at the discharge port"
}
]
},
{
"name": "placeOfDelivery",
"kind": "optional",
"type": "object",
"description": "Information about the final delivery location",
"": "object",
"children": [
{
"name": "estimatedArrivalTime",
"kind": "optional",
"type": "string",
"description": "ISO 8601 DateTime String - Predicted time of arrival at the final delivery location"
}
],
"schema": [
{
"name": "estimatedArrivalTime",
"kind": "optional",
"type": "string",
"description": "ISO 8601 DateTime String - Predicted time of arrival at the final delivery location"
}
]
},
{
"name": "sku",
"kind": "optional",
"type": "object",
"description": "An object containing SKU-level details for a shipment item, including identifiers and associated attributes used to track individual products within a shipment.",
"": "An object containing SKU-level details for a shipment item, including identifiers and associated attributes used to track individual products within a shipment.",
"children": [
{
"name": "parts",
"kind": "optional",
"type": "object",
"description": "Array of Objects - Collection of items/parts on the pallet",
"children": [
{
"name": "shipperPartNumber",
"kind": "optional",
"type": "string",
"description": "Part number used by the shipper"
},
{
"name": "customerPartNumber",
"kind": "optional",
"type": "string",
"description": "Part number used by the customer"
},
{
"name": "quantity",
"kind": "optional",
"type": "integer",
"description": "Number of units of this part"
},
{
"name": "weight",
"kind": "optional",
"type": "string",
"description": "Weight of the parts (with optional unit specification)"
}
]
}
],
"schema": [
{
"name": "parts",
"kind": "optional",
"type": "object",
"description": "Array of Objects - Collection of items/parts on the pallet",
"children": [
{
"name": "shipperPartNumber",
"kind": "optional",
"type": "string",
"description": "Part number used by the shipper"
},
{
"name": "customerPartNumber",
"kind": "optional",
"type": "string",
"description": "Part number used by the customer"
},
{
"name": "quantity",
"kind": "optional",
"type": "integer",
"description": "Number of units of this part"
},
{
"name": "weight",
"kind": "optional",
"type": "string",
"description": "Weight of the parts (with optional unit specification)"
}
]
}
]
},
{
"name": "productLineItems",
"kind": "optional",
"type": "object",
"description": "It is the list of product level details associated with the shipment. Replaces the legacy sku/pallets/parts structure going forward.",
"children": [
{
"name": "productId",
"kind": "required",
"type": "string",
"description": "Unique identifier for the product. Mandatory if productLineItems object is present"
},
{
"name": "productName",
"kind": "optional",
"type": "string",
"description": "Name of the product"
},
{
"name": "productDescription",
"kind": "optional",
"type": "string",
"description": "Detailed description of the product"
},
{
"name": "productCategory",
"kind": "optional",
"type": "string",
"description": "Category classification of the product"
},
{
"name": "quantity",
"kind": "optional",
"type": "integer",
"description": "Number of units in the shipment"
},
{
"name": "measurementUnitCode",
"kind": "optional",
"type": "string",
"description": "Unit of measurement for quantity (e.g., PCE, KG, LB)"
},
{
"name": "netWeight",
"kind": "optional",
"type": "string",
"description": "Weight of the product excluding packaging"
},
{
"name": "weightUnit",
"kind": "optional",
"type": "string",
"description": "Unit of measurement for weight (e.g., KGM, LBM)"
},
{
"name": "unitCost",
"kind": "optional",
"type": "number",
"description": "Cost per unit of the product"
},
{
"name": "currencyCode",
"kind": "optional",
"type": "string",
"description": "Currency code for cost fields"
},
{
"name": "extendedCost",
"kind": "optional",
"type": "number",
"description": "Total cost for all units (unitCost x quantity)"
},
{
"name": "freightCost",
"kind": "optional",
"type": "number",
"description": "Freight cost allocated to this line item"
},
{
"name": "bestBeforeDate",
"kind": "optional",
"type": "string",
"description": "Expiration or best before date for the product"
},
{
"name": "additionalCharges",
"kind": "optional",
"type": "number",
"description": "Any additional charges specific to this line item"
},
{
"name": "tariffCost",
"kind": "optional",
"type": "number",
"description": "Tariff cost for this specific line item"
},
{
"name": "fourKitesCalculatedTariffCost",
"kind": "optional",
"type": "number",
"description": "System-calculated tariff cost"
},
{
"name": "totalLandedCost",
"kind": "optional",
"type": "number",
"description": "Total landed cost for this line item"
},
{
"name": "countryOfOrigin",
"kind": "optional",
"type": "string",
"description": "Country of origin for this product"
},
{
"name": "harmonizedSystemCode",
"kind": "optional",
"type": "string",
"description": "International trade classification code"
},
{
"name": "commodityTypeCode",
"kind": "optional",
"type": "string",
"description": "Commodity classification code"
},
{
"name": "htsusCode",
"kind": "optional",
"type": "string",
"description": "Harmonized Tariff Schedule code for US imports"
},
{
"name": "orderNumber",
"kind": "optional",
"type": "string",
"description": "Purchase order number"
},
{
"name": "deliveryNumber",
"kind": "optional",
"type": "string",
"description": "Delivery reference number"
},
{
"name": "handlingUnitId",
"kind": "optional",
"type": "string",
"description": "Identifier for the handling unit (pallet, box, etc.)"
},
{
"name": "barcode",
"kind": "optional",
"type": "string",
"description": "Product barcode"
},
{
"name": "containerType",
"kind": "optional",
"type": "string",
"description": "Type of container (pallet, box, carton, etc.)"
},
{
"name": "gtin",
"kind": "optional",
"type": "string",
"description": "Global Trade Item Number"
},
{
"name": "customerPartNumber",
"kind": "optional",
"type": "string",
"description": "Customer's part number for the product"
},
{
"name": "supplierPartNumber",
"kind": "optional",
"type": "string",
"description": "Supplier's part number for the product"
},
{
"name": "manufacturerPartNumber",
"kind": "optional",
"type": "string",
"description": "Manufacturer's part number"
},
{
"name": "itemNumber",
"kind": "optional",
"type": "string",
"description": "Internal item number"
},
{
"name": "productUpc",
"kind": "optional",
"type": "string",
"description": "Universal Product Code"
},
{
"name": "deliveryReferences",
"kind": "optional",
"type": "string",
"description": "Array of delivery reference numbers"
},
{
"name": "orderReferences",
"kind": "optional",
"type": "string",
"description": "Array of order reference numbers"
},
{
"name": "brandName",
"kind": "optional",
"type": "string",
"description": "Brand name of the product"
},
{
"name": "minimumTemperature",
"kind": "optional",
"type": "integer",
"description": "Minimum storage/transport temperature"
},
{
"name": "maximumTemperature",
"kind": "optional",
"type": "integer",
"description": "Maximum storage/transport temperature"
},
{
"name": "temperatureUnitCode",
"kind": "optional",
"type": "string",
"description": "Temperature unit (cel, fah)"
},
{
"name": "labelIdentifier",
"kind": "optional",
"type": "string",
"description": "Label identifier for tracking"
},
{
"name": "productTrackingNumber",
"kind": "optional",
"type": "string",
"description": "Unique tracking number for the product"
},
{
"name": "deviceType",
"kind": "optional",
"type": "string",
"description": "Type of tracking device (RFID_TAG, QR_CODE, etc.)"
}
]
},
{
"name": "pickup",
"kind": "optional",
"type": "object",
"description": "Pickup stops specific fields. You need to share pickup parameters if you're sendind 'c_id' as the trackingReferenceIdentifier.",
"children": [
{
"name": "addressLine",
"kind": "optional",
"type": "string",
"description": "Details like the door number and street address"
},
{
"name": "location",
"kind": "optional",
"type": "string",
"description": "The UNLOCODE of the pickup location, if any"
},
{
"name": "city",
"kind": "optional",
"type": "string",
"description": "The city of the pickup address. Need to be given together, if given. Won’t be processed even if one of the 3 fields is blank."
},
{
"name": "state",
"kind": "optional",
"type": "string",
"description": "The state of the pickup address. Need to be given together, if given. Won’t be processed even if one of the 3 fields is blank."
},
{
"name": "country",
"kind": "optional",
"type": "string",
"description": "The country of the pickup address. Need to be given together, if given. Won’t be processed even if one of the 3 fields is blank."
},
{
"name": "latitude",
"kind": "optional",
"type": "string",
"description": "The latitude of the pickup address. Need to be given together, if given. Won’t be processed if one of the fields is blank."
},
{
"name": "longitude",
"kind": "optional",
"type": "string",
"description": "The longitude of the pickup address. Need to be given together, if given. Won’t be processed if one of the fields is blank."
},
{
"name": "locationId",
"kind": "optional",
"type": "string",
"description": "The external ID of the pickup location, taken from the customer’s address book"
},
{
"name": "arrivalTime",
"kind": "optional",
"type": "string",
"description": "The appointment time at the pickup location. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "earliestArrivalTime",
"kind": "optional",
"type": "string",
"description": "The earliest arrival time at the pickup location. Need to be given together, if given. Won’t be processed if one of the fields (earliestArrivalTime, latestArrivalTime) is blank. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "latestArrivalTime",
"kind": "optional",
"type": "string",
"description": "The latest arrival times at the pickup location. Need to be given together, if given. Won’t be processed if one of the fields (earliestArrivalTime, latestArrivalTime) is blank. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "wantTime",
"kind": "optional",
"type": "string",
"description": "The want time at the pickup location. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "earliestWantTime",
"kind": "optional",
"type": "string",
"description": "The earliest want time at the pickup location. Need to be given together, if given. Won’t be processed if one of the fields (earliestWantTime, latestWantTime) is blank. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "latestWantTime",
"kind": "optional",
"type": "string",
"description": "The latest want time at the pickup location. Need to be given together, if given. Won’t be processed if one of the fields (earliestWantTime, latestWantTime) is blank. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "postalCode",
"kind": "optional",
"type": "string",
"description": "The zip code of the pickup address"
}
]
},
{
"name": "delivery",
"kind": "optional",
"type": "object",
"description": "Delivery stops specific fields. You need to share delivery parameters if you're sendind 'c_id' as the trackingReferenceIdentifier.",
"children": [
{
"name": "addressLine",
"kind": "optional",
"type": "string",
"description": "Details like the door number and street address"
},
{
"name": "location",
"kind": "optional",
"type": "string",
"description": "The UNLOCODE of the pickup location, if any"
},
{
"name": "city",
"kind": "optional",
"type": "string",
"description": "The city of the pickup address. Need to be given together, if given. Won’t be processed even if one of the 3 fields (city, state, country) is blank."
},
{
"name": "state",
"kind": "optional",
"type": "string",
"description": "The state of the pickup address. Need to be given together, if given. Won’t be processed even if one of the 3 fields (city, state, country) is blank."
},
{
"name": "country",
"kind": "optional",
"type": "string",
"description": "The country of the pickup address. Need to be given together, if given. Won’t be processed even if one of the 3 fields (city, state, country) is blank."
},
{
"name": "latitude",
"kind": "optional",
"type": "string",
"description": "The latitude of the pickup address. Need to be given together, if given. Won’t be processed if one of the fields (latitude, longitude) is blank."
},
{
"name": "longitude",
"kind": "optional",
"type": "string",
"description": "The latitude of the pickup address. Need to be given together, if given. Won’t be processed if one of the fields (latitude, longitude) is blank."
},
{
"name": "locationId",
"kind": "optional",
"type": "string",
"description": "The external ID of the pickup location, taken from the customer’s address book"
},
{
"name": "arrivalTime",
"kind": "optional",
"type": "string",
"description": "The appointment time at the pickup location. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "earliestArrivalTime",
"kind": "optional",
"type": "string",
"description": "The earliest arrival time at the pickup location. Need to be given together, if given. Won’t be processed if one of the fields (earliestArrivalTime, latestArrivalTime) is blank. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "latestArrivalTime",
"kind": "optional",
"type": "string",
"description": "The latest arrival times at the pickup location. Need to be given together, if given. Won’t be processed if one of the fields (earliestArrivalTime, latestArrivalTime) is blank. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "wantTime",
"kind": "optional",
"type": "string",
"description": "The want time at the pickup location. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "earliestWantTime",
"kind": "optional",
"type": "string",
"description": "The earliest want time at the pickup location. Need to be given together, if given. Won’t be processed if one of the fields (earliestWantTime, latestWantTime) is blank. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "latestWantTime",
"kind": "optional",
"type": "string",
"description": "The latest want time at the pickup location. Need to be given together, if given. Won’t be processed if one of the fields (earliestWantTime, latestWantTime) is blank. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "postalCode",
"kind": "optional",
"type": "string",
"description": "The zip code of the pickup address"
}
]
}
],
"formDataParameters": []
},
"currentNewParameter": {
"label": "Body Parameter",
"value": "bodyDataParameters"
},
"hasTryItOut": false,
"autoGeneratedAnchorSlug": "production",
"legacyHash": "TRT2yNtAr0J8YffqeXWgM"
}
```
:::
:::ApiMethodV2
```json
{
"name": "Staging",
"method": "POST",
"url": "https://booking-api-staging.fourkites.com/api/v1/add_references",
"description": "",
"tab": "examples",
"examples": {
"languages": [
{
"id": "9pJbYuFgbw6VKLR9FVaz4",
"language": "curl",
"code": "curl --location --request POST 'https://booking-api-staging.fourkites.com/api/v1/add_references' \\\n--header 'Authorization: Basic cmFqa2lyYW4ubWFub2hhcmFuQGZvdXJraXRlcy5jb206UmFqa2lyYW5tMg==' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"id\": 880723,\n \"trackingReferenceIdentifier\": \"c_id\",\n \"trackingReferenceNumber\": \"reference_number\",\n \"shipperPermalink\": \"shipper_perma_link\",\n \"carrierScac\": \"SCAC\",\n \"operatingCarrierScac\": \"\",\n \"consignmentReference\": \"\",\n \"consignmentSequence\": null,\n \"containerNumber\": \"\",\n \"carrierPermalink\": \"\",\n \"tags\": \"\",\n \"loadNumber\": \"Load_Number\",\n \"loadReferences\": \"\",\n \"autoCreatePickup\": \"\",\n \"autoCreateDelivery\": \"A\",\n \"portOfDischarge\": {\n \"wantTime\": \"2024-12-20T11:36:51Z\",\n \"estimatedArrivalTime\": \"2025-03-02T11:36:51Z\"\n },\n \"placeOfDelivery\": {\n \"estimatedArrivalTime\": \"2025-03-04T11:36:51Z\"\n },\n \"pallets\": [\n {\n \"parts\": [\n {\n \"shipperPartNumber\": \"Sample part\",\n \"customerPartNumber\": \"Sample\",\n \"quantity\": \"129\",\n \"weight\": \"100\"\n },\n {\n \"shipperPartNumber\": \"Sample part 2\",\n \"customerPartNumber\": \"Sample 2\",\n \"quantity\": \"100\",\n \"weight\": \"299 KG\"\n }\n ]\n }\n ],\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Ocean Freight Item\",\n \"productDescription\": \"Ocean shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 129,\n \"measurementUnitCode\": \"PCE\",\n \"netWeight\": 100,\n \"weightUnit\": \"KGM\",\n \"unitCost\": 25.0,\n \"currencyCode\": \"USD\",\n \"extendedCost\": 625.00,\n \"freightCost\": 20.00,\n \"additionalCharges\": 5.00,\n \"tariffCost\": 2.50,\n \"fourKitesCalculatedTariffCost\": 2.50,\n \"totalLandedCost\": 655.00,\n \"countryOfOrigin\": \"US\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"OCEAN_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"Load_Number\",\n \"deliveryNumber\": \"DN-Sample\",\n \"handlingUnitId\": \"Sample part\",\n \"barcode\": \"Sample\",\n \"containerType\": \"pallet\",\n \"gtin\": \"00012345678905\",\n \"customerPartNumber\": \"Sample\",\n \"supplierPartNumber\": \"Sample part\",\n \"manufacturerPartNumber\": \"MFG-Sample\",\n \"itemNumber\": \"ITM-Sample\",\n \"productUpc\": \"012345678905\",\n \"deliveryReferences\": [\"reference_number\"],\n \"orderReferences\": [\"Load_Number\"],\n \"brandName\": \"Generic Ocean Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-Sample\",\n \"productTrackingNumber\": \"reference_number\",\n \"deviceType\": \"QR_CODE\"\n }\n ],\n \"pickup\": {\n \"addressLine\": \"\",\n \"location\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"locationId\": \"\",\n \"arrivalTime\": \"\",\n \"earliestArrivalTime\": \"\",\n \"latestArrivalTime\": \"\",\n \"wantTime\": \"\",\n \"earliestWantTime\": \"\",\n \"latestWantTime\": \"\",\n \"postalCode\": \"\"\n },\n \"delivery\": {\n \"addressLine\": \"\",\n \"location\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"locationId\": \"\",\n \"arrivalTime\": \"\",\n \"earliestArrivalTime\": \"\",\n \"latestArrivalTime\": \"\",\n \"wantTime\": \"\",\n \"earliestWantTime\": \"\",\n \"latestWantTime\": \"\",\n \"postalCode\": \"\"\n }\n}'",
"customLabel": ""
}
],
"selectedLanguageId": "9pJbYuFgbw6VKLR9FVaz4"
},
"results": {
"languages": [
{
"id": "dPeg7RypvjUNHtgyJxNGU",
"language": "200",
"customLabel": "",
"code": "{\n \"code\": 200,\n \"data\": {\n \"totalCount\": 1,\n \"successfulCount\": 1,\n \"failedCount\": 0,\n \"failedSequences\": [],\n \"bookingId\": [\n 975187\n ]\n },\n \"request_id\": \"c85v1ul2u8op8muqee7g\"\n}"
},
{
"id": "NAIqehaZ1cImvrrOlDtxd",
"language": "401",
"code": "{\n\"statusCode\": 401,\n\"message\": \"User not authorized for this resource\"\n}",
"customLabel": ""
},
{
"id": "gLZpCFOa_Od5DjP2-r8is",
"language": "403",
"code": "{\n\"statusCode\": 403,\n\"message\": \"Invalid Session, please login\"\n}",
"customLabel": ""
},
{
"id": "toEGudTb7OZ2mRaga_K6-",
"language": "500",
"code": "{\n \"message\": \"An Internal Error Has Occurred\",\n \"statusCode\": 500\n}",
"customLabel": ""
}
],
"selectedLanguageId": "dPeg7RypvjUNHtgyJxNGU"
},
"request": {
"pathParameters": [],
"queryParameters": [],
"headerParameters": [],
"bodyDataParameters": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "Unique identifier for the customer in the system",
"": "integer"
},
{
"name": "trackingReferenceIdentifier",
"kind": "required",
"type": "string",
"description": "The code indicating the type of reference used for load creation. Accepted values are ‘b_id’ (booking number), ‘m_bl’ (bill of lading), ‘c_id’ (container number)",
"children": []
},
{
"name": "trackingReferenceNumber",
"kind": "required",
"type": "string",
"description": "The actual booking reference",
"children": []
},
{
"name": "shipperPermalink",
"kind": "required",
"type": "string",
"description": "Permalink of the customer",
"children": []
},
{
"name": "carrierScac",
"kind": "required",
"type": "string",
"description": "The carrier SCAC configured for the customer",
"children": []
},
{
"name": "carrierPermalink",
"kind": "optional",
"type": "string",
"description": "Permalink of the carrier",
"children": []
},
{
"name": "consignmentReference",
"kind": "optional",
"type": "string",
"description": "Unique consignment reference number for the set of consignment loads. Should not be container number as it gets repeated.",
"children": []
},
{
"name": "consignmentSequence",
"kind": "optional",
"type": "string",
"description": "Sequence number for the Ocean leg. Should be a number.",
"children": []
},
{
"name": "containerNumber",
"kind": "optional",
"type": "string",
"description": "The container number to which all data from the row should be applied to. Only this container will be created for the booking or bill of lading and the data from the row will be applied to this. Mandatory field when consignment reference and number are provided.",
"children": []
},
{
"name": "tags",
"kind": "optional",
"type": "string",
"description": "comma separated tags, given as a string and not an array",
"children": []
},
{
"name": "loadNumber",
"kind": "optional",
"type": "string",
"description": "The value provided here will be applied to every load created using the reference provided in that row. If a booking is provided and it has 8 containers, all 8 loads will be assigned this same ID.",
"children": []
},
{
"name": "loadReferences",
"kind": "optional",
"type": "string",
"description": "Comma separated load references, given as a string and not an array. The reference used to create the load (booking number/bill of lading) automatically gets added to the references. No need to add it under references explicitly.",
"children": []
},
{
"name": "autoCreatePickup",
"kind": "optional",
"type": "string",
"description": "Accepted values are ‘Yes’ and blank.",
"children": []
},
{
"name": "autoCreateDelivery",
"kind": "optional",
"type": "string",
"description": "Accepted values are ‘Yes’ and blank.",
"children": []
},
{
"name": "portOfDischarge",
"kind": "optional",
"type": "object",
"description": "Information about the discharge port",
"": "object",
"children": [
{
"name": "wantTime",
"kind": "optional",
"type": "string",
"description": "ISO 8601 DateTime String - Requested/desired time for discharge at the port"
},
{
"name": "estimatedArrivalTime",
"kind": "optional",
"type": "string",
"description": "ISO 8601 DateTime String - Predicted time of arrival at the discharge port"
}
],
"schema": [
{
"name": "wantTime",
"kind": "optional",
"type": "string",
"description": "ISO 8601 DateTime String - Requested/desired time for discharge at the port"
},
{
"name": "estimatedArrivalTime",
"kind": "optional",
"type": "string",
"description": "ISO 8601 DateTime String - Predicted time of arrival at the discharge port"
}
]
},
{
"name": "placeOfDelivery",
"kind": "optional",
"type": "object",
"description": "Information about the final delivery location",
"": "object",
"children": [
{
"name": "estimatedArrivalTime",
"kind": "optional",
"type": "string",
"description": "ISO 8601 DateTime String - Predicted time of arrival at the final delivery location"
}
],
"schema": [
{
"name": "estimatedArrivalTime",
"kind": "optional",
"type": "string",
"description": "ISO 8601 DateTime String - Predicted time of arrival at the final delivery location"
}
]
},
{
"name": "sku",
"kind": "optional",
"type": "object",
"description": "An object containing SKU-level details for a shipment item, including identifiers and associated attributes used to track individual products within a shipment.",
"": "An object containing SKU-level details for a shipment item, including identifiers and associated attributes used to track individual products within a shipment.",
"children": [
{
"name": "parts",
"kind": "optional",
"type": "object",
"description": "Array of Objects - Collection of items/parts on the pallet",
"children": [
{
"name": "shipperPartNumber",
"kind": "optional",
"type": "string",
"description": "Part number used by the shipper"
},
{
"name": "customerPartNumber",
"kind": "optional",
"type": "string",
"description": "Part number used by the customer"
},
{
"name": "quantity",
"kind": "optional",
"type": "integer",
"description": "Number of units of this part"
},
{
"name": "weight",
"kind": "optional",
"type": "string",
"description": "Weight of the parts (with optional unit specification)"
}
]
}
],
"schema": [
{
"name": "parts",
"kind": "optional",
"type": "object",
"description": "Array of Objects - Collection of items/parts on the pallet",
"children": [
{
"name": "shipperPartNumber",
"kind": "optional",
"type": "string",
"description": "Part number used by the shipper"
},
{
"name": "customerPartNumber",
"kind": "optional",
"type": "string",
"description": "Part number used by the customer"
},
{
"name": "quantity",
"kind": "optional",
"type": "integer",
"description": "Number of units of this part"
},
{
"name": "weight",
"kind": "optional",
"type": "string",
"description": "Weight of the parts (with optional unit specification)"
}
]
}
]
},
{
"name": "productLineItems",
"kind": "optional",
"type": "object",
"description": "It is the list of product level details associated with the shipment. Replaces the legacy sku/pallets/parts structure going forward.",
"children": [
{
"name": "productId",
"kind": "required",
"type": "string",
"description": "Unique identifier for the product. Mandatory if productLineItems object is present"
},
{
"name": "productName",
"kind": "optional",
"type": "string",
"description": "Name of the product"
},
{
"name": "productDescription",
"kind": "optional",
"type": "string",
"description": "Detailed description of the product"
},
{
"name": "productCategory",
"kind": "optional",
"type": "string",
"description": "Category classification of the product"
},
{
"name": "quantity",
"kind": "optional",
"type": "integer",
"description": "Number of units in the shipment"
},
{
"name": "measurementUnitCode",
"kind": "optional",
"type": "string",
"description": "Unit of measurement for quantity (e.g., PCE, KG, LB)"
},
{
"name": "netWeight",
"kind": "optional",
"type": "string",
"description": "Weight of the product excluding packaging"
},
{
"name": "weightUnit",
"kind": "optional",
"type": "string",
"description": "Unit of measurement for weight (e.g., KGM, LBM)"
},
{
"name": "unitCost",
"kind": "optional",
"type": "number",
"description": "Cost per unit of the product"
},
{
"name": "currencyCode",
"kind": "optional",
"type": "string",
"description": "Currency code for cost fields"
},
{
"name": "extendedCost",
"kind": "optional",
"type": "number",
"description": "Total cost for all units (unitCost x quantity)"
},
{
"name": "freightCost",
"kind": "optional",
"type": "number",
"description": "Freight cost allocated to this line item"
},
{
"name": "bestBeforeDate",
"kind": "optional",
"type": "string",
"description": "Expiration or best before date for the product"
},
{
"name": "additionalCharges",
"kind": "optional",
"type": "number",
"description": "Any additional charges specific to this line item"
},
{
"name": "tariffCost",
"kind": "optional",
"type": "number",
"description": "Tariff cost for this specific line item"
},
{
"name": "fourKitesCalculatedTariffCost",
"kind": "optional",
"type": "number",
"description": "System-calculated tariff cost"
},
{
"name": "totalLandedCost",
"kind": "optional",
"type": "number",
"description": "Total landed cost for this line item"
},
{
"name": "countryOfOrigin",
"kind": "optional",
"type": "string",
"description": "Country of origin for this product"
},
{
"name": "harmonizedSystemCode",
"kind": "optional",
"type": "string",
"description": "International trade classification code"
},
{
"name": "commodityTypeCode",
"kind": "optional",
"type": "string",
"description": "Commodity classification code"
},
{
"name": "htsusCode",
"kind": "optional",
"type": "string",
"description": "Harmonized Tariff Schedule code for US imports"
},
{
"name": "orderNumber",
"kind": "optional",
"type": "string",
"description": "Purchase order number"
},
{
"name": "deliveryNumber",
"kind": "optional",
"type": "string",
"description": "Delivery reference number"
},
{
"name": "handlingUnitId",
"kind": "optional",
"type": "string",
"description": "Identifier for the handling unit (pallet, box, etc.)"
},
{
"name": "barcode",
"kind": "optional",
"type": "string",
"description": "Product barcode"
},
{
"name": "containerType",
"kind": "optional",
"type": "string",
"description": "Type of container (pallet, box, carton, etc.)"
},
{
"name": "gtin",
"kind": "optional",
"type": "string",
"description": "Global Trade Item Number"
},
{
"name": "customerPartNumber",
"kind": "optional",
"type": "string",
"description": "Customer's part number for the product"
},
{
"name": "supplierPartNumber",
"kind": "optional",
"type": "string",
"description": "Supplier's part number for the product"
},
{
"name": "manufacturerPartNumber",
"kind": "optional",
"type": "string",
"description": "Manufacturer's part number"
},
{
"name": "itemNumber",
"kind": "optional",
"type": "string",
"description": "Internal item number"
},
{
"name": "productUpc",
"kind": "optional",
"type": "string",
"description": "Universal Product Code"
},
{
"name": "deliveryReferences",
"kind": "optional",
"type": "string",
"description": "Array of delivery reference numbers"
},
{
"name": "orderReferences",
"kind": "optional",
"type": "string",
"description": "Array of order reference numbers"
},
{
"name": "brandName",
"kind": "optional",
"type": "string",
"description": "Brand name of the product"
},
{
"name": "minimumTemperature",
"kind": "optional",
"type": "integer",
"description": "Minimum storage/transport temperature"
},
{
"name": "maximumTemperature",
"kind": "optional",
"type": "integer",
"description": "Maximum storage/transport temperature"
},
{
"name": "temperatureUnitCode",
"kind": "optional",
"type": "string",
"description": "Temperature unit (cel, fah)"
},
{
"name": "labelIdentifier",
"kind": "optional",
"type": "string",
"description": "Label identifier for tracking"
},
{
"name": "productTrackingNumber",
"kind": "optional",
"type": "string",
"description": "Unique tracking number for the product"
},
{
"name": "deviceType",
"kind": "optional",
"type": "string",
"description": "Type of tracking device (RFID_TAG, QR_CODE, etc.)"
}
]
},
{
"name": "pickup",
"kind": "optional",
"type": "object",
"description": "Pickup stops specific fields. You need to share pickup parameters if you're sendind 'c_id' as the trackingReferenceIdentifier.",
"children": [
{
"name": "addressLine",
"kind": "optional",
"type": "string",
"description": "Details like the door number and street address"
},
{
"name": "location",
"kind": "optional",
"type": "string",
"description": "The UNLOCODE of the pickup location, if any"
},
{
"name": "city",
"kind": "optional",
"type": "string",
"description": "The city of the pickup address. Need to be given together, if given. Won’t be processed even if one of the 3 fields is blank."
},
{
"name": "state",
"kind": "optional",
"type": "string",
"description": "The state of the pickup address. Need to be given together, if given. Won’t be processed even if one of the 3 fields is blank."
},
{
"name": "country",
"kind": "optional",
"type": "string",
"description": "The country of the pickup address. Need to be given together, if given. Won’t be processed even if one of the 3 fields is blank."
},
{
"name": "latitude",
"kind": "optional",
"type": "string",
"description": "The latitude of the pickup address. Need to be given together, if given. Won’t be processed if one of the fields is blank."
},
{
"name": "longitude",
"kind": "optional",
"type": "string",
"description": "The longitude of the pickup address. Need to be given together, if given. Won’t be processed if one of the fields is blank."
},
{
"name": "locationId",
"kind": "optional",
"type": "string",
"description": "The external ID of the pickup location, taken from the customer’s address book"
},
{
"name": "arrivalTime",
"kind": "optional",
"type": "string",
"description": "The appointment time at the pickup location. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "earliestArrivalTime",
"kind": "optional",
"type": "string",
"description": "The earliest arrival time at the pickup location. Need to be given together, if given. Won’t be processed if one of the fields (earliestArrivalTime, latestArrivalTime) is blank. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "latestArrivalTime",
"kind": "optional",
"type": "string",
"description": "The latest arrival times at the pickup location. Need to be given together, if given. Won’t be processed if one of the fields (earliestArrivalTime, latestArrivalTime) is blank. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "wantTime",
"kind": "optional",
"type": "string",
"description": "The want time at the pickup location. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "earliestWantTime",
"kind": "optional",
"type": "string",
"description": "The earliest want time at the pickup location. Need to be given together, if given. Won’t be processed if one of the fields (earliestWantTime, latestWantTime) is blank. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "latestWantTime",
"kind": "optional",
"type": "string",
"description": "The latest want time at the pickup location. Need to be given together, if given. Won’t be processed if one of the fields (earliestWantTime, latestWantTime) is blank. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "postalCode",
"kind": "optional",
"type": "string",
"description": "The zip code of the pickup address"
}
]
},
{
"name": "delivery",
"kind": "optional",
"type": "object",
"description": "Delivery stops specific fields. You need to share delivery parameters if you're sendind 'c_id' as the trackingReferenceIdentifier.",
"children": [
{
"name": "addressLine",
"kind": "optional",
"type": "string",
"description": "Details like the door number and street address"
},
{
"name": "location",
"kind": "optional",
"type": "string",
"description": "The UNLOCODE of the pickup location, if any"
},
{
"name": "city",
"kind": "optional",
"type": "string",
"description": "The city of the pickup address. Need to be given together, if given. Won’t be processed even if one of the 3 fields (city, state, country) is blank."
},
{
"name": "state",
"kind": "optional",
"type": "string",
"description": "The state of the pickup address. Need to be given together, if given. Won’t be processed even if one of the 3 fields (city, state, country) is blank."
},
{
"name": "country",
"kind": "optional",
"type": "string",
"description": "The country of the pickup address. Need to be given together, if given. Won’t be processed even if one of the 3 fields (city, state, country) is blank."
},
{
"name": "latitude",
"kind": "optional",
"type": "string",
"description": "The latitude of the pickup address. Need to be given together, if given. Won’t be processed if one of the fields (latitude, longitude) is blank."
},
{
"name": "longitude",
"kind": "optional",
"type": "string",
"description": "The latitude of the pickup address. Need to be given together, if given. Won’t be processed if one of the fields (latitude, longitude) is blank."
},
{
"name": "locationId",
"kind": "optional",
"type": "string",
"description": "The external ID of the pickup location, taken from the customer’s address book"
},
{
"name": "arrivalTime",
"kind": "optional",
"type": "string",
"description": "The appointment time at the pickup location. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "earliestArrivalTime",
"kind": "optional",
"type": "string",
"description": "The earliest arrival time at the pickup location. Need to be given together, if given. Won’t be processed if one of the fields (earliestArrivalTime, latestArrivalTime) is blank. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "latestArrivalTime",
"kind": "optional",
"type": "string",
"description": "The latest arrival times at the pickup location. Need to be given together, if given. Won’t be processed if one of the fields (earliestArrivalTime, latestArrivalTime) is blank. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "wantTime",
"kind": "optional",
"type": "string",
"description": "The want time at the pickup location. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "earliestWantTime",
"kind": "optional",
"type": "string",
"description": "The earliest want time at the pickup location. Need to be given together, if given. Won’t be processed if one of the fields (earliestWantTime, latestWantTime) is blank. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "latestWantTime",
"kind": "optional",
"type": "string",
"description": "The latest want time at the pickup location. Need to be given together, if given. Won’t be processed if one of the fields (earliestWantTime, latestWantTime) is blank. The date format needs to be YYYY-MM-DD or YYYY/MM/DD and the time format needs to be HH:MM:SS (24-hour)."
},
{
"name": "postalCode",
"kind": "optional",
"type": "string",
"description": "The zip code of the pickup address"
}
]
}
],
"formDataParameters": []
},
"currentNewParameter": {
"label": "Body Parameter",
"value": "bodyDataParameters"
},
"hasTryItOut": false,
"autoGeneratedAnchorSlug": "staging",
"legacyHash": "SsIS3Ehpe8hnBtQABuqpz"
}
```
:::