Create an order in Bringg to request an order delivery.
With Bringg's integration with Manhattan, you can send the standard Manhattan Request Driverpayload to request a driver for order delivery and receive real-time updates in Manhattan Active® Omni. To set this up, configure the system to automatically send the payload to Bringg after the picking and packing process is completed in Manhattan Active® Omni.
Before You Begin
- Send the following details to your Bringg admin:
- A list of carriers and service levels
- Credentials to include in Bringg webhooks
Authentication
- Contact your Bringg admin to receive an API client ID and key.
- Use the API client ID and key to request an authentication token.
- Add the authentication token to each of the headers of each request as a bearer token. For example:
Authorization: Bearer eyGH[...]
Send Requests to Bringg
Bringg's response includes a unique task_id as well as the external_id included in the Manhattan payload. Once a driver is assigned, the driver's name is automatically displayed in the Active® Omni UI. Bringg automatically sends webhooks with order updates so retailers can keep track of deliveries. You can also send API requests to get information about an order.
Use Cases
- The Create Order, Get Order, and Cancel Order requests are all intended for use with the Same-Day Delivery flow.
- The Get Quotes, Create Soft Reservation, and Hard Reservation requests are all intended for use with the Planned Delivery flow.
| Request | URL | Instructions |
|---|---|---|
| Create Order | POST https://us3-api.bringg.com/partner-integrations-service/v1/integrations/manhattan/orders | |
| Get Order | GET https://us3-api.bringg.com/partner-integrations-service/v1/integrations/manhattan/orders/:id | Send a GET request Including the order's Bringgtask_id or Manhattan shipmentId as a query parameter. |
| Cancel Order | POST https://us3-api.bringg.com/partner-integrations-service/v1/integrations/manhattan/orders/cancel | Send a POST request including the order id in the payload body. |
| Get Quotes | POST https://us3-api.bringg.com/partner-integrations-service/v2/integrations/manhattan/quotes | |
| Create Soft Reservation | POST https://us3-api.bringg.com/partner-integrations-service/v2/integrations/manhattan/orders | |
| Create Hard Reservation | PATCH https://us3-api.bringg.com/partner-integrations-service/v2/integrations/manhattan/orders |
Payload Examples
Create Order
Send a POST request using the Request Drivery payload to create a delivery.
{
"shipRequest": {
"provider": "DeliveryProviderExample",
"carrierCode": "DPE",
"shipment": {
"shipDate": "2024-09-16T13:00:14.596Z",
"deliveryDate": "2024-09-17T09:00:14.596Z",
"description": "P1234567890123",
"serviceLevel": "EXPRESS",
"fulfillmentId": "ORDER-123456-789101",
"orderId": "ORDER-123456-78910",
"monetaryValue": "100",
"currencyCode": "USD",
"shipper": {
"contact": {
"personName": "John Smith",
"phoneNumber": "+1234567890",
"email": "[email protected]"
},
"address": {
"streetLines": [
"123 Main St, New York, NY 10022, USA"
],
"city": "New York",
"stateOrProvinceCode": "NY",
"postalCode": "10022"
}
},
"recipient": {
"contact": {
"personName": "Alex Johnson",
"phoneNumber": "+1234567890",
"email": "[email protected]"
},
"address": {
"streetLines": [
"456 Oak Ave"
],
"city": "New York",
"stateOrProvinceCode": "NY",
"postalCode": "10019"
}
},
"referenceFields": [{
"key1": "Chicago",
"key2": "delivery"
}],
"packages": [
{
"contentDescription": "Package - P1234567890123",
"weight": {
"value": 5,
"weightUnits": "KG"
},
"dimensions": {
"length": 20,
"width": 10,
"height": 5
}
}
]
}
}
}
{
"severityType": "SUCCESS",
"notifications": [
{
"code": "0000",
"message": null,
"severity": "SUCCESS",
"source": "Bringg"
}
],
"provider": "DeliveryProviderExample",
"completedShipments": [
{
"serviceType": null,
"serviceTypeName": null,
"shipmentId": "123456789",
"commitmentLevel": null,
"shipDate": "2024-09-16T13:00:14.596",
"documents": [
{
"documentType": "LABEL",
"formatType": "ZPLII",
"documentId": "123",
"image": null,
"image_url": null
}
],
"carrierName": "ExampleCarrier",
"carrierCode": "DPE",
"billingWeight": {
"value": 5,
"weightUnits": "KG"
},
"completedPackages": [
{
"packageType": "CUSTOM_PACKAGE",
"shipperReference": null,
"estimatedDeliveryDate": null,
"billingWeight": {
"value": 5,
"weightUnits": "KG"
},
"trackingNumber": "123456789",
"shippingCharge": {
"accessorialCharge": null,
"baseCharge": null,
"otherCharge": null,
"totalCharge": {
"amount": 90,
"currency": "USD"
}
},
"shipToHoldState": null,
"codtrackingNumber": null,
"packageId": "123"
}
],
"shippingCharge": {
"accessorialCharge": null,
"baseCharge": null,
"otherCharge": null,
"totalCharge": {
"amount": 90,
"currency": "USD"
}
}
}
]
}
{
"severityType": "ERROR",
"notifications": [
{
"code": "0000",
"message": "no service_plan with id [] external_id [EX-123] found",
"severity": "ERROR",
"source": "Bringg"
}
],
"provider": null,
"completedShipments": []
}
Get Order
Send the Get Order request to get the details of a delivery.
Get Order uses query parameters
The Get Order request does not include a request body.
Instead, send the order's Bringg
task_idor ManhattanshipmentIdas a query parameter.For example:
https://us3-api.bringg.com/partner-integrations-service/v1/integrations/manhattan/orders/:orderId12345
{
"severityType": "SUCCESS",
"notifications": [
{
"code": "0000",
"message": null,
"severity": "SUCCESS",
"source": "Bringg"
}
],
"provider": "DeliveryProviderExample",
"completedShipments": [
{
"serviceType": null,
"serviceTypeName": null,
"shipmentId": "123456789",
"commitmentLevel": null,
"shipDate": null,
"documents": [
{
"documentType": "LABEL",
"formatType": "ZPLII",
"documentId": "123",
"image": "AnonymizedImageBase64String",
"image_url": "https://example.com/anonymized-url"
}
],
"carrierName": "ExampleCarrier",
"carrierCode": "DPE",
"billingWeight": {
"value": 5,
"weightUnits": "KG"
},
"completedPackages": [
{
"packageType": "CUSTOM_PACKAGE",
"shipperReference": "1234567890",
"estimatedDeliveryDate": null,
"billingWeight": {
"value": 5,
"weightUnits": "KG"
},
"trackingNumber": "123456789",
"shippingCharge": {
"accessorialCharge": null,
"baseCharge": null,
"otherCharge": null,
"totalCharge": {
"amount": 90,
"currency": "USD"
}
},
"shipToHoldState": null,
"codtrackingNumber": null,
"packageId": "123"
}
],
"shippingCharge": {
"accessorialCharge": null,
"baseCharge": null,
"otherCharge": null,
"totalCharge": {
"amount": 90,
"currency": "USD"
}
}
}
]
}
{
"severityType": "ERROR",
"notifications": [
{
"code": "0000",
"message": "general error",
"severity": "ERROR",
"source": "Bringg"
}
],
"provider": null,
"completedShipments": []
}
Cancel Order
Send a POST request to cancel a delivery.
{
"Messages": null,
"CurrentObject": {
"ServiceLevelCode": "SD",
"IsVASRequired": false,
"ConsiderROPISPaid": false,
"CreatedTimestamp": "2024-06-13T15:42:09.748",
"IsCustomerOnTheWay": false,
"OrderDeliveryMethodSubType": null,
"PickDuration": null,
"Process": "/fulfillment/cancel/",
"CurrencyCode": "USD",
"FulfillmentAddress": [
{
"UpdatedTimestamp": "2024-06-13T15:42:09.76",
"CreatedBy": "[email protected]",
"CreatedTimestamp": "2024-06-13T15:42:09.76",
"Address": {
"FirstName": "John",
"LastName": "Smith",
"Address1": "123 Main Street",
"Address2": null,
"Address3": null,
"City": "San Francisco",
"State": "CA",
"PostalCode": "94105",
"County": null,
"Country": "US",
"Phone": "+14155552671",
"Email": "[email protected]"
},
"AddressCategory": null,
"Process": "PublishReleaseOutboundEventService",
"OrgId": "PARTNER",
"UpdatedBy": "[email protected]",
"AddressTypeId": {
"AddressTypeId": "Billing"
},
"IsShippingAddress": false,
"ContextId": "4a2b3d4f-5e6c-7d8e-9f0a-123456789abc",
"PK": "1234567890123456789",
"FulfillmentAddressId": "1234567890123456789",
"PurgeDate": null,
"Unique_Identifier": "1234567890123456789__1234567890123456789",
"ParentFulfillment": {
"PK": 1234567890123456000
}
},
{
"UpdatedTimestamp": "2024-06-13T15:42:09.778",
"CreatedBy": "[email protected]",
"CreatedTimestamp": "2024-06-13T15:42:09.778",
"Address": {
"FirstName": "John",
"LastName": "Smith",
"Address1": "123 Main Street",
"Address2": null,
"Address3": null,
"City": "San Francisco",
"State": "CA",
"PostalCode": "94105",
"County": null,
"Country": "US",
"Phone": "+14155552671",
"Email": "[email protected]"
},
"AddressCategory": "CustomerShipToAddress",
"Process": "PublishReleaseOutboundEventService",
"OrgId": "PARTNER",
"UpdatedBy": "[email protected]",
"AddressTypeId": {
"AddressTypeId": "Shipping"
},
"IsShippingAddress": true,
"ContextId": "4a2b3d4f-5e6c-7d8e-9f0a-123456789abc",
"PK": "1234567890123456789",
"FulfillmentAddressId": "abcdef1234567890abcdef1234567890",
"PurgeDate": null,
"Unique_Identifier": "1234567890123456789__abcdef1234567890",
"ParentFulfillment": {
"PK": 1234567890123456000
}
}
],
"CustomerPhone": null,
"UpdatedBy": "[email protected]",
"IsGift": false,
"PackedBy": null,
"CustomerFirstName": "John",
"OrderOrgId": null,
"Packages": [
{
"ShipmentId": null,
"ShipToAddress": {
"FirstName": "John",
"LastName": "Smith",
"Address1": "123 Main Street",
"Address2": null,
"Address3": null,
"City": "San Francisco",
"State": "CA",
"PostalCode": "94105",
"County": null,
"Country": "US",
"Phone": "+14155552671",
"Email": "[email protected]"
},
"ServiceLevelCode": "SD",
"ShippedDateTime": null,
"TaskId": null,
"CreatedTimestamp": "2024-06-13T15:42:55.043",
"TrackingNumber": null,
"PackageDetail": [],
"ShipFromLocationId": "STORE01",
"Process": "/fulfillment/cancel/",
"PackageStatus": {
"PackageStatusId": "9000.000"
},
"PackageTypeId": "CUSTOM_PACKAGE",
"FulfillmentId": "ORDER_240613_SD091",
"ReceivedDateTime": null,
"PackageDocuments": [],
"CurrentLocationId": "STORE01",
"UpdatedBy": "[email protected]",
"ReceiptType": null,
"PackedBy": null,
"ShipmentType": null,
"PreviousReceiptType": null,
"DeliveryStatus": null,
"PickupFulfillmentId": null,
"PurgeDate": null,
"ReturnTrackingNumber": null,
"IsRejectedPackage": false,
"DeliveryType": "Customer Pickup",
"UpdatedTimestamp": "2024-06-13T15:43:23.559",
"ShipToLocationId": null,
"CreatedBy": "[email protected]",
"GrossWeight": {
"Qty": 1,
"UOM": {
"name": "key",
"Code": "KG"
}
},
"TaskGroupId": null,
"CarrierBarcode": null,
"ShipViaId": "Sameday",
"EstimatedDeliveryDate": null,
"OrderId": null,
"GrossVolume": null,
"ContainsHazmat": false,
"Fulfillment": {
"FulfillmentId": "ORDER_240613_SD091"
},
"OrgId": "PARTNER",
"Type": null,
"ContextId": "4a2b3d4f-5e6c-7d8e-9f0a-123456789abc",
"CarrierCode": "SDD",
"PackageId": "P1234567890123",
"PK": "1234567890123456789",
"PackedDateTime": null,
"Unique_Identifier": "1234567890123456789__P1234567890123__ORDER_240613_SD091",
"LateShipment": false
}
],
"IsVerified": false,
"PurgeDate": null,
"IsSameDayDelivery": true,
"IsROPIS": false,
"DocTypeId": "CustomerOrder",
"ReturnToLocationId": null,
"IsNonParcel": false,
"CreatedBy": "[email protected]",
"IsReturnLabelRequired": false,
"Priority": "Not Applicable",
"TotalShortsQuantity": 0,
"PackDuration": null,
"DeliveryMethodId": "ShipToAddress",
"DestinationActionId": "Delivery",
"CustomerId": null,
"FulfillmentCustCommPref": [],
"FulfillmentPaymentMethod": [
{
"UpdatedTimestamp": "2024-06-13T15:42:09.785",
"CreatedBy": "[email protected]",
"CreatedTimestamp": "2024-06-13T15:42:09.785",
"PaymentMethodId": "PM123456789012345",
"Process": "PublishReleaseOutboundEventService",
"OrgId": "PARTNER",
"UpdatedBy": "[email protected]",
"CardTypeId": null,
"ContextId": "4a2b3d4f-5e6c-7d8e-9f0a-123456789abc",
"PK": "1234567890123456789",
"PaymentTypeId": "Cash",
"PurgeDate": null,
"Unique_Identifier": "1234567890123456789__PM123456789012345",
"ParentFulfillment": {
"PK": 1234567890123456000
}
}
],
"MaxStatusId": "9000.000",
"FulfillmentInstruction": [],
"DeliveryDueDate": "2024-06-13T15:42:00",
"ContextId": "4a2b3d4f-5e6c-7d8e-9f0a-123456789abc",
"MinStatusId": "9000.000",
"FulfillmentPickupConfirmation": null,
"OverageAllowed": false,
"DeliveryMethodSubType": null,
"PickupExpiryDate": "2024-06-18T15:42:54.432",
"AdditionalPurchasedValue": null,
"OrderPriority": null,
"ContainsAlert": false,
"ShippedDate": null,
"OrderCaptureDate": "2024-06-13T15:42:07.495",
"ShipFromLocationId": "STORE01",
"ContainsInstruction": false,
"IsClosed": false,
"FulfillmentId": "VIK-ORDER-240503-4312461",
"Source": "OM",
"IsPickupConvertToShipment": false,
"CanShipToAddress": true,
"CustomerEmail": null,
"FulfillmentLine": [
{
"IsSerialNumberRequired": false,
"ItemSmallImageURI": null,
"CreatedTimestamp": "2024-06-13T15:42:09.755",
"IsHazmat": false,
"UPC": null,
"Process": "/fulfillment/cancel/",
"ItemId": "ITEM01",
"ShippedQty": null,
"SortedQty": null,
"UpdatedBy": "[email protected]",
"IsGift": false,
"ItemStyle": "STYLE01",
"PurgeDate": null,
"OrderedQty": 1,
"CreatedBy": "[email protected]",
"LateOrderCancelDetails": [],
"ReleaseId": "ORDER_240613_SD091",
"OrderId": "ORDER_240613_SD09",
"FulfillmentLineStatusId": "9000.000",
"FulfillmentLineUnits": [],
"ItemColor": "BLUE",
"FulfillmentLineId": "1",
"ContextId": "4a2b3d4f-5e6c-7d8e-9f0a-123456789abc",
"AllocationId": "3813073172429821368442",
"FulfillmentLineShorts": [],
"FulfillmentLineStagingLocation": [],
"OriginalPickedQty": 1,
"ItemDescription": "ITEM01 desc",
"SupplyTypeId": null,
"FulfillmentLineTag": [
{
"GroupName": null,
"UpdatedTimestamp": "2024-06-13T15:42:10.097",
"CreatedBy": "[email protected]",
"CreatedTimestamp": "2024-06-13T15:42:10.097",
"GroupRank": null,
"Rank": null,
"Process": "PublishReleaseOutboundEventService",
"OrgId": "PARTNER",
"UpdatedBy": "[email protected]",
"ShowOnUi": false,
"TagId": "Others",
"ContextId": "4a2b3d4f-5e6c-7d8e-9f0a-123456789abc",
"PK": "1234567890123456789",
"PurgeDate": null,
"Unique_Identifier": "1234567890123456789__Others"
}
],
"PipelineId": "FULFILLMENT_EXECUTION",
"StoreDepartment": null,
"ItemSize": "M",
"AsnId": null,
"QuantityUom": "Unit",
"ItemUnitPrice": 90,
"UpdatedTimestamp": "2024-06-13T15:43:23.632",
"WeightUOM": "KG",
"ReceivedQty": null,
"SerialNumbers": null,
"LineShortCount": 0,
"CancelledQty": 1,
"ReturnedToShelf": false,
"PackedQty": null,
"PickedQty": 0,
"ItemUnitWeight": 1,
"CancelReasonId": null,
"ReleaseLineId": "1",
"OrgId": "PARTNER",
"OrderLineId": "1",
"PK": "1234567890123456789",
"Unique_Identifier": "1234567890123456789__1",
"FulfillmentLineInstruction": []
}
],
"OrderTypeId": "Ecom Order",
"IsPickToSlot": false,
"PickedBy": null,
"AdditionalPurchasedUnits": null,
"PickedupValue": null,
"FulfillmentStagingLocation": [],
"UpdatedTimestamp": "2024-06-13T15:43:23.631",
"ShipToLocationId": null,
"TransferTypeId": null,
"OnTime": false,
"ShipViaId": "Sameday",
"CancelReasonId": {
"FulfillmentReasonId": "This order is not needed anymore"
},
"OrgId": "PARTNER",
"OrderLocale": null,
"FulfillmentPickupContact": [],
"ShippingDueDate": "2024-06-13T15:42:00",
"PickupETADateTime": null,
"CustomerLastName": "Smith",
"PickupArrivalDateTime": null,
"CarrierCode": "SDD",
"PK": "1234567890123456789",
"ExpectedDeliveryDate": null,
"OrderTotal": null,
"SlotDetail": null,
"Unique_Identifier": "1234567890123456789__ORDER_240613_SD091"
},
"EventName": "FulfillmentCancel",
"ChangeSet": {
"MaxStatusId": "3000.000",
"Packages": [
{
"UpdatedTimestamp": "2024-06-13T15:42:55.47",
"ContextId": "1a2b3c4d-5e6f-7a8b-9c0d-123456789abc",
"PackageId": "P1234567890123",
"Process": "/fulfillment/createVirtualPackageAndGetTrackingNum",
"PK": "1234567890123456789",
"PackageStatus": {
"name": "key",
"PackageStatusId": "2000.000"
},
"FulfillmentId": "ORDER_240613_SD091"
}
],
"FulfillmentLine": [
{
"CancelledQty": 0,
"FulfillmentLineStatusId": "3000.000",
"PK": "1234567890123456789",
"PickedQty": 1,
"FulfillmentLineId": "1"
}
],
"PK": "1234567890123456789",
"MinStatusId": "3000.000",
"CancelReasonId": null,
"FulfillmentId": "ORDER_240613_SD091"
}
}
{
"severityType": "SUCCESS",
"notifications": [
{
"severity": "SUCCESS",
"source": "Bringg",
"code": "0000",
"message": "Cancelled successfully"
}
],
"provider": null,
"completedShipments": null
}
{
"severityType": "ERROR",
"notifications": [
{
"severity": "ERROR",
"source": "Bringg",
"code": "0000",
"message": "Failed to cancel the order"
}
],
"provider": null,
"completedShipments": null
}
Get Quotes
Send a POST request to get delivery estimates for a delivery.
{
"shipRequest": {
"Messages": null,
"provider": "DeliveryProviderExample",
"shipment": {
"shipDate": "2024-09-16T13:10:22.166Z",
"deliveryDate": "2024-07-01T13:29:53.385Z",
"description": "P1234567890123",
"fulfillmentId": "ORDER-123456-7891011",
"orderId": "ORDER-123456-789101",
"monetaryValue": "100",
"currencyCode": "USD",
"serviceLevel": "EXPRESS",
"shipper": {
"contact": {
"personName": "John Smith",
"phoneNumber": "(123) 456 7890",
"email": "[email protected]"
},
"address": {
"streetLines": [
"123 Main St"
],
"city": "Brooklyn",
"stateOrProvinceCode": "NY",
"postalCode": "11216"
}
},
"recipient": {
"contact": {
"personName": "Alex Johnson",
"phoneNumber": "1234567890",
"email": "[email protected]"
},
"address": {
"streetLines": [
"456 Oak Ave"
],
"city": "Brooklyn",
"stateOrProvinceCode": "NY",
"postalCode": "11216"
}
},
"dropOffType": null,
"specialService": null,
"customerReferences": [],
"packages": [
{
"contentDescription": "Package - P1234567890123",
"weight": {
"value": 1,
"weightUnits": "KG"
},
"dimensions": {
"length": 20,
"width": 10,
"height": 5,
"units": "IN"
},
"packageType": "CUSTOM_PACKAGE"
}
]
}
}
}
{
"quotes": [
{
"id": "anonymized-id-1",
"expiry_time": "2024-09-16T08:55:49.697Z",
"fleet": {
"quote_id": "anonymized-quote-id-1",
"id": 1281,
"fleet_type": 1,
"name": "DeliveryFleet1"
},
"currency_code": "USD",
"fee": 1181,
"priority": 1,
"delivery_terms_supported": true,
"pickup_window": {
"start_time": "2024-09-16T13:02:48.504Z",
"end_time": "2024-09-16T13:22:48.504Z"
},
"dropoff_window": {
"start_time": "2024-09-16T13:29:39Z",
"end_time": "2024-09-16T13:49:39.000Z"
}
},
{
"id": "anonymized-id-2",
"expiry_time": "2024-09-16T08:55:49.701Z",
"fleet": {
"quote_id": "anonymized-quote-id-2",
"id": 1275,
"fleet_type": 5,
"name": "DeliveryFleet2"
},
"currency_code": "USD",
"fee": 700,
"priority": 2,
"delivery_terms_supported": true,
"pickup_window": {
"start_time": "2024-09-16T12:50:47.000000Z",
"end_time": "2024-09-16T12:50:47.000000Z"
},
"dropoff_window": {
"start_time": "2024-09-16T13:12:39.000000Z",
"end_time": "2024-09-16T13:12:39.000000Z"
}
},
{
"id": "anonymized-id-3",
"expiry_time": "2024-09-16T08:55:49.699Z",
"fleet": {
"quote_id": "anonymized-quote-id-3",
"id": 1281,
"fleet_type": 1,
"name": "DeliveryFleet1"
},
"currency_code": "USD",
"fee": 1181,
"priority": 1,
"delivery_terms_supported": true,
"pickup_window": {
"start_time": "2024-09-16T13:02:48.496Z",
"end_time": "2024-09-16T13:22:48.496Z"
},
"dropoff_window": {
"start_time": "2024-09-16T13:29:39Z",
"end_time": "2024-09-16T13:49:39.000Z"
}
},
{
"id": "anonymized-id-4",
"expiry_time": "2024-09-16T08:55:49.703Z",
"fleet": {
"quote_id": "anonymized-quote-id-4",
"id": 1275,
"fleet_type": 5,
"name": "DeliveryFleet2"
},
"currency_code": "USD",
"fee": 700,
"priority": 2,
"delivery_terms_supported": true,
"pickup_window": {
"start_time": "2024-09-16T12:50:47.000000Z",
"end_time": "2024-09-16T12:50:47.000000Z"
},
"dropoff_window": {
"start_time": "2024-09-16T13:12:39.000000Z",
"end_time": "2024-09-16T13:12:39.000000Z"
}
},
{
"id": "anonymized-id-5",
"expiry_time": "2024-09-16T08:55:49.704Z",
"fleet": {
"quote_id": "anonymized-quote-id-5",
"id": 1281,
"fleet_type": 1,
"name": "DeliveryFleet1"
},
"currency_code": "USD",
"fee": 1181,
"priority": 1,
"delivery_terms_supported": true,
"pickup_window": {
"start_time": "2024-09-16T13:02:48.501Z",
"end_time": "2024-09-16T13:22:48.501Z"
},
"dropoff_window": {
"start_time": "2024-09-16T13:29:39Z",
"end_time": "2024-09-16T13:49:39.000Z"
}
},
{
"id": "anonymized-id-6",
"expiry_time": "2024-09-16T08:55:49.707Z",
"fleet": {
"quote_id": "anonymized-quote-id-6",
"id": 1275,
"fleet_type": 5,
"name": "DeliveryFleet2"
},
"currency_code": "USD",
"fee": 700,
"priority": 2,
"delivery_terms_supported": true,
"pickup_window": {
"start_time": "2024-09-16T12:50:47.000000Z",
"end_time": "2024-09-16T12:50:47.000000Z"
},
"dropoff_window": {
"start_time": "2024-09-16T13:12:39.000000Z",
"end_time": "2024-09-16T13:12:39.000000Z"
}
}
],
"quote_errors": [
{
"message": "estimate.items[0].description is not defined",
"fleet_name": "DeliveryFleet3",
"details": [],
"fleet_id": 1274,
"external_team_id": "Location1"
},
{
"fleet_name": "Internal fleet",
"message": "VrpAutoDispatchExecutor could not do quote",
"status": null,
"external_team_id": "Location1",
"details": []
}
]
}
{
"quote_errors": [
{
"fleet_name": "DeliveryFleet1",
"details": [],
"message": "Error during calculation quotes",
"fleet_id": 1274,
"external_team_id": "Location1"
},
{
"fleet_name": "Internal fleet",
"message": "VrpAutoDispatchExecutor could not do quote",
"status": null,
"external_team_id": "Location1",
"details": []
}
]
}
Create Soft Reservation
Send a POST request to create an order in Bringg using a quote_id from the Get Quotes response.
This request automatically tells Bringg that the delivery ise "ready_to_execute": false.
{
"shipRequest": {
"provider": "DeliveryProviderExample",
"carrierCode": "DPE", // "DPE" to find the fleet id, set null to ask quotes from all fleets
"shipment": {
"shipDate": "{{currentTimestamp}}",
"deliveryDate": "{{timestampPlus20Days}}",
"description": "{{package_id}}",
"serviceLevel": "EXPRESS",
"fulfillmentId": "{{fulfillment_id}}",
"orderId": "{{order_id}}",
"monetaryValue": "100",
"currencyCode": "USD",
"shipper": {
"contact": {
"personName": "John Smith",
"phoneNumber": "(123) 456-7890",
"email": "[email protected]"
},
"address": {
"streetLines": [
"123 Main St"
],
"city": "Brooklyn",
"stateOrProvinceCode": "NY",
"postalCode": "11216"
}
},
"recipient": {
"contact": {
"personName": "Alex Johnson",
"phoneNumber": "1234567890",
"email": "[email protected]"
},
"address": {
"streetLines": [
"456 Oak Ave"
],
"city": "Brooklyn",
"stateOrProvinceCode": "NY",
"postalCode": "11216"
}
},
"packages": [
{
"contentDescription": "Package - {{package_id}}",
"weight": {
"value": 1,
"weightUnits": "KG"
},
"dimensions": {
"length": 20,
"width": 10,
"height": 5,
"units": "IN"
},
"packageType": "CUSTOM_PACKAGE"
}
],
"extended": {
"robo_courier_specification": {
"mode": "auto"
},
"quoteId": "{{quote_id}}",
"reservedUntil": "{{reserved_until}}"
}
}
}
}
{
"severityType": "SUCCESS",
"notifications": [
{
"code": "0000",
"message": null,
"severity": "SUCCESS",
"source": "Bringg"
}
],
"provider": "DeliveryProviderExample",
"completedShipments": [
{
"serviceType": null,
"serviceTypeName": null,
"shipmentId": "123456789",
"commitmentLevel": null,
"shipDate": "2024-09-16T13:42:28.000",
"documents": [
{
"documentType": "LABEL",
"formatType": "ZPLII",
"documentId": "123",
"image": null,
"image_url": null
}
],
"carrierName": "ExampleCarrier",
"carrierCode": "DPE",
"billingWeight": {
"value": 1,
"weightUnits": "KG"
},
"completedPackages": [
{
"packageType": "CUSTOM_PACKAGE",
"shipperReference": null,
"estimatedDeliveryDate": null,
"billingWeight": {
"value": 1,
"weightUnits": "KG"
},
"trackingNumber": "123456789",
"shippingCharge": {
"accessorialCharge": null,
"baseCharge": null,
"otherCharge": null,
"totalCharge": {
"amount": 90,
"currency": "USD"
}
},
"shipToHoldState": null,
"codtrackingNumber": null,
"packageId": "123"
}
],
"shippingCharge": {
"accessorialCharge": null,
"baseCharge": null,
"otherCharge": null,
"totalCharge": {
"amount": 90,
"currency": "USD"
}
}
}
]
}
{
"severityType": "ERROR",
"notifications": [
{
"code": "0000",
"message": "Unknown error",
"severity": "ERROR",
"source": "Bringg"
}
],
"provider": null,
"completedShipments": []
}
Create Hard Reservation
Send a PATCH request to confirm a delivery with a carrier.
This request type automatically tells Bringg that the delivery is "ready_to_execute": true.
{
"ReturnLabelEmail": null,
"ProcessReturnReason": null,
"TaxOverrideType": null,
"ProcessReturnComments": null,
"CancelledTotalDiscounts": null,
"OrderMilestoneEvent": [],
"EntityLabels": null,
"IsPrinterLessReturn": false,
"IsUnArchiveInProgress": false,
"MerchSaleLineCount": 1,
"CustomerIdentityDoc": [],
"OrgId": "PARTNER",
"OrderLocale": null,
"MaxAppeasementAmount": 90.00,
"IsOrderCountable": true,
"OrderCaptureConfig": {
"PreventPostReleaseUpdate": null,
"UpdatedTimestamp": "2024-04-30T12:27:28.262",
"CreatedBy": "[email protected]",
"CreatedTimestamp": "2024-04-30T12:27:28.262",
"TaxFailoverGateway": null,
"InvoiceTaxModeId": "Quotation",
"ReturnVerificationPolicyId": null,
"Process": "/order/save",
"ReturnInvoiceTaxMode": "ReturnOrder",
"TrackDelivery": false,
"OrgId": "PARTNER",
"RequirePayment": null,
"UpdatedBy": "[email protected]",
"TaxComparisonStrategy": "Jurisdiction",
"ContextId": "07a02dc3-364d-472a-afe1-4453ffda7a0f",
"PK": "7144800482627386463",
"PurgeDate": null,
"Unique_Identifier": "7144800482627386463"
},
"CustomerLastName": "Doe",
"AwaitingPaymentForPBL": false,
"ReturnStatus": null,
"CapturedDate": "2024-04-30T12:27:26.725",
"NextEventTime": "2024-05-01T00:27:46.315",
"ChangeLog": {
"ModTypes": {
"Order": [
"Order::PaymentStatus::AwaitingPaymentInfo",
"Order::Confirmed",
"Order::OrderType",
"Order::CustomerId",
"Order::CustomerInfo"
],
"OrderLine": [
"OrderLine::EffectiveRank",
"OrderLine::Add",
"OrderLine::DeliveryMethod",
"OrderLine::AddressId",
"OrderLine::ItemId::Update",
"OrderLine::FulfillmentGroupId",
"OrderLine::ShippingInfo"
],
"QuantityDetail": [
"QuantityDetail::QuantityStatus::Increase::1000"
]
}
},
"CustomerTypeId": null,
"TotalDiscounts": null,
"CancelLineCount": 0,
"SelfServiceAttribute": null,
"OrderUpdatedBy": [
{
"UpdatedByUser": "[email protected]",
"UpdatedTimestamp": "2024-04-30T12:27:28.227",
"UpdatedBy": "[email protected]",
"OrgId": "PARTNER",
"CreatedBy": "[email protected]",
"CreatedTimestamp": "2024-04-30T12:27:28.227",
"UpdatedByDate": "2024-04-30",
"ContextId": "07a02dc3-364d-472a-afe1-4453ffda7a0f",
"Process": "/order/save",
"PK": "7144800482267376106",
"PurgeDate": null,
"Unique_Identifier": "[email protected]__2024-04-30"
}
],
"ReturnTrackingDetail": [],
"IsOnHold": false,
"Process": "releaseOrder",
"IsConfirmed": true,
"RefundPaymentMethod": null,
"SellingLocationId": null,
"FulfillmentStatus": "Released",
"OrderChargeDetail": [],
"OrderType": {
"OrderTypeId": "Ecom Order"
},
"TotalReturnFees": 0,
"CountedDate": "2024-04-30T12:27:30.034",
"TotalCharges": null,
"EInvoice": [],
"CancelledTotalCharges": null,
"PurgeDate": null,
"ReturnLineCount": 0,
"PaymentStatus": {
"StatusId": "5000.000"
},
"OrderSalesAssociate": [],
"Priority": null,
"StoreReturnCount": 0,
"OrderTagDetail": [],
"OrderFiscalBlockDetail": [],
"OrderSubTotal": 90.00,
"OrderCaptureDetail": [],
"CancelReason": null,
"ContactPreference": [],
"OrderPromotionRequest": [],
"OrderAdditional": null,
"ConfirmedDate": "2024-04-30T12:27:29.115",
"IsReadyForTender": false,
"CustomerAddress": null,
"VersionTimestamp": null,
"TransactionReference": [],
"TaxExemptComments": null,
"CancelledOrderTotal": null,
"OrderPromisingInfo": null,
"CancelledOrderChargeDetail": [],
"MinReturnStatus": null,
"OrderTaxDetail": [],
"SuggestedPromo": [],
"PackageCount": null,
"SellingChannel": {
"SellingChannelId": "Web"
},
"Release": [
{
"ReleaseType": null,
"UpdatedTimestamp": "2024-04-30T12:27:46.531",
"ServiceLevelCode": "SD",
"CreatedTimestamp": "2024-04-30T12:27:46.206",
"CreatedBy": "[email protected]",
"EffectiveRank": "Not Applicable",
"ShipToLocationId": null,
"ReleaseLine": [
{
"CancelledQuantity": 0.0,
"UpdatedTimestamp": "2024-04-30T12:27:46.231",
"EffectiveRank": "Not Applicable",
"CreatedBy": "[email protected]",
"CreatedTimestamp": "2024-04-30T12:27:46.231",
"FulfilledQuantity": 0.0,
"AllocationId": "2703803413069834766133",
"Quantity": 1.0,
"Process": "releaseOrder",
"ItemId": "ITEM01",
"ReleaseDependencyId": null,
"ReleaseLineId": "1",
"OrgId": "PARTNER",
"UpdatedBy": "[email protected]",
"UOM": "Unit",
"OrderLineId": "1",
"ContextId": "081332be-55cf-4935-848e-47f3ebab5990",
"PK": "7144800662317692449",
"PurgeDate": null,
"Unique_Identifier": "7144800662317692449__1",
"CancelledDate": null
}
],
"DeliveryMethodId": "ShipToAddress",
"ShipFromLocationId": "STORE01",
"ShipViaId": "Sameday",
"Process": "releaseOrder",
"ReleaseId": "{{order_id}}1",
"OrderId": "{{order_id}}",
"UpdatedBy": "[email protected]",
"OrgId": "PARTNER",
"ReleaseExtension1": [],
"DestinationAction": "Delivery",
"ContextId": "081332be-55cf-4935-848e-47f3ebab5990",
"CarrierCode": "SDD",
"PK": "7144800662067687094",
"PurgeDate": null,
"AddressId": null,
"Unique_Identifier": "7144800662067687094__ORDER_240430_011"
}
],
"ReturnTotalWithoutFees": 0,
"MaxReturnStatusId": null,
"MerchReturnLineCount": 0,
"ProcessInfo": null,
"CancelComments": null,
"PaperlessReturnOption": null,
"MaxFulfillmentStatus": {
"StatusId": "3000"
},
"OrderMilestone": [
{
"UpdatedTimestamp": "2024-04-30T12:27:29.669",
"CreatedBy": "[email protected]",
"CreatedTimestamp": "2024-04-30T12:27:29.669",
"ExpectedTime": null,
"ActualTime": "2024-04-30T12:27:29.665",
"MilestoneDefinitionId": "Order::Milestone::Created",
"Process": "/order/save",
"MonitoringRuleId": null,
"OrgId": "PARTNER",
"UpdatedBy": "[email protected]",
"ContextId": "07a02dc3-364d-472a-afe1-4453ffda7a0f",
"NextEventTime": null,
"PK": "7144800496687403873",
"PurgeDate": null,
"Unique_Identifier": "7144800496687403873__Order::Milestone::Created"
},
{
"UpdatedTimestamp": "2024-04-30T12:27:29.673",
"CreatedBy": "[email protected]",
"CreatedTimestamp": "2024-04-30T12:27:29.673",
"ExpectedTime": "2024-04-30T17:27:29.665",
"ActualTime": "2024-04-30T12:27:29.665",
"MilestoneDefinitionId": "Order::Milestone::Confirmed",
"Process": "/order/save",
"MonitoringRuleId": "AgedConfirmationDueAlertRule",
"OrgId": "PARTNER",
"UpdatedBy": "[email protected]",
"ContextId": "07a02dc3-364d-472a-afe1-4453ffda7a0f",
"NextEventTime": null,
"PK": "7144800496737417948",
"PurgeDate": null,
"Unique_Identifier": "7144800496737417948__Order::Milestone::Confirmed"
}
],
"OrderFiscalChainDetail": [],
"OrderImportErrorLogs": [],
"TotalTaxes": null,
"CancelledTotalTaxes": null,
"PK": "7144800467237343681",
"CancelledOrderTaxDetail": [],
"OrderFiscalDetail": null,
"OrderTotal": 90.00,
"Unique_Identifier": "7144800467237343681__ORDER_240430_01"
}
204 No Content
{
"type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404",
"title": "Not Found",
"status": 404,
"details": {
"reason": "Failed to find external id by order id"
},
"errors": {
"reason": "Failed to find external id by order id"
},
"data": {
"orderId": "ORDER-123456"
},
"success": false
}