Excerpt

This method allows you to add a Prebook order to Komet Sales.

Tip
Valid Tokens: Company and Vendor.

Using this method you can create one of the following:

Prebook header only.
Prebook with header and product(s).
Prebook with header and product(s) with breakdown(s).

If you use a Vendor Token:

The system will omit the price, vendorId, vendorCode, and vendorName parameters.
The system will take the price only if your company has the Allow Changing Sales Price setting enabled.

Info
Orders created through this method are subject to a transaction fee of 1.5%.

Request

URL: https://api.kometsales.com/api/prebook.create

Method: POST

Content-Type: application/JSON

Input Parameters

authenticationToken (required) (string:50): Komet Sales security token.
customerId (required: if customerCode is not given) (integer:20): customer ID. You can obtain this value from the customer.list API method.
customerCode (required: if customerId is not given) (string:20): customer code.
customerDescription (required: if customerId is not given) (string:200): customer name.
carrierId (required: if carrierCode is not given) (integer:20) : carrier ID. You can obtain this value from the carrier.list API method.
carrierCode (required: if carrierId is not given) (string:20) : carrier code.
carrierDescription (required: if carrierId is not given) (string:200) : carrier name.
shipDate (required) (date): shipping date (date format YYYY-MM-DD).
createdBy (optional) (integer:20): Id of the user that created the order. This value represents the owner ID in Komet Sales.
shipViaId (logical)(integer:1): ship via ID. The ID of the location where the product will be shipped from. Assign 0 for warehouse or 1 for the grower.
customerPO (optional)(string:20): customer purchase order.
isEcommerce (optional)(integer:1): 1 when it is an E-commerce order, 0 when it is a Phone / Regular order.
useExisting (optional) (integer:1): 1 to add the items to an existing Prebook with the same location, carrier, truck date, customer, and customer PO# and ship to (if applicable). Enter 0 to create a new Prebook. By default will be 0.
comments (optional)(string:200): special instructions or comments.
autoGeneratePOsfromPrebooks (optional)(integer:1): specify 1 if you want the system to automatically generate the purchase orders. Default = 0. If this value is 1, the vendor and costs must be specified. The orders created will be left as Approved.
autoAllocate (optional)(integer:1): specify 1 if you want the system to automatically allocate the prebook that was just created with products from the inventory. Default = 0. The system will apply the same rules that the Mass Allocations process has. Only products with ages between 0 and 5 days will be taken in account.
status (optional) (varchar:50): the status of the prebook. Only works when the Prebook Status setting is enabled.
companyLocationCode (required: if the company is Multi-Location)(string:20): Location code.
prebookItems: array of products:
- identifier (optional)(string:30): use this field if you want to identify your lines and receive the same value in the response.
- vendorId (optional)(integer:20): vendor or grower ID. You can obtain this value from vendor.list API method.
- vendorCode (optional)(string:20): vendor or grower code, if vendorId is not given.
- vendorName (optional)(string:200): vendor or grower name, if vendorId is not given.
- productId (required: if productCode is not given)(integer:20): product ID. You can obtain this value from the product.list API method.
- productCode (required: if productId is not given)(string:20): code of the product.
- productDescription (required: if productId is not given)(string:200): description of the product.
- orderSource (optional)(string:20): The source of the product.
- itemType (string 3): the item type. Possible values: BOX or UN (unit). By default will be BOX.
- boxTypeId (required if boxTypeCode is not given and the itemType is box)(integer:20): box type ID. You can obtain this value from the boxtype.list API method.
- boxTypeCode (required: if boxTypeId is not given and the itemType is box)(string:3): code of the box type.
- boxTypeDescription (required: if boxTypeId is not given and the itemType is box)(string:3): name of the box type.
- boxes (required if the itemType is BOX) (integer:10): number of boxes.
- totalUnits (required if the itemType is UN) (integer:10): number of units.
- unitType (required) (string:5): stem or bunch are the unique valid values.
- bunches (required if the itemType is BOX) (integer:10): number of bunches per box
- stemsBunch (required if the itemType is box) (integer:10): stems per bunch. You can leave this field empty for mixed boxes.
- price (optional) (decimal:10,2): weighted average unit price. When unitType is bunch you must use the bunch price. When unitType is stem you must use the stem price.
- cost (optional) (decimal:10,2): weighted average unit cost. When unitType is bunch you must use the bunch cost. When unitType is stem you must use the stem cost. If the token used belongs to a vendor, this field will be accepted if the vendor has the Allow changing cost option enabled.
- markCode (optional)(string:50): mark code for item.
- notes (optional)(string:1000): any additional notes.
- futureSalesPoNumber (optional)(string:7): future sales purchase order number where the product belongs from. E.g.: P057116. Please take in account that the PO # should be the exactly same number that the system has, this means the order 57116 is not the same order that P057116.
- breakdowns (optional): array of product breakdowns:
  - productId (required: if productCode is not given) (integer:20): product ID. You can obtain this value from the product.list API method.
  - productCode (required: if productId is not given)(string:20): code of the product.
  - productDescription (required: if productId is not given)(string:200): description of the product.
  - bunches (required) (integer:10): bunches per box.
  - stemsBunch (required) (integer:10): stems for bunch.
  - cost (required)(decimal:10,2): when unitType is bunch you must use the bunch cost. When unitType is stem you must use the stem cost. If the token used belongs to a vendor, this field will be accepted if the vendor has the Allow changing cost option enabled.
  - price (required for tokens type company)(decimal:10,2): when unitType is bunch you must use the bunch price. When unitType is stem you must use the stem price.

Info
You can only use customerId and customerCode, or customerName at a time. We recommend you to use the customerId which can be obtained from the customer.list API method. You can use either carrierName and carrierId or carrierCode at a time. We recommend you to use the carrierId which can be obtained from the carrier.list API method.

Sample Request

Code Block{ "authenticationToken": "token_info_goes_here", "customerId": 9999, "customerPO": "PO4534", "shipToId": 999, "carrierId": 1878, "shipDate": "2014-04-10", "comments": "Comments or special instructions", "prebookItems": [ { "vendorId": 999, "productId": 999, "boxTypeId": 900, "orderSource": "phone call", "unitType": "Stem",

Anchor

	topofpage
	topofpage

Excerpt

Use this method to add a Prebook Order to Komet Sales. You can add a header, header and products, or a header with products and breakdowns.

Tip
Valid Tokens: Company and Vendor.

If you use a Vendor Token:

The system will omit the price, vendorId, vendorCode, and vendorName parameters.
The system will only apply the value entered in price if your company has the Allow Changing Sales Price setting enabled.

Info
Invoices created through this method are subject to a transaction fee. Internal company transactions are generally exempt from this transaction fee.

Filter by label (Content by label)

showLabels	false
max	5
title	Related Articles
cql	label in ( "prebook-api" , "company-token" , "create-prebook" , "recipes" )

Request

URL: https://api.kometsales.com/api/prebook.create

Method: POST

Content-Type: application/JSON

Input Parameters

authenticationToken (required)(string:50)

Komet Sales security token.

customerId (required if customerCode is not given)(integer:20)

Customer ID.

You can get this value from the customer.list API method.

customerCode (required if customerId is not given)(string:20)

Customer code.

customerDescription (required if customerId is not given)(string:200)

Customer name.

carrierId (required if carrierCode is not given) (integer:20)

Carrier ID.

You can obtain this value from the carrier.list API method.

carrierCode (required if carrierId is not given)(string:20)

Carrier code.

carrierDescription (required if carrierId is not given)(string:200)

Carrier name.

shipDate (required)(date)

Shipping date.

Date format: YYYY-MM-DD

createdBy (optional)(integer:20)

User ID from the User that is creating the Order.

This value represents the Komet Sales Owner ID.

shipViaId (logical)(integer:1)

Ship Via ID from the Location where the product will be shipped from.

Valid values: 0 = Warehouse | 1 = Grower

customerPO (optional)(string:20)

Customer Purchase Order.

isEcommerce (optional)(integer:1)

Order source.

Valid values: 0 = Phone/Regular Order | 1 = E-Commerce

useExisting (optional)(integer:1)

Add items to an existing Prebook with the same Location, Carrier, Truck date, Customer and Customer PO#, if there is one.

Valid values: 1 = Yes | 0 = Create a new Prebook

Default is zero.

comments (optional)(string:200)

Special instructions or comments.

autoGeneratePOsfromPrebooks (optional)(integer:1)

If you want the system to create the Purchase Orders for the Prebook.

To generate the Purchase Orders, you must use the vendorId, vendorName, or vendorCode and cost parameters in the request.

Automatically generated Purchase Orders will have Approved status.

Valid values: 1 = Yes | 0 = No

Default is zero.

autoAllocate (optional)(integer:1)

Automatically allocate the Prebook with products from the inventory.

Valid values: 1 = Yes | 0 = Follow the rules of the Mass Allocations process

The system will only consider products with an Aging between zero and five days.

status (optional)(varchar:50)

The Prebook status.

Only works when the Prebook Status setting is Enabled.

companyLocationCode (required)(string:20)

Location code.

Only applies to Multi-Location Companies.

prebookItems (optional)(array)

An array containing products.

identifier (optional)(string:30)

Line ID.

vendorId (optional)(integer:20)

Vendor or Grower ID.

You can get this value from vendor.list API method.

vendorCode (optional)(string:20)

Vendor or Grower code, if vendorId is not given.

vendorName (optional)(string:200)

Vendor or Grower name, if vendorId is not given.

productId (required if productCode is not given)(integer:20)

Product ID.

You can get this value from the product.list API method.

productCode (required if productId is not given)(string:20)

Product code.

productDescription (required if productId is not given)(string:200)

Product description.

orderSource (optional)(string:20)

Product source.

itemType (optional)(string 3)

Item type.

Valid values: BOX = Boxes | UN = Unit

Default is BOX.

boxTypeId (required if boxTypeCode is not given and itemType is BOX)(integer:20)

Box type ID.

You can get this value from the boxtype.list API method.

boxTypeCode (required if boxTypeId is not given and itemType is BOX)(string:3)

Box type code.

boxTypeDescription (required if boxTypeId is not given and itemType is BOX)(string:3)

Box type name.

boxes (required if itemType is BOX)(integer:10)

Number of boxes.

totalUnits (required if itemType is UN)(integer:10)

Number of units.

unitType (required)(string:5)

Unit type.

Valid values: Stem or Bunch

bunches (required if itemType is BOX)(integer:10)

Number of Bunches per Box.

stemsBunch (required if itemType is BOX)(integer:10)

Stems per Bunch.

You can leave this field empty for mixed boxes.

price (optional)(decimal:10,2)

Weighted average Unit price according to the value entered in unitType.

cost (optional)(decimal:10,2)

Weighted average Unit cost.

If you use a Vendor token, the system will only accept this parameter if the Allow Changing Cost setting is enabled.

markCode (optional)(string:50)

Item mark code.

notes (optional)(string:1000)

Additional notes.

futureSalesPoNumber (optional)(string:7)

Future Sales Purchase Order number where the product belongs to. For example, P057116.

Please take in account that the PO# must be the exact same number that the system has, this means the order 57116 is not the same order that P057116.

breakdowns (optional)(array)

An array containing product breakdowns.

productId (required if productCode is not given)(integer:20)

Product ID.

You can get this value from the product.list API method.

productCode (required if productId is not given)(string:20)

Product code.

productDescription (required if productId is not given)(string:200)

Product description.

bunches (required)(integer:10)

Bunches per Box.

stemsBunch (required)(integer:10)

Stems per Bunch.

cost (required)(decimal:10,2)

Unit cost, according to the value provided in unitType.

If you use a Vendor token, the system will only accept this parameter if the Allow Changing Cost setting is enabled.

price (required)(decimal:10,2)

Unit price, according to the value provided in unitType.

Only applies to Company tokens.

You can only use customerId and customerCode, or customerName at a time. We recommend you to use customerId which can be obtained from the customer.list API method.
You can use carrierName and carrierId or carrierCode at a time. We recommend you to use carrierId which can be obtained from the carrier.list API method.

Back to top

Code Block

{
   "authenticationToken": "token_info_goes_here",
   "customerId": 9999,
   "customerPO": "PO4534",
   "shipToId": 999,
   "carrierId": 1878,
   "shipDate": "2014-04-10",
   "comments": "Comments or special instructions",
   "prebookItems": [
      {
         "

boxes

vendorId":

5

999,
         "

bunches

productId":

10

999,
         "

stemsBunch

boxTypeId":

2

900,
         "

cost

orderSource":

0.7

 "phone call",
         "

price

unitType":

2.5

"Stem",
         "

markCode

boxes":

"text for mark code"

5,
         "

notes

bunches":

"text for notes"

10,
         "

breakdowns

stemsBunch":

[

2,
         "cost": 0.7,

{

        "price": 2.5,
         "

productId

markCode":

999,

"text for mark code",

bunches

notes":

2,

"text for notes",

stemsBunch

breakdowns":

3,

"cost": 0.75,

{
               "

price

productId":

1.5

999,
               "

identifier

bunches":

"02343678"

2,

}

   "stemsBunch": 3,

]

} ] }

Response

Output

status (integer:1): transaction status. 1 for success or 0 for failure.

message (string:500): description of the status of the transaction.

prebookId (integer:20): prebook ID.

prebookNumber (integer:10): prebook number.

purchaseOrderNumbers (string:200) PO numbers separated by commas, if autoGeneratePOsfromPrebooks is given.

items (array)

identifier (string:20). The value that identifies the line. This is the same value of the request, if it was given.

status: (integer:1): transaction status. 1 for success or 0 for failure.

    "cost": 0.75,
               "price": 1.5,
               "identifier": "02343678"
            }
         ]
      }
   ]
}

Response

status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure

message (string:500)

: description of the status of the transaction

Transaction status description.

prebookItemId

prebookId (integer:

10

20)

ID of the product line that was added to the order

Prebook ID.

productId

prebookNumber (integer:

20) (if productId was given)

10)

Prebook number.

productCode

purchaseOrderNumbers (string:

20) (if productCode was given).

futureSalesPoNumber (string:7) (if futureSalesPoNumber was given).

availableBoxes (integer:10): number of boxes that are available if futureSalesPoNumber was given.

Sample Response

Code Block

{
   "status": "1",
   "message": "Prebook was successfully created.",
   "prebookId": 2543545,
   "prebookNumber": 4343,
   "purchaseOrderNumbers": "",
   "items": [
      {
         "productId": 999,
         "status": 1,
         "message": "Item successfully added to the order",
         "prebookItemId": 3427612,
         "identifier": "02343678"
      }
   ]
}

Sample Response

200)

PO numbers separated by commas, if autoGeneratePOsfromPrebooks is given.

items (array)

An array containing items in the Prebook.

identifier (string:20)

Line ID.

This is the same value entered in the identifier parameter of the request.

status: (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure

message (string:500)

Transaction status description.

prebookItemId (integer:10)

ID of the product line that was added to the order.

productId (integer:20)

Product ID.

This is the same value entered in the productId parameter of the request.

productCode (string:20)

Product code.

This is the same value entered in the productCode parameter of the request.

futureSalesPoNumber (string:7)

Future Sales PO Number.

This is the same value entered in the futureSalesPoNumber parameter of the request.

availableBoxes (integer:10)

Number of boxes that are available.

Only applies if futureSalesPoNumber was given in the request.

Back to top

Code Block

{
   "status": 1,
   "message": "Prebook was successfully created. All the purchase orders were successfully created",
   "prebookId": 1640006,
   "prebookNumber": "010225",
   "purchaseOrderNumbers": "P002989, P002990",
   "items": [
      {
         "productId": 999,
         "status": 1,
         "prebookItemId": 3427612,
         "message": "Item successfully added to the order"
      },
      {
         "productCode": "RF567",
         "status": 1,
         "prebookItemId": 3427612,
         "futureSalesPoNumber": "P012345",
         "availableBoxes": 2,
         "message": "Item successfully added to the order"
      }
   ]
}

Filter by label (Content by label)

showLabels	false
max	5
title	Related Articles
cql	label in ( "prebook-api" , "company-token" , "create-prebook" , "recipes" )

Request

We've encountered an issue exporting this macro. Please try exporting this page again later.

Versions Compared

Old Version 2

New Version Current

Key

Request

Input Parameters

Sample Request

Request

Input Parameters

Response

Output

Response

Sample Response

Page Comparison

Versions Compared

Old Version 2

New Version Current

Key

Request

Input Parameters

Sample Request

Request

Input Parameters

Response

Output

Response

Sample Response