Acknowledgements

REST Endpoints

POST /order/:orderId/acknowledge

Parameters

Name	Type	Description	Example
orderId (in url)	ID	The ID of the order to which the acknowledgement corresponds	"ckmnpybisiy5x08abky4g2d1f"
acknowledgementItems	AcknowledgementItem[]	An array of acknowledgementItems to be applied to the order's line items	See schema definition below

Acknowledgement Items

Each item on the acknowledgement should have the structure below.

Name	Type	Description	Example
backorderLeadTime	string?	If an item is backordered, the expected lead time	2 days
backorderQuantity	integer?	If an item is backordered, the quantity backordered	5
description	string?	A description of the item	12 gauge black THHN
extPriceFloat	float?	The subtotal of the item	4.50
itemId	ID?	The item's kojo id	cl70xmen80002oodabq9syjlq
lineNumber	integer?	The item's purchase order line number	1
manufacturerPartNumber	string?	The manufactuter part numnber for the item	1
quantity	integer?	The quantity of the item	3
unitPriceECM	string?	Multiplier used to calculate the extended price from the unit price. Must be either E, C, or M. Defaults to E.	"E"
unitPriceFloat	float?	The unit price of the item	1.50
unitsOfMeasure	string	The item's unit of measure	FT
universalProductCode	string?	The items UPC	FT
vendorPartNumber	string?	Your company's SKU for the item	FT

Response

The updated Order.

Example Request

POST https://api.kojo.tech/seller/order/cl5vad0wh0315m5lgqvsimj3k/acknowledge
{
  "acknowledgementItems': [
    {
      "itemId": "cl70xmen80002oodabq9syjlq",
      "lineNumber": 1,
      "unitPriceFloat": 100.05,
      "quantity": 2,
      "extPriceFloat": 200.10,
      "description": "6 Strand Copper Wire Soft Drawn 315'",
      "unitsOfMeasure": "FT"
    },
    {
      "itemId": "cl70xmen80003ooda4hv3my6j",
      "lineNumber": 2,
      "unitPriceFloat": 43.33,
      "quantity": 1,
      "extPriceFloat": 44.33,
      "description": "8 AWG THHN Stranded Copper, Green, 500'",
      "unitsOfMeasure": "FT"
    }
  ]
}

Example Response

{
  "id": "cl5vad0wh0315m5lgqvsimj3k",
  "buyerId": "cl5vad0wh0315m5lgqvsimj37",
  "createdAt": "2024-05-03T16:22:32.869Z",
  "orderId": "clvphf6dz022c4wu4l15giyw3",
  "acknowledgementItems":  [
    {
      "itemId": "cl70xmen80002oodabq9syjlq",
      "lineNumber": 1,
      "unitPriceFloat": 100.05,
      "quantity": 2,
      "extPriceFloat": 200.10,
      "description": "6 Strand Copper Wire Soft Drawn 315'",
      "unitsOfMeasure": "FT"
    },
    {
      "itemId": "cl70xmen80003ooda4hv3my6j",
      "lineNumber": 2,
      "unitPriceFloat": 43.33,
      "quantity": 1,
      "extPriceFloat": 44.33,
      "description": "8 AWG THHN Stranded Copper, Green, 500'",
      "unitsOfMeasure": "FT"
    }
  ]
}