Orders - Modified

/v1/orders/modified/

Important

Before using this endpoint, please contact FillZ Support to have it enabled.

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/modified/
Synopsis:Returns a list of all order modified files

Example Request:

GET /v1/orders/modified/ HTTP/1.1
Host: file-api.fillz.com
X-FillZ-Access-Key: EXAMPLEACCESSKEY
X-FillZ-Date: 20140611T003735Z
X-FillZ-Signature: ced6826de95e2bfadd8f937f0ac708e8669e98d4c0145114c84f54174ace327b
HTTP/1.1 200 OK
Content-Type: application/json

{
  "files": [
    {
      "format": "fillz-order-tab",
      "checksum": "6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b",
      "acknowledged": false,
      "uri": "https://file-api.fillz.com/v1/orders/modified/20140611T003336Z-8b975127",
      "date_created": "20140611T003336Z",
      "id": "20140611T003336Z-8b975127"
    },
    {
      "format": "fillz-order-tab",
      "checksum": "d4735e3a265e16eee03f59718b9b5d03019c07d8b6c51f90da3a666eec13ab35",
      "acknowledged": false,
      "uri": "https://file-api.fillz.com/v1/orders/modified/20140611T013545Z-3e2f2083",
      "date_created": "20140611T013545Z",
      "id": "20140611T013545Z-3e2f2083"
    }
  ]
}
Query Parameters:
 
  • acknowledged(optional) the acknowledged state for the files to be listed; must be one of true, false or all. The default value is: false.
  • 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:

/v1/orders/modified/<order_file_id>

GET /v1/orders/modified/<file_id>
Synopsis:Returns a single orders-modified file with the specified id

Example Request:

GET /v1/orders/modified/20140611T003336Z-8b975127 HTTP/1.1
Host: file-api.fillz.com
X-FillZ-Access-Key: EXAMPLEACCESSKEY
X-FillZ-Date: 20140611T103735Z
X-FillZ-Signature: ced6826de95e2bfadd8f937f0ac708e8669e98d4c0145114c84f54174ace327b

Example Response:

HTTP/1.1 200 OK
Content-Type: application/tab-delimited

payment_status  order_id    order_item_id   payments_date   ...
                123         456             2014-09-11 13:13:13 ...
                124         457             2014-09-11 14:14:14 ...

Note

The above sample data does not show all columns, please see https://fillz.zendesk.com/hc/en-us/articles/204952269 for details.

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-Type – application/tab-delimited
  • Content-Length – Size of the body returned in bytes
  • 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
  • X-FillZ-Format – The format of the body in the response
  • X-FillZ-Acknowledged – Whether or not the file has been acknowledged (“True” or “False”)
Status Codes:
DELETE /v1/orders/modified/<file_id>
Synopsis:Acknowledges that an orders-modified file has been read. Future reads to this URI will return acknowledged:true

Example Request:

DELETE /v1/orders/modified/20140611T003336Z-8b975127
Host: file-api.fillz.com
X-FillZ-Access-Key: EXAMPLEACCESSKEY
X-FillZ-Date: 20140611T003735Z
X-FillZ-Signature: ced6826de95e2bfadd8f937f0ac708e8669e98d4c0145114c84f54174ace327b

Example Response:

HTTP/1.1 204 NO CONTENT
Content-Type: application/json
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: