8.1 - Order Get

BEES entity responsible to communicate the order to partner. In BEES today we work in a passive way, the partner requests the pending orders via HTTP GET. Following examples:


                  curl --request GET \
            --url 'https://services-uat.bees-platform.dev/v1/order-service/v3/orders?orderStatus=PENDING&orderBy=PLACEMENT_DATE&sort=DESC&limit=50' \
            --header 'Authorization: Bearer {{token}}' \
            --header 'Content-Type: application/json' \
            --header 'Content-Type": application/json' \
            --header 'country: TZ' \
            --header 'requestTraceId: 92ec94ba-aee4-11ec-b909-0242ac120002'

REQUEST PARAMETERS

Parameter	Required	BEES GROW Required	BEES FORCE Required	Comments	Example
country string	true	true	true	The country ISO acronym.	BR
orderStatus string	true	true	true	The status to filter the orders. More than one status is accepted. If using 'ALL' option, only this can be used and 'orderStatusCondition' MUST BE 'INCLUDE'. Values used: ALL / PENDING / PLACED / CONFIRMED / DENIED / MODIFIED / IN_TRANSIT / CANCELLED / DELIVERED / PARTIAL_DELIVERY / INVOICED / PENDING_CANCELLATION / PENDING_PAYMENT	PENDING
limit integer	false	false	false	The page size	50
orderBy string	false	false	false	Inform one or more fields to order results by. Values used: UPDATED_AT / DELIVERY_DATE / PLACEMENT_DATE	PLACEMENT_DATE
sort string	false	false	false	The sorting to be used on orderBy column. Values used: ASC / DESC	DESC

8.1.1. - Response Get Order


                  {
            "orders":[
              {
                "beesAccountId": "58a1bf78-d727-4b2c-b514-9b22bf9f254e",
                "channel": "B2B_APP",
                "orderNumber": "UAT0012083",
                "placementDate": "2023-12-31T12:34:47.000Z",
                "previousStatus": "PENDING",
                "status": "PENDING",
              }
            ]
          }

RESPONSE PROPERTIES

Property	BEES FORCE Required	BEES Partner Required	Comments	Example
orders array[OrderV3]	false		List of orders, object of OrderV3.
order.country string		true	Country related to the sale	EC
order.vendor_ID string		true	The unique identifier for the seller
orders.beesAccountId string	true	true	Brewery code.	ACC-111-111
orders.channel string	true	true	The source channel which created this order. Used B2B_APP generated by the application, B2B_WEB generated by the browser. CX_TLP generated by BEES GROW	B2B_APP
orders.orderNumber string	true	true	The order bees number.	UAT0012083
orders.placementDate string	true	true	Placement date.	2023-12-31T12:34:47.000Z
orders.previousStatus string	false		Previous Status. However, when the Order is generated in the App/Web, its status is 'PENDING'. Allowed values: PENDING / PLACED / CONFIRMED / DENIED / MODIFIED / IN_TRANSIT / CANCELLED / DELIVERED / PARTIAL_DELIVERY / INVOICED / PENDING_CANCELLATION / PENDING_PAYMENT	PENDING
orders.status string	true	true	Status of order. However, when the Order is generated in the App/Web, its status is 'PENDING'. Allowed values: PENDING / PLACED / CONFIRMED / DENIED / MODIFIED / IN_TRANSIT / CANCELLED / DELIVERED / PARTIAL_DELIVERY / INVOICED / PENDING_CANCELLATION / PENDING_PAYMENT	PENDING

8.2 - Audit


                  { 
            "orders":[
              {
                "audit": 
                  {
                    "createAt": "2023-01-26T13:08:07.264Z",
                     "updateAt": "2023-01-26T13:08:07.264Z"
                   }
              }
            ]
          }

REQUEST PARAMETERS

Property	Comments	Example
audit object	Object for order audit.
items.createAt string	Date of creation of the Order. Use ISODate format.	2023-01-26T13:08:07.264Z
items.updateAt string	Order update date. Use ISODate format.	2023-01-26T13:08:07.264Z

8.1.3. - Delivery


                  { 
            "orders":[
              {
                 "delivery": {
                    "date": "2023-01-27", 
                    "windowId": "123",
                    "type": "REGULAR",
                    "note": "Note description",
                    "deliveryCenterId": "DDC_01",
                    "distributionCenters": [
                      {
                        "id": "distribution-center-id-001",
                        "vendorId": "c069c91e-ab82-4fdd-83ab-057bb1b11993",
                        "minDays": 5,
                        "maxDays": 10,
                        "maxDate": "2022-05-24T17:53:34.366Z",
                        "minDate": "2022-05-24T17:53:34.366Z"
                      }
                    ]
                 },
              }
            ]
          }

RESPONSE PROPERTIES

Property	BEES GROW Required	BEES Force Required	BEES Partner Required	Comments	Example
delivery object		false		DeliveryV3 object
delivery.date string	true	true		Delivery date, which must be carried out.. Use ISODate format.	2023-01-26T13:08:07.264Z
delivery.deliveryCenterId string	false	false	true	Order update date. Use ISODate format.	2023-01-26T13:08:07.264Z
delivery.windowId string	true	false			123
delivery.type string	false	false		Indicate the type of delivery. Eg: alternative, regular	REGULAR
delivery.note string	false	false		Notes about the delivery date for this order.	Description note
delivery.deliveryCenterId string	false	false	true	The delivery center id.	DDC_01

Property	Comments	Example
delivery.distributionCenters array[DistributionCenterV3]	The distribution centers list of delivery
delivery.distributionCenters.id string	The distribution center id.	distribution-center-id-001
delivery.distributionCenters.vendorId string	Vendor id	c069c91e-ab82-4fdd-83ab-057bb1b11993
delivery.distributionCenters.mindDays integer	Minimum days	5
delivery.distributionCenters.maxDays integer	Maximum days	10
delivery.distributionCenters.maxDate string	Maximum date Use ISODate format.	2022-05-24T17:53:34.366Z
delivery.distributionCenters.minDate string	Minimum date Use ISODate format.	2022-05-24T17:53:34.366Z

8.1.4 - Items


                  {
            "orders":[
              {
                "items": [
                  {
                    "vendorItemId": "SKU_01_VEN_01",
                    "type": "REGULAR",
                    "quantity": 10, 
                    "image": "https://localhost/media/product/malte_600ml_1.jpg",
                    "name": "Budweiser",
                    "id": "SKU_0"
                    "key": "9109dcfa-7d2d-11eb-9439-0242ac130002",
                    "measureUnit": "ML",
                  }
                ],
              }
            ]
          }

RESPONSE PROPERTIES

Property	BEES FORCE Required	BEES Partner Required	Comments	Example
items array[ItemV3]	false		The list of items.
items.vendorItemId string	true		The vendor item id.	SKU_01_VEN_01
items.type string	true		Indicate the item type. Eg: FREEGOOD, REGULAR, EMPTY	REGULAR
items.quantity number	true	true	The item quantity selected by customer. Can be adjusted by order simulation and not reflect exactly what customer selected.	10
items.image string	false		The image for this item.	https://localhost/media/product/malte_600ml_1.jpg
items.name string	false		The name for this item.	Budweiser
items.keys string	true	true	Item unique key, related to this item on order. Used to identify a key into order, to update operations	9109dcfa-7d2d-11eb-9439-0242ac130002
items.measureUnit	false		The item measure unit	ML

8.1.4.1 - Items - Package


                  {
            "orders":[
              {
                "items": [
                  {
                    "package":{
                      "itemCount": 6,
                      "packageId": "PKG_01",
                      "unitCount": 6,
                      "materialType": "Glass",
                      "pack": "Bottle",
                      "name": "Budweiser Long Neck Pack"
                    },
                  }
                ],
              }
            ]
          }

RESPONSE PROPERTIES

Property	Comments	Example
items.package object	PackageV3 object
items.package.itemCount integer	The quantity of items inside package.	6
items.package.packageId string	The package unique identifier.	PKG_01
items.package.unitCount integer	The amount units inside the package.	6
items.package.materialType string	The type of material in the package.	Glass
items.package.pack string	Package type.	Bottle
items.package.name string	The package name.	Budweiser Long Neck Pack

8.1.4.2 - Items - Container


                  {
            "orders":[
              {
                "items": [
                  {
                     "container": {
                                  "name": "TIN",
                                  "unitOfMeasurement": "ML",
                                  "itemSize": 350,
                                  "returnable": false,
                                  "size": 6
                              },
                  }
                ],
              }
            ]
          }

RESPONSE PROPERTIES

Property	Comments	Example
items.container object	ContainerV3 object
items.container.name string	The container name.	TIN
items.container.unitOfMeasurement string	The unit of measurement used in this container.	ML
items.container.itemSize integer	The size of this container	350
items.container.returnable boolean	If this container is returnable	false
items.container.size number	Size of the container	6

8.1.4.3 - Items - Summary Items


                  {
            "orders":[
              {
                "items": [
                  {
                    "summaryItem": { 
                                  "discount": 1.05,
                                  "price": 10.15,
                                  "originalPrice": 12.5,
                                  "subtotal": 10.15,
                                  "total": 10.15,
                                  "taxes": [
                                      {
                                          "id": "GTS",
                                          "value": 10.5
                                      }
                                  ],
                                  "discounts": [
                                      {
                                          "type": "RECOMMENDATION",
                                          "externalId": "DEAL-001",
                                          "value": 10.15
                                      }
                                  ],                        
                              },
                  }
                ],
              }
            ]
          }

RESPONSE PROPERTIES

Property	BEES FORCE Required	BEES Partner Required	Comments	Example
items.summaryItem object	false		SummaryItemV3 object
items.summaryItem.discount number	true	true	The item discount	1.05
items.summaryItem.price number	true	true	The item price with discount	10.15
items.summaryItem.originalPrice number	false		The item original price	10.15
items.summaryItem.subtotal number	true		The item subtotal	10.15
items.summaryItem.total number	true		The item total	10.15

Property	BEES FORCE Required	BEES Partner Required	Comments	Example
summaryItems.taxes array[TaxV3]	false		Taxes applied to the item in the order
summaryItems.taxes.id string	true		Tax identifier	GTS
summaryItems.taxes.value number	true	true	Tax amount for the order.	10.15

Property	BEES FORCE Required	Comments	Example
summaryItems.discounts array[DiscountV3]	false	The item pricing discount details
summaryItems.discounts.type string	false	The type fot this deal	RECOMMENDATION
summaryItems.discounts.externalId string	false	The externalId for this deal.	DEAL-001
summaryItems.discounts.value number	false	Deal Budget.	10.15

8.1.5 - Order - Summary

Tax summary of the order


                  {
            "orders":[
              {
                "summary": {
                  "discount": 1.05,
                  "subtotal": 10.15,
                  "total": 11.02,
                      },
              }
            ]
          }

RESPONSE PROPERTIES

Property	Comments	Example
order.summary object	SummaryV3 object
order.summary.discount number	The order discount	1.05
order.summary.subtotal number	The order subtotal	1.05
order.summary.total number	The order total	1.05

8.1.5.1 - Taxes


                  {
            "orders":[
              {
                "summary": {
                  "taxes": [
                              {
                                  "id": "GTS",
                                  "value": 10.5
                              }
                          ],
                      },
              }
            ]
          }

RESPONSE PROPERTIES

Property	Comments	Example
summary.taxes array[TaxV3]	Taxes applied to the order
summary.taxes.id string	Tax identifier	GTS
summary.taxes.value number	Tax value for the order	10.5

8.1.5.2 - Dynamic Values


                  {
            "orders":[
              {
                "summary": {
                  "dynamicValues": {
                    "deposit": 1.05
                  }
                      }
              }
            ]
          }

RESPONSE PROPERTIES

Property	Comments	Example
summary.dynamicValues object	Other specifics values for Item. eg: deposit

8.1.5 - Charges


                  {
            "orders":[
              {
                "summary": {
                  "charges": [
                    {
                      "id": "RANDOM_EXTERNAL_ID_FROM_ZONE",
                                  "type": "DELIVERY_DATE_FEE",
                                  "value": 69.91,
                                  "conditions": [
                                      {
                                          "type": "NON_REGULAR_DELIVERY_DATE_FEE",
                                          "value": 69.91
                                      }
                                  ]
                              }
                          ],
                }
              }
            ]
          }

RESPONSE PROPERTIES

Property	Comments	Example
summary.charges array[ChargeV3]	Charges information
summary.charges.id string	The charge id	RANDOM_EXTERNAL_ID_FROM_ZONE
summary.charges.type string	The charge type	DELIVERY_DATE_FE
summary.charges.values number	The total price fot his charge	96.60

Property	Comments	Example
charges.conditions array[ConditionsV3]
charges.conditions.type string	Condition type	NON_REGULAR_DELIVERY_DATE_FEE
charges.conditions.value number	Condition value	38.49

8.1.6 - Vendor


                  {
            "orders":[
              {
                "vendor": {
                          "dynamicAttributes": {
                              "integrationVendorId": "VIPTST001"
                          },
                          "id": "c069c91e-ab82-4fdd-83ab-057bb1b11993", 
                          "accountId": "67845908",
                  "orderNumber":"123",
                      },	
              }
            ]
          }

RESPONSE PROPERTIES

Property	BEES FORCE Required	BEES Partner Required	Comments	Example
orders.vendor object	false
orders.vendor.id string	true	true	Vendor ID	c069c91e-ab82-4fdd-83ab-057bb1b11993
orders.vendor.accountId string	true		The vendor account id. Must be sent if the bees account id is not sent.	67845908
orders.vendor.orderNumber string	true		The vendor order number. This field is required if order number (on the root of the order) is not sent.	123
orders.vendor.dynamicValues object	false		Keep some vendor-specific attributes for Vendor.

8.2 - Order Patch

To modify any aspect of the order we use the http PATCH:


                  curl --location --request PATCH 'https://services-uat.bees-platform.dev/data-ingestion-relay-service/v1' \
          --header 'Authorization: Bearer ' \
          --header 'country: BR' \
          --header 'Content-Type: application/json' \
          --header 'accept: application/json' \
          --header 'requestTraceId: PATCH_ORDERS_vendor_empty' \
          --header 'Cookie: incap_ses_1354_2295550=pq0OILkv4RrmWYp6fWDKEkZjBmQAAAAA327yw7+ohaifyA1+YW3Uiw==; incap_ses_1354_2295595=lahiXsHeTRSotmF6fWDKEl0wBmQAAAAAqzz1ZBNlHj7m6gpv7tB3BQ==; nlbi_2295595=EK9MOC0LHQy1faWZBsuzOwAAAAA0ysZoUdSv+gRHMKyQvq5w' \
          --data-raw '{
            "entity": "ORDERS",
            "version": "V3",
            "payload": "[{\"order\":{\"status\":\"MODIFIED\",\"vendor\":{\"orderNumber\":\"numero_sap_gloria\"},\"orderNumber\":\"3105791257\",\"items\":[{\"key\":\"debbe8a5-2ff6-43c3-8a74-ba4269627572\",\"summaryItem\":{\"discount\":0.00,\"price\":102.14,\"originalPrice\":102.14,\"subtotal\":408.56,\"total\":408.56},\"vendorItemId\":\"000000000000718993\",\"quantity\":4}],\"summary\":{\"discount\":0.00,\"subtotal\":408.56,\"total\":408.56,\"charges\":[],\"aggregateAmount\":[],\"dynamicValues\":null}}}]"
          }'

8.2.1 - Order


                  [
    {
        "order": {
            "status": "CONFIRMED",           
            "orderNumber": "3105791257",           
        }
    }
]

REQUEST PROPERTIES

Property	BEES FORCE Required	BEES Partner Required	Comments	Example
order array[OrderV3PatchRequest]	false
order.status string	true	true	Order status. Orders can be created with any status but if a order exists and isn't in PENDING status the order can't be updated as PENDING. Allowed values: PENDING / PLACED / CONFIRMED / DENIED / MODIFIED / IN_TRANSIT / CANCELLED / DELIVERED / PARTIAL_DELIVERY / INVOICED / PENDING_CANCELLATION / PENDING_PAYMENT	CONFIRMED
order.orderNumber string	false	true	The BEES order number. This field is required if vendor order number is not sent.	3105791257

8.2.1.1 - Vendor


                  [
    {
        "order": {            
            "vendor": {
                "orderNumber": "number_order_partner" 
            },
        }
    }
]

RESPONSE PROPERTIES

Property	Comments	Example
order.vendor object	VendorV3PatchRequest object
order.vendor.orderNumber string	The vendor order number. This field is required if order number (on the root of the order) is not sent.	number_order_partner

8.2.1.2 - Items


                  [
    {
        "order": {           
            "items": [
                {
                    "key": "debbe8a5-2ff6-43c3-8a74-ba4269627572",
					"vendorItemId": "000000000000718993",
                    "quantity": 4
                    "summaryItem": {
                        "discount": 0.00,
                        "price": 102.14,
                        "originalPrice": 102.14,
                        "subtotal": 408.56,
                        "total": 408.56
                    }
                }
            ]
        }
    }
]

RESPONSE PROPERTIES

Property	BEES CUSTOMER Required	BEES FORCE Required	BEES Partner Required	Comments	Example
items array[ItemV3PatchRequest]	false	false		The list of items.
items.key string	true	false	true	Item unique key, related to this item on order. Used to identify a key into order, to update operations	debbe8a5-2ff6-43c3-8a74-ba4269627572
items.vendorItemId string	true	false		The vendor item id.	000000000000718993
items.quantity number	true	false	true	The item quantity selected by customer. Can be adjusted by order simulation and not reflect exactly what customer selected.	4

Property	Comments	Example
items.summaryItem object	ItemSummaryV3Request object
items.summaryItem.discount number	The item discount	0.00
items.summaryItem.price number	The item price with discount	102.00
items.summaryItem.originalPrice number	The item original price	102.00
items.summaryItem.subtotal number	The item subtotal	102.00
items.summaryItem.total number	The item total	102.00

8.2.1.3 - Summary


                  [
    {
        "order": {            
            "summary": { 
                "discount": 0.00,
                "subtotal": 408.56,
                "total": 408.56,
                "charges": [],
                "aggregateAmount": [],
                "dynamicValues": null
            }
        }
    }
]

RESPONSE PROPERTIES

Property	BEES CUSTOMER Required	BEES FORCE Required	Comments	Example
order.summary object	false	false	OrderSummaryV3Request
order.summary.discount number	false	false	The order discount	0.00
order.summary.subtotal number	true	false	The order subtotal	0.00
order.summary.total number	true	false	The order total	0.00
order.summary.charges array[ChargesV3Request]	false	false	Charges information
order.summary.aggregateAmount array[AggreagateAmountV3Request]	false	false	Aggregate amount
order.summary.dynamicValues object	false	false	Other specifics values for Item. eg: deposit