prebook.update

Owned by Dan Giraldo
Last updated: May 25, 2022 by Andres Toledo
1 min read

This method allows you to update an existing prebook on Komet Sales. This method only allows you to update the main attributes of the prebook.

Request

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

Method: POST

Content-Type: application/JSON

Input Parameters

  • authenticationToken (required)(string:20): Komet Sales security token.

  • prebookId (required)(integer:20): the Komet Sales internal Prebook ID that you want to update. You can obtain this value from the prebook.create API method.

  • carrierId (optional) (number:20) : carrier ID. You can obtain this value from the carrier.list API method.

  • shipDate (optional) (date): new shipping date (date format YYYY-MM-DD).

  • 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 Grower.

  • customerPO (optional)(string:20): customer purchase order.

  • comments (optional)(string:200): special instructions or comments.

Sample Request

{ "authenticationToken": "token_info_goes_here", "prebookId": 345345, "carrierId": 1878, "shipDate": "2016-08-11", "customerPO": "P099999", "comments": "New instructions" }

Response

Output

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

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

Sample Response

{ "status": "1", "message": "success" }
Related Articles