{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"7f562d8b-66d9-f48f-5b83-8f1994fb5ccd","name":"Fotomerchant Suite API","description":"# Authentication\n\nAuthentication is handled via the `Authorization` header with each request. A bearer token must be sent with each request for the purposes of authentication.\n\nThe `Authorization` header should contain the Bearer token as it's value:\n\n`Authorization: Bearer MY_BEARER_TOKEN`\n\nBearer tokens need to be requested from a Fotomerchant staff member.\n\n# User Agent\n\nAs a requirement for using this API, we ask that applications provide a custom User Agent HTTP header with their requests. This is used to uniquely identify your App traffic to our API for support and operational purposes.\n\nThe User Agent HTTP Header should include:\n\n- Product, App, Studio or Platform name.\n- Implementation version.\n    \n\nThe following format can be followed:\n\n```\nUser-Agent: /\n\n ```\n\n**Example 1:** When a product is using `node-fetch` the App information can be appended to the end of the existing User Agent string:\n\n```\nUser-Agent: node-fetch/1.0 CustomStudioApp/1.5.1\n\n ```\n\n**Example 2:** When a product is using a technology that does not have a default User Agent:\n\n```\nUser-Agent: CustomStudioApp/1.5.1\n\n ```\n\n# Pagination\n\nThere are two parameters available for all GET requests that return a list of one or more results.  \nThese parameters (page & limit) can be used to paginate the results of the request in a predictable way.\n\n| Parameter | Type | Mandatory | Possible Values | Description |\n| --- | --- | --- | --- | --- |\n| page | number | Optional | 1 | Specifies the page you wish returned |\n| limit | number | Optional | 100 | Specifies the size you would like each page to be. **Max value supported: 100** |\n\n**Example 1**\n\n`?page=1,limit=50` would return the first 50 results of the query.\n\n**Example 2**\n\n`?page=3,limit=50` would return the 101st to 150th result in the set.\n\nAn API response will include `paging` information when the results have had pagination applied.\n\nFor example:\n\n``` json\n{\n    \"clientSessions\": [ ... ],\n    \"paging\": {\n        \"page\": 1,\n        \"last\": 10,\n        \"limit\": 100,\n        \"count\": 100,\n        \"total\": 102\n    }\n}\n\n ```\n\nThis response element includes:\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| page | number | The current page of results included. |\n| last | number | The page number for the last page of results. |\n| limit | number | The limit used to generate the paged results. |\n| count | number | The number of results included on the current page. |\n| total | number | The total number of results available across all pages. |\n\n# Date Formats\n\nThere are only two formats the API accepts when a datetime value is specified (either as a query string or in the request's body):\n\n- **As a date:** use the _YYYY-MM-DD_ format (eg: `2024-11-22`)\n- **As a date and time:** use the _YYYY-MM-DDTHH:mm:ss_ format (eg: `2024-11-22T12:30:00`) - note the **T** in use to separate the two\n    \n\nThe API performs strict validation on such values and formats, so ambigous dates are discarded (for instance, `2024-15-15` as well as `2024-02-30`) and the timezone is enforced to UTC (Coordinated Universal Time).\n\n**Important note:** unless specified otherwise, the provided date and time parameters are always _inclusive_, and any date (without the time part) used as upper limit is always capped to the end of that same day\n\nReference:\n\n|  | Date To | Match |\n| --- | --- | --- |\n| `2024-01-01` | `2024-01-01` | ❌ 2023-12-31 23:59:00.999  <br>✅ 2024-01-01 00:00:00  <br>✅ 2024-01-01 23:59:59.999  <br>❌ 2024-01-02 00:00:00 |\n| `2024-01-01` | `2024-02-01T00:00:00` | ❌ 2023-12-31 23:59:00.999  <br>✅ 2024-01-01 00:00:00  <br>✅ 2024-01-02 00:00:00  <br>✅ 2024-02-01 00:00:00 |\n| `2024-01-02T00:00:00` | `2024-01-02T00:00:00` | ❌ 2024-01-01 00:00:00  <br>✅ 2024-01-02 00:00:00  <br>❌ 2024-01-02 00:00:01 |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"3082138","collectionId":"7f562d8b-66d9-f48f-5b83-8f1994fb5ccd","publishedId":"77k4gnc","public":true,"publicUrl":"https://apidocs.fotomerchanthv.com","privateUrl":"https://go.postman.co/documentation/3082138-7f562d8b-66d9-f48f-5b83-8f1994fb5ccd","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2020-03-18T06:01:36.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"PROD","id":"d81912a0-17a8-4817-9f9f-19d4a026e131","owner":"3082138","values":[{"key":"EnvCode","value":"","enabled":true},{"key":"Token","value":"BEARER_TOKEN","enabled":true},{"key":"SeasonId","value":":SeasonId","enabled":true},{"key":"ClientId","value":":ClientId","enabled":true},{"key":"ClientSessionTemplateId","value":":ClientSessionTemplateId","enabled":true},{"key":"ClientSessionId","value":":ClientSessionId","enabled":true},{"key":"OrderId","value":":OrderId","enabled":true},{"key":"SubjectId","value":":SubjectId","enabled":true},{"key":"ImageId","value":":ImageId","enabled":true,"type":"default"},{"key":"SourceImageId","value":":SourceImageId","enabled":true},{"key":"ImageCropId","value":":ImageCropId","enabled":true,"type":"default"},{"key":"BatchJobId","value":":BatchJobId","enabled":true,"type":"default"},{"key":"CatalogId","value":":CatalogId","enabled":true,"type":"default"},{"key":"LabToken","value":"LAB_TOKEN","enabled":true,"type":"default"},{"key":"CartToken","value":"CART_TOKEN","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://fotomerchanthv.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"PROD","value":"3082138-d81912a0-17a8-4817-9f9f-19d4a026e131"}],"canonicalUrl":"https://apidocs.fotomerchanthv.com/view/metadata/77k4gnc"}