get_product_details
HTTP Method: POST

Request details and pricing (up to 25 skus at a time) based on sku and quantity. Additional response parameters may be added in the future as requested.

Endpoint

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


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
product_order_po

Optional - This is a unique order identifier or reference number. For example, an order numnber generated by your shopping cart or application.

text

Max length: 50

product_qty

Number of copies of this product to be shipped

number

Required

Range: inclusive between 1 and 999

product_sku

Must be either a sku within your virtual inventory or a print-on-demand product sku.

text

Required

product_image

Should only be provided if NOT using a Sku from your virtual inventory.

product_image_file

None.

product_title

Optional title or descriptive name

text

Max length: 50

product_guid

Optional - A 128-bit integer (16 bytes) unique identifier

globally unique identifier

None.

Example

application/json, text/json

[
  {
    "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": "2706843d-5044-49a6-9f4b-5e1ac3268afd"
  },
  {
    "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": "2706843d-5044-49a6-9f4b-5e1ac3268afd"
  }
]

NameDescriptionTypeAdditional information
status

response_status

None.

product_list

array (product_details)

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
    }
  },
  "product_list": [
    {
      "monetary_format": "sample string 1",
      "quantity": 2,
      "sku": "sample string 3",
      "per_item_price": 4.0,
      "total_price": 5.0,
      "name": "sample string 6",
      "description_short": "sample string 7",
      "description_long": "sample string 8",
      "image_url_1": "sample string 9",
      "image_url_2": "sample string 10",
      "image_url_3": "sample string 11",
      "image_url_4": "sample string 12",
      "image_url_5": "sample string 13",
      "image_guid": "2f0fdfd2-4702-4565-9bd2-0efbe2328c39"
    },
    {
      "monetary_format": "sample string 1",
      "quantity": 2,
      "sku": "sample string 3",
      "per_item_price": 4.0,
      "total_price": 5.0,
      "name": "sample string 6",
      "description_short": "sample string 7",
      "description_long": "sample string 8",
      "image_url_1": "sample string 9",
      "image_url_2": "sample string 10",
      "image_url_3": "sample string 11",
      "image_url_4": "sample string 12",
      "image_url_5": "sample string 13",
      "image_guid": "2f0fdfd2-4702-4565-9bd2-0efbe2328c39"
    }
  ]
}