v2/neworder[DEPRECATED]
About 1 min
v2/neworder[DEPRECATED]
Description
This endpoint is deprecated, please use PUT
api/customerorders instead.
Saves a new order or updates a pending order. If the packing slip number has already been processed, the message will be ignored.
Request
- Method:
PUT
- Content Type:
application/json
- URL:
https://api.gosweetspot.com/v2/neworder
Headers
- access_key : your unqiue api key provided by GSS.
- site_id : which site you are requesting action for.
Parameters
The body of the message should be sent as an JSON object.
Parameter | Type | Description |
---|---|---|
packingslipno | string | Specify the unique order number from your source system, that was used as the packing slip no when the order was published. |
consignee | string | Recepient name. |
address1 | string | Address line 1, eg, building identifier, like Level 1, Fisher House, etc. |
address2 | string | Address line 2, street name. |
suburb | string | Suburb name. |
city | string | City name or state name. Depending on destination country, if state information is available, this should be the abbreviated state code. |
postcode | string | Post code, for NZ addresses, this can be left blank if unknown. |
country | string | ISO Alpha 2 country code, eg NZ, AU, US, UK, CN. |
delvref | string | Order number, or customer reference for this order. |
delvinstructions | string | Any specific instructions to be printed on the label. |
contactname | string | Name of person, optional. |
contactphone | string | Phone number of person, optional. |
string | Email address for track & trace email, optional. |
Return format
A string object with true for a successful submit or false for an ignored submit.
Request example
curl --location -g --request PUT 'https://api.gosweetspot.com/v2/neworder' \
--header 'access_key;' \
--header 'site_id;' \
--header 'Content-Type: application/json' \
--data '{
"packingslipno": "test-14-07-01",
"consignee": "Test,",
"address1": "1 Queens Street",
"address2": "",
"suburb": "Auckland Centrol",
"city": "Auckland",
"postcode": "",
"country": null,
"delvref": null,
"delvinstructions": null,
"contactname": null,
"contactphone": null,
"email": null
}'
Response example
true