submit_orders
HTTP Method: POST

Submits a list of new orders (up to 5 at a time) which includes customer details (sender and recipient) as well as line item details and optional display fields for the packing slip. Once an order is successfully submitted it will return a confirmation (order reference id) and place the order into an accepted status and ultimately in our production que.

Endpoint

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


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

NameDescriptionTypeAdditional information
orders

A list of orders which contain specifics of the order being submitted

array (order_details)

Required

validate_only

Default is always false. Set to "true" only if you want to pre-check your orders first and do not want the orders to be actually submitted. The response will simply provide a success status or notify you what is incomplete.

boolean

None.

Example

application/json, text/json

{
  "orders": [
    {
      "order_po": "sample string 1",
      "order_key": "a3f287f4-21cc-436d-887f-bc3527f774ba",
      "recipient": {
        "first_name": "sample string 1",
        "last_name": "sample string 2",
        "company_name": "sample string 3",
        "address_1": "sample string 4",
        "address_2": "sample string 5",
        "address_3": "sample string 6",
        "city": "sample string 7",
        "state_code": "sample string 8",
        "province": "sample string 9",
        "zip_postal_code": "sample string 10",
        "country_code": "sample string 11",
        "phone": "sample string 12",
        "email": "sample string 13",
        "address_order_po": "sample string 14"
      },
      "order_items": [
        {
          "product_order_po": "sample string 1",
          "product_qty": 2,
          "product_sku": "sample string 3",
          "product_image": {
            "pixel_width": 1,
            "pixel_height": 2,
            "product_url_file": "sample string 3",
            "product_url_thumbnail": "sample string 4"
          },
          "product_title": "sample string 5",
          "product_guid": "cf728ed0-e078-4a93-8479-68a08f8c2cbe",
          "custom_data_1": "sample string 8",
          "custom_data_2": "sample string 9",
          "custom_data_3": "sample string 10"
        },
        {
          "product_order_po": "sample string 1",
          "product_qty": 2,
          "product_sku": "sample string 3",
          "product_image": {
            "pixel_width": 1,
            "pixel_height": 2,
            "product_url_file": "sample string 3",
            "product_url_thumbnail": "sample string 4"
          },
          "product_title": "sample string 5",
          "product_guid": "cf728ed0-e078-4a93-8479-68a08f8c2cbe",
          "custom_data_1": "sample string 8",
          "custom_data_2": "sample string 9",
          "custom_data_3": "sample string 10"
        }
      ],
      "shipping_code": "sample string 2",
      "test_mode": true,
      "webhook_order_status_url": "sample string 4",
      "document_url": "sample string 5",
      "acct_number_ups": "sample string 6",
      "acct_number_fedex": "sample string 7",
      "custom_data_1": "sample string 8",
      "custom_data_2": "sample string 9",
      "custom_data_3": "sample string 10"
    },
    {
      "order_po": "sample string 1",
      "order_key": "a3f287f4-21cc-436d-887f-bc3527f774ba",
      "recipient": {
        "first_name": "sample string 1",
        "last_name": "sample string 2",
        "company_name": "sample string 3",
        "address_1": "sample string 4",
        "address_2": "sample string 5",
        "address_3": "sample string 6",
        "city": "sample string 7",
        "state_code": "sample string 8",
        "province": "sample string 9",
        "zip_postal_code": "sample string 10",
        "country_code": "sample string 11",
        "phone": "sample string 12",
        "email": "sample string 13",
        "address_order_po": "sample string 14"
      },
      "order_items": [
        {
          "product_order_po": "sample string 1",
          "product_qty": 2,
          "product_sku": "sample string 3",
          "product_image": {
            "pixel_width": 1,
            "pixel_height": 2,
            "product_url_file": "sample string 3",
            "product_url_thumbnail": "sample string 4"
          },
          "product_title": "sample string 5",
          "product_guid": "cf728ed0-e078-4a93-8479-68a08f8c2cbe",
          "custom_data_1": "sample string 8",
          "custom_data_2": "sample string 9",
          "custom_data_3": "sample string 10"
        },
        {
          "product_order_po": "sample string 1",
          "product_qty": 2,
          "product_sku": "sample string 3",
          "product_image": {
            "pixel_width": 1,
            "pixel_height": 2,
            "product_url_file": "sample string 3",
            "product_url_thumbnail": "sample string 4"
          },
          "product_title": "sample string 5",
          "product_guid": "cf728ed0-e078-4a93-8479-68a08f8c2cbe",
          "custom_data_1": "sample string 8",
          "custom_data_2": "sample string 9",
          "custom_data_3": "sample string 10"
        }
      ],
      "shipping_code": "sample string 2",
      "test_mode": true,
      "webhook_order_status_url": "sample string 4",
      "document_url": "sample string 5",
      "acct_number_ups": "sample string 6",
      "acct_number_fedex": "sample string 7",
      "custom_data_1": "sample string 8",
      "custom_data_2": "sample string 9",
      "custom_data_3": "sample string 10"
    }
  ],
  "validate_only": true
}

NameDescriptionTypeAdditional information
status

Status of response

response_status

None.

orders

List of orders that have been successfully submitted.

array (received_order)

None.

debug

Used to assist debugging any errors

Exception

None.

misc

Miscellaneous data

Object

None.

Example

application/json, text/json

{
  "status": {
    "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
    }
  },
  "orders": [
    {
      "order_po": "sample string 1",
      "order_id": 2,
      "order_confirmation_id": 3,
      "order_confirmation_datetime": "2019-11-22T19:14:47.0849589-06:00"
    },
    {
      "order_po": "sample string 1",
      "order_id": 2,
      "order_confirmation_id": 3,
      "order_confirmation_datetime": "2019-11-22T19:14:47.0849589-06:00"
    }
  ],
  "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
  },
  "misc": {}
}