Orders - Confirm

/v1/orders/confirm/

Important

For details on acquiring API credentials and a general overview, see https://fillz.zendesk.com/hc/en-us/articles/205624835-File-API-

GET /v1/orders/confirm/
Synopsis:Returns a list of all order-confirm files

Example Request:

GET /v1/orders/confirm/ HTTP/1.1 
Host: file-api.fillz.com
Accept: application/json
X-FillZ-Access-Key: EXAMPLEACCESSKEY
X-FillZ-Date: 20141118T225604Z
X-FillZ-Signature: 993cc83915f0849b105ec7d5014bd18bc7e953952d242ef5229974f09c789b6b

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "files": [
        {
            "id": "20141118T222611Z-23338d6f",
            "status": "done",
            "date_created": "20141118T222611Z",
            "report_uri": "https://file-api.fillz.com/v1/orders/confirm/report/20141118T222611Z-23338d6f",
            "status_uri": "https://file-api.fillz.com/v1/orders/confirm/status/20141118T222611Z-23338d6f"
        },
        {
            "id": "20141118T014133Z-15b1009d",
            "status": "submitted",
            "date_created": "20141118T014133Z",
            "report_uri": "https://file-api.fillz.com/v1/orders/confirm/report/20141118T014133Z-15b1009d",
            "status_uri": "https://file-api.fillz.com/v1/orders/confirm/status/20141118T014133Z-15b1009d"
        }
    ]
}
Query Parameters:
 
  • status(optional) the status of the files to be listed; must be one of submitted, processing, done, failed, or all. The default value is: all.
  • sort(optional) the order in which the files are returned, based on creation time; must be one of newest, oldest. The default value is: newest.
  • limit(optional) the maximum number of files returned in the result; must be an integer. The maxiumum value is 100. The default value is: 20.
Request Headers:
 
  • X-FillZ-Access-Key – Key used to identify the api caller. This is obtained from the Account->API/FTP page in FillZ
  • X-FillZ-Date – Current time in ISO8601 Basic format (YYYYMMDDThhmmssZ) using UTC
  • X-FillZ-Signature – Signature generated with the request signing method. See Appendix A for instructions on request signing
Response Headers:
 
Status Codes:
POST /v1/orders/confirm/
Synopsis:Upload a new orders-confirm file

Example Request:

POST /v1/orders/confirm/ HTTP/1.1
Host: file-api.fillz.com
X-FillZ-Access-Key: EXAMPLEACCESSKEY
X-FillZ-Date: 20141118T222611Z
X-FillZ-Signature: ced6826de95e2bfadd8f937f0ac708e8669e98d4c0145114c84f54174ace327b
Content-Type: application/tab-delimited

_content: 'order-id     status
           1000 shipped'

Example Response:

HTTP/1.1 201 CREATED
Content-Type: application/json

{
    "id": "20141118T222611Z-23338d6f",
    "report_uri": "https://file-api.fillz.com/v1/orders/confirm/report/20141118T222611Z-23338d6f",
    "status_uri": "https://file-api.fillz.com/v1/orders/confirm/status/20141118T222611Z-23338d6f"
}
Request Headers:
 
  • X-FillZ-Access-Key – Key used to identify the api caller. This is obtained from the Account->API/FTP page in FillZ
  • X-FillZ-Date – Current time in ISO8601 Basic format (YYYYMMDDThhmmssZ) using UTC
  • X-FillZ-Signature – Signature generated with the request signing method. See Appendix A for instructions on request signing
  • X-FillZ-Filename – Name of the file uploaded (optional)
Response Headers:
 
Status Codes:

/v1/orders/confirm/status/<order_file_id>

GET /v1/orders/confirm/status/<file_id>
Synopsis:Returns the status of a single order confirm file

Example Request:

GET /v1/orders/confirm/status/20141118T014133Z-15b1009d
Host: file-api.fillz.com
X-FillZ-Access-Key: EXAMPLEACCESSKEY
X-FillZ-Date: 20141119T014133Z
X-FillZ-Signature: 475b4f94e5999071285d9cacbf63be8212de7a60f68b81f6be6594fd330a6347

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "done",
    "uri": "https://file-api.fillz.com/v1/orders/confirm/status/20141118T014133Z-15b1009d",
    "report_uri": "https://file-api.fillz.com/v1/orders/confirm/report/20141118T014133Z-15b1009d",
    "date_created": "20141118T014133Z",
    "id": "20141118T014133Z-15b1009d"
}
Request Headers:
 
  • X-FillZ-Access-Key – Key used to identify the api caller. This is obtained from the Account->API/FTP page in FillZ
  • X-FillZ-Date – Current time in ISO8601 Basic format (YYYYMMDDThhmmssZ) using UTC
  • X-FillZ-Signature – Signature generated with the request signing method. See Appendix A for instructions on request signing
Response Headers:
 
Status Codes:

/v1/orders/confirm/report/<order_file_id>

GET /v1/orders/confirm/report/<file_id>
Synopsis:Returns the report of a single order confirm file

Example Request:

GET /v1/orders/confirm/report/20141118T222611Z-23338d6f
Host: file-api.fillz.com
X-FillZ-Access-Key: EXAMPLEACCESSKEY
X-FillZ-Date: 20141119T222611Z
X-FillZ-Signature: ced6826de95e2bfadd8f937f0ac708e8669e98d4c0145114c84f54174ace327b

Example Response:

HTTP/1.1 200 OK
Content-Type: application/text

File ID: 20141118T222611Z-23338d6f
Summary:
Total Orders Processed: 1
Success Count: 1
Error Count: 0

Detailed Report:
[14:26:36] set status of 5056 to shipped
Request Headers:
 
  • X-FillZ-Access-Key – Key used to identify the api caller. This is obtained from the Account->API/FTP page in FillZ
  • X-FillZ-Date – Current time in ISO8601 Basic format (YYYYMMDDThhmmssZ) using UTC
  • X-FillZ-Signature – Signature generated with the request signing method. See Appendix A for instructions on request signing
Response Headers:
 
  • Content-Typeapplication/text
  • Last-Modified – When the resource requested was last updated, in HTTP-Date format (see RFC 7321 for details)
  • X-Content-SHA256 – The calculated SHA256 hex digest
Status Codes: