update_order
HTTP Method: POST

Updates an existing order's status. You can change the status of an order with the api prior to it being placed in production. Once an order is in production you will need to contact our customer support team to make any further updates.

Endpoint

https://api.finerworks.com/v3/update_order


Authorization Credentials
Must include in header or as querystring parameters during request.

Name/KeyDescriptionTypeAdditional information
web_api_key

Can be found here within your FinerWorks account.

text

Required

app_key

Can be generated here within your FinerWorks account.

text

Required

Body Parameters

Order udpate details to be submitted via JSON

NameDescriptionTypeAdditional information
order_id

The unique order submission reference id you received after your order was successfully submitted.

number

Required

update_command

Command to change the status. Use the following: pending = forwards it to our fulfillment center, hold = places the order on hold, cancel = cancels the order submission. Cancel is useful if you need to resubmit the order later with the same order_po.

text

Required

Example

application/json, text/json

{
  "order_id": 2,
  "update_command": "sample string 3"
}

NameDescriptionTypeAdditional information
success

Indicates if the status returned was successful

boolean

None.

status_code

HTTP Status code

HttpStatusCode

None.

message

Additional information may be included here

text

None.

debug

Used to assist debugging any errors

Exception

None.

Example

application/json, text/json

{
  "success": true,
  "status_code": 100,
  "message": "sample string 2",
  "debug": {
    "ClassName": "System.Exception",
    "Message": null,
    "Data": null,
    "InnerException": null,
    "HelpURL": "sample string 1",
    "StackTraceString": null,
    "RemoteStackTraceString": null,
    "RemoteStackIndex": 0,
    "ExceptionMethod": null,
    "HResult": 3,
    "Source": "sample string 2",
    "WatsonBuckets": null
  }
}