Create Note
Uri: https://api.finerworks.com/v3/submit_note
Method: POST

Adds a note an order's log. Notes are for back reference purposes only and are NOT used for outside communication instructions to the production department or customer service.


Header
Recommended these be included in the header. Alternatively they can be included 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

NameDescriptionTypeAdditional information
order_id

Assigned FinerWorks order id number

number

Required

subject

subject line of message

text

Required

Max length: 100

message

Body of message

text

Required

Example

application/json, text/json

{
  "order_id": 1,
  "subject": "sample string 2",
  "message": "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

Object

None.

Example

application/json, text/json

{
  "success": true,
  "status_code": 100,
  "message": "sample string 2",
  "debug": {}
}