{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"cc248a51-fe03-4191-b2d6-04b7c738a748","name":"Origami Marketplace","description":"<img src=\"https://content.pstmn.io/eb24d582-46f3-416b-b842-933dbe8be57e/T3JpZ2FtaU1hcmtldHBsYWNlX0xvY2t1cF9BY2NlbnRCbHVlICgxKS5wbmc=\" width=\"447\" height=\"98\">\n\n**Introduction**\n\nOrigami Marketplace API is a RESTful API based on HTTP requests and JSON responses. It exposes the entire infrastructure and processes available with Origami Marketplace\n\nThis version of the API uses OAuth 2.0. This means that all requests will need to be encrypted and sent via HTTPS. It also means that you need to register your application, even if you aren't allowing users to login.\n\nThe easiest way to start using the Origami Marketplace API is by clicking the Run in Postman button above. Postman is a free tool which helps developers run and debug API requests, and is the source of truth for this documentation. Every endpoint you see documented here is readily available by running our Postman collection.\n\n# Allowed HTTPs request methods\n\nOrigami Marketplace API provided HTTP standard request methods :\n\n| Method | Description |\n| --- | --- |\n| GET | Get a resource or a list of resources |\n| POST | Create a resource |\n| PATCH | Update a resource |\n| DELETE | DELETE a resource |\n\n# Response Status\n\nOrigami Marketplace API uses standard HTTP standard response status :\n\n| Status | description |\n| --- | --- |\n| 200 | Ok - Request has been proceed with response body |\n| 201 | Created - Resource has been created |\n| 204 | No Content - Request has been proceed without response body |\n| 400 | Bad Request - Params provided are wrong |\n| 401 | Unauthorized - Authorization is not provided |\n| 403 | Forbidden - Not allowed to access to this resource |\n| 404 | Not Found - Route or resource not found |\n| 405 | Method not allowed - Method provided not allowed for this endpoint |\n| 422 | Unprocessable Entity - Data error during request process |\n| 500 | Server Error - An error occurs on server |\n\n# Generic API params\n\nOn each endpoint you can use request params to filter, include, sort results or handle pagination :\n\n- Pagination : `/resource?page[number]=1&page[size]=10`\n    \n\n- Filter : `/resource?filter[name]=foo`\n    \n\n... where `name` can be:\n\n\\- the name of a model field  \n\\- the name of a custom filter (those are specified on this documentation)  \n\\- the key of a related custom field, in order to filter on a custom field value.  \nExample: `/resource?filter[key_of_custom_field]=value_of_custom_field`\n\nNote that it is possible to filter on several values for the same filter key, using this structure:  \n`/resource?filter[key][]=value1&filter[key][]=value2`  \nIn this example, we will obtain the resource whose `key` has the value: `value1` **or** `value2`.\n\n- Relationship inclusion : `/resource?include=user`\n    \n\n- Sort results : `/resource?order[name]=id&order[way]=desc`\n    \n\n- Get the count of a specific relationship in the API return: `/resource?with_count=relationship`  \n    This parameter is not available neither on all models, nor on all relationships. See the details of the route to know where this parameter is implemented.\n    \n\nFor more information about how this work : [http://jsonapi.org/format/#fetching](http://jsonapi.org/format/#fetching)\n\n# Translation Policy\n\nSome resources in Origami Marketplace can be translatable in multiple languages. All translations are included by default in any translatable resource response.  \nTranslation must added on a resource with the corresponding format :\n\n```\n{\n   \"translations\": [\n       {\n           \"language_id\": 1,\n           \"name\": \"Foo\"\n       },\n       {\n           \"language_id\": 2,\n           \"name\": \"Bar\"\n       }\n   ]\n}\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1769019","collectionId":"cc248a51-fe03-4191-b2d6-04b7c738a748","publishedId":"TVYDfffr","public":true,"publicUrl":"https://api-doc.origami-marketplace.com","privateUrl":"https://go.postman.co/documentation/1769019-cc248a51-fe03-4191-b2d6-04b7c738a748","customColor":{"top-bar":"494CF3","right-sidebar":"000000","highlight":"494CF3"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/1c87234c-aebf-47be-8b80-c58adc20b5b8/b3JpZ2FtaS13aGl0ZS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"494CF3"}},{"name":"light","logo":"https://content.pstmn.io/1c87234c-aebf-47be-8b80-c58adc20b5b8/b3JpZ2FtaS13aGl0ZS5wbmc=","colors":{"top-bar":"494CF3","right-sidebar":"000000","highlight":"494CF3"}}]}},"version":"8.10.0","publishDate":"2026-02-02T14:15:50.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/1c87234c-aebf-47be-8b80-c58adc20b5b8/b3JpZ2FtaS13aGl0ZS5wbmc=","logoDark":"https://content.pstmn.io/1c87234c-aebf-47be-8b80-c58adc20b5b8/b3JpZ2FtaS13aGl0ZS5wbmc="}},"statusCode":200},"environments":[],"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/0f2fa64cb0c83a65c483bc299ed78e1dca82c8e07a9767654b94802f88798220","favicon":"https://origami-marketplace.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"}],"canonicalUrl":"https://api-doc.origami-marketplace.com/view/metadata/TVYDfffr"}