{ "openapi": "3.1.0", "info": { "title": "RE-ZIP API", "version": "2.0" }, "paths": { "/shops": { "post": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "vat_no": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "billing_address": { "type": "object", "properties": { "street": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] } }, "required": [ "street", "postal_code", "city", "region", "country", "latitude", "longitude" ], "additionalProperties": false }, "billing_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shipping_address": { "type": "object", "properties": { "street": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] } }, "required": [ "street", "postal_code", "city", "region", "country", "latitude", "longitude" ], "additionalProperties": false }, "shipping_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "operating_countries": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "partner": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "support_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "support_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "support_phone", "support_email" ], "additionalProperties": false } }, "required": [ "id", "name", "description", "phone", "vat_no", "website", "billing_address", "billing_email", "shipping_address", "shipping_email", "created_at", "updated_at", "operating_countries", "partner" ], "additionalProperties": false } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "phone": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "vat_no": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "website": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "billing_address": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "street": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "postal_code": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "city": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "region": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "country": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" }, { "type": "null" } ] }, { "type": "null" } ] }, "billing_email": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "shipping_address": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "street": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "postal_code": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "city": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "region": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "country": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, { "type": "null" } ] }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" }, { "type": "null" } ] }, { "type": "null" } ] }, "shipping_email": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "operating_countries": { "anyOf": [ { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, { "type": "null" } ] } }, "required": [ "name" ], "additionalProperties": false } } } }, "summary": "Create shop" } }, "/shops/{id}": { "delete": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "" }, "404": { "description": "" } }, "summary": "Delete shop" }, "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "vat_no": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "billing_address": { "type": "object", "properties": { "street": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] } }, "required": [ "street", "postal_code", "city", "region", "country", "latitude", "longitude" ], "additionalProperties": false }, "billing_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shipping_address": { "type": "object", "properties": { "street": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] } }, "required": [ "street", "postal_code", "city", "region", "country", "latitude", "longitude" ], "additionalProperties": false }, "shipping_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "operating_countries": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "partner": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "support_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "support_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "support_phone", "support_email" ], "additionalProperties": false } }, "required": [ "id", "name", "description", "phone", "vat_no", "website", "billing_address", "billing_email", "shipping_address", "shipping_email", "created_at", "updated_at", "operating_countries", "partner" ], "additionalProperties": false } } } }, "404": { "description": "" } }, "summary": "Get shop" }, "patch": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "vat_no": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "billing_address": { "type": "object", "properties": { "street": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] } }, "required": [ "street", "postal_code", "city", "region", "country", "latitude", "longitude" ], "additionalProperties": false }, "billing_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shipping_address": { "type": "object", "properties": { "street": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] } }, "required": [ "street", "postal_code", "city", "region", "country", "latitude", "longitude" ], "additionalProperties": false }, "shipping_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "operating_countries": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "partner": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "support_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "support_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "support_phone", "support_email" ], "additionalProperties": false } }, "required": [ "id", "name", "description", "phone", "vat_no", "website", "billing_address", "billing_email", "shipping_address", "shipping_email", "created_at", "updated_at", "operating_countries", "partner" ], "additionalProperties": false } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "phone": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "vat_no": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "website": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "billing_address": { "anyOf": [ { "anyOf": [ {}, { "type": "null" } ] }, { "type": "null" } ] }, "billing_email": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "shipping_address": { "anyOf": [ { "anyOf": [ {}, { "type": "null" } ] }, { "type": "null" } ] }, "shipping_email": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "operating_countries": { "anyOf": [ { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "summary": "Update shop" } }, "/shops/{id}/agreements": { "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "accepted": { "type": "boolean" }, "owner": { "type": "boolean" }, "mfa_required": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "user": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "email", "name" ], "additionalProperties": false }, "acl_permissions": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string" }, "get": { "type": "boolean" }, "put": { "type": "boolean" }, "post": { "type": "boolean" }, "patch": { "type": "boolean" }, "delete": { "type": "boolean" }, "query": { "type": "boolean" } }, "required": [ "resource", "get", "put", "post", "patch", "delete", "query" ], "additionalProperties": false } }, "acl_permission_groups": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "managed", "custom" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "acl_permissions": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string" }, "get": { "type": "boolean" }, "put": { "type": "boolean" }, "post": { "type": "boolean" }, "patch": { "type": "boolean" }, "delete": { "type": "boolean" }, "query": { "type": "boolean" } }, "required": [ "resource", "get", "put", "post", "patch", "delete", "query" ], "additionalProperties": false } } }, "required": [ "id", "account_id", "name", "type", "created_at", "updated_at", "acl_permissions" ], "additionalProperties": false } }, { "type": "null" } ] }, "acl_permission_group_ids": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "id", "accepted", "owner", "mfa_required", "created_at", "updated_at", "expires_at", "user", "acl_permissions" ], "additionalProperties": false } } } } } }, "summary": "List shop agreements" }, "post": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "accepted": { "type": "boolean" }, "owner": { "type": "boolean" }, "mfa_required": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "user": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "email", "name" ], "additionalProperties": false }, "acl_permissions": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string" }, "get": { "type": "boolean" }, "put": { "type": "boolean" }, "post": { "type": "boolean" }, "patch": { "type": "boolean" }, "delete": { "type": "boolean" }, "query": { "type": "boolean" } }, "required": [ "resource", "get", "put", "post", "patch", "delete", "query" ], "additionalProperties": false } }, "acl_permission_groups": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "managed", "custom" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "acl_permissions": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string" }, "get": { "type": "boolean" }, "put": { "type": "boolean" }, "post": { "type": "boolean" }, "patch": { "type": "boolean" }, "delete": { "type": "boolean" }, "query": { "type": "boolean" } }, "required": [ "resource", "get", "put", "post", "patch", "delete", "query" ], "additionalProperties": false } } }, "required": [ "id", "account_id", "name", "type", "created_at", "updated_at", "acl_permissions" ], "additionalProperties": false } }, { "type": "null" } ] }, "acl_permission_group_ids": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "id", "accepted", "owner", "mfa_required", "created_at", "updated_at", "expires_at", "user", "acl_permissions" ], "additionalProperties": false } } } }, "400": { "description": "" }, "404": { "description": "" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "owner": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "email" ], "additionalProperties": false } } } }, "summary": "Create shop agreement" } }, "/shops/{id}/agreements/{agreement_id}": { "delete": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "agreement_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "" }, "400": { "description": "" }, "404": { "description": "" } }, "summary": "Delete shop agreement" }, "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "agreement_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "accepted": { "type": "boolean" }, "owner": { "type": "boolean" }, "mfa_required": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "user": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "email", "name" ], "additionalProperties": false }, "acl_permissions": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string" }, "get": { "type": "boolean" }, "put": { "type": "boolean" }, "post": { "type": "boolean" }, "patch": { "type": "boolean" }, "delete": { "type": "boolean" }, "query": { "type": "boolean" } }, "required": [ "resource", "get", "put", "post", "patch", "delete", "query" ], "additionalProperties": false } }, "acl_permission_groups": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "managed", "custom" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "acl_permissions": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string" }, "get": { "type": "boolean" }, "put": { "type": "boolean" }, "post": { "type": "boolean" }, "patch": { "type": "boolean" }, "delete": { "type": "boolean" }, "query": { "type": "boolean" } }, "required": [ "resource", "get", "put", "post", "patch", "delete", "query" ], "additionalProperties": false } } }, "required": [ "id", "account_id", "name", "type", "created_at", "updated_at", "acl_permissions" ], "additionalProperties": false } }, { "type": "null" } ] }, "acl_permission_group_ids": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "id", "accepted", "owner", "mfa_required", "created_at", "updated_at", "expires_at", "user", "acl_permissions" ], "additionalProperties": false } } } }, "404": { "description": "" } }, "summary": "Get shop agreement" }, "patch": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "agreement_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "accepted": { "type": "boolean" }, "owner": { "type": "boolean" }, "mfa_required": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "user": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "email", "name" ], "additionalProperties": false }, "acl_permissions": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string" }, "get": { "type": "boolean" }, "put": { "type": "boolean" }, "post": { "type": "boolean" }, "patch": { "type": "boolean" }, "delete": { "type": "boolean" }, "query": { "type": "boolean" } }, "required": [ "resource", "get", "put", "post", "patch", "delete", "query" ], "additionalProperties": false } }, "acl_permission_groups": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "managed", "custom" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "acl_permissions": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string" }, "get": { "type": "boolean" }, "put": { "type": "boolean" }, "post": { "type": "boolean" }, "patch": { "type": "boolean" }, "delete": { "type": "boolean" }, "query": { "type": "boolean" } }, "required": [ "resource", "get", "put", "post", "patch", "delete", "query" ], "additionalProperties": false } } }, "required": [ "id", "account_id", "name", "type", "created_at", "updated_at", "acl_permissions" ], "additionalProperties": false } }, { "type": "null" } ] }, "acl_permission_group_ids": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "id", "accepted", "owner", "mfa_required", "created_at", "updated_at", "expires_at", "user", "acl_permissions" ], "additionalProperties": false } } } }, "400": { "description": "" }, "404": { "description": "" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "owner": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "mfa_required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "summary": "Patch shop agreement" } }, "/shops/{id}/agreements/{agreement_id}/permissions": { "put": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "agreement_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "" }, "404": { "description": "" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string" }, "get": { "type": "boolean" }, "put": { "type": "boolean" }, "post": { "type": "boolean" }, "patch": { "type": "boolean" }, "delete": { "type": "boolean" }, "query": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "resource", "get", "put", "post", "patch", "delete" ], "additionalProperties": false } } } } }, "summary": "Replace permissions for shop agreement" } }, "/shops/{id}/agreements/{agreement_id}/personal_access_tokens": { "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "agreement_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "user_agreement_id": { "type": "string" }, "last_used": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" }, "refreshed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "acl_permissions": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string" }, "get": { "type": "boolean" }, "put": { "type": "boolean" }, "post": { "type": "boolean" }, "patch": { "type": "boolean" }, "delete": { "type": "boolean" }, "query": { "type": "boolean" } }, "required": [ "resource", "get", "put", "post", "patch", "delete", "query" ], "additionalProperties": false } } }, "required": [ "id", "name", "user_agreement_id", "last_used", "created_at", "refreshed_at", "expires_at", "acl_permissions" ], "additionalProperties": false } } } } }, "404": { "description": "" } }, "summary": "List personal access tokens for agreement" }, "post": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "agreement_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "user_agreement_id": { "type": "string" }, "last_used": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" }, "refreshed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "acl_permissions": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string" }, "get": { "type": "boolean" }, "put": { "type": "boolean" }, "post": { "type": "boolean" }, "patch": { "type": "boolean" }, "delete": { "type": "boolean" }, "query": { "type": "boolean" } }, "required": [ "resource", "get", "put", "post", "patch", "delete", "query" ], "additionalProperties": false } }, "token": { "type": "string" } }, "required": [ "id", "name", "user_agreement_id", "last_used", "created_at", "refreshed_at", "expires_at", "acl_permissions", "token" ], "additionalProperties": false } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "expires_at": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "acl_permissions": { "anyOf": [ { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string" }, "get": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "put": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "post": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "patch": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "delete": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "resource" ], "additionalProperties": false } }, { "type": "null" } ] }, { "type": "null" } ] } }, "required": [ "name" ], "additionalProperties": false } } } }, "summary": "Create personal access token for agreement" } }, "/shops/{id}/agreements/{agreement_id}/personal_access_tokens/{pat_id}": { "delete": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "agreement_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "pat_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "" } }, "summary": "Delete personal access token" } }, "/shops/{id}/agreements/{agreement_id}/personal_access_tokens/{pat_id}/refresh": { "post": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "agreement_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "pat_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "user_agreement_id": { "type": "string" }, "last_used": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" }, "refreshed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "acl_permissions": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string" }, "get": { "type": "boolean" }, "put": { "type": "boolean" }, "post": { "type": "boolean" }, "patch": { "type": "boolean" }, "delete": { "type": "boolean" }, "query": { "type": "boolean" } }, "required": [ "resource", "get", "put", "post", "patch", "delete", "query" ], "additionalProperties": false } }, "token": { "type": "string" } }, "required": [ "id", "name", "user_agreement_id", "last_used", "created_at", "refreshed_at", "expires_at", "acl_permissions", "token" ], "additionalProperties": false } } } }, "404": { "description": "" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expires_at": { "type": "string" } }, "required": [ "expires_at" ], "additionalProperties": false } } } }, "summary": "Refresh a personal access token" } }, "/shops/{id}/files": { "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "file_name": { "type": "string" }, "description": { "type": "string" }, "asset_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reference_id": { "type": "string" }, "mime": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "updated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "id", "account_id", "file_name", "description", "reference_id", "mime", "created_at", "updated_at", "updated" ], "additionalProperties": false } } } } } }, "summary": "List files for a shop account" }, "post": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "" } }, "summary": "Upload file (deprecated multipart)", "deprecated": true } }, "/shops/{id}/files/{file_id}": { "delete": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "file_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "" } }, "summary": "Delete shop file" }, "get": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "file_id", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "" } }, "summary": "Redirect to file by id" }, "put": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "file_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "404": { "description": "" } }, "summary": "Update shop file (deprecated multipart)", "deprecated": true } }, "/shops/{id}/files/{file_id}/info": { "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "file_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "file_name": { "type": "string" }, "description": { "type": "string" }, "asset_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reference_id": { "type": "string" }, "mime": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "updated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "id", "account_id", "file_name", "description", "reference_id", "mime", "created_at", "updated_at", "updated" ], "additionalProperties": false } } } }, "404": { "description": "" } }, "summary": "Get file info" } }, "/shops/{id}/files/type/{type}": { "get": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "type", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "" }, "404": { "description": "" } }, "summary": "Redirect to file by type" } }, "/shops/{id}/files/type/{type}/{reference_id}": { "get": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "type", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "reference_id", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "" } }, "summary": "Redirect to file by type" } }, "/shops/{id}/files/upload": { "post": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "summary": "Presign upload URL" } }, "/shops/{id}/files/upload/finish": { "post": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "file_name": { "type": "string" }, "description": { "type": "string" }, "asset_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reference_id": { "type": "string" }, "mime": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "updated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "id", "account_id", "file_name", "description", "reference_id", "mime", "created_at", "updated_at", "updated" ], "additionalProperties": false } } } } }, "summary": "Finish file upload" } }, "/shops/{id}/logo": { "get": { "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "" } }, "summary": "Redirect to shop logo", "deprecated": true }, "put": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "" } }, "summary": "Upload shop logo", "deprecated": true } }, "/shops/{id}/orders": { "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "number": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "state": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "aggregate_price_at_creation": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "sku": { "type": "string" }, "name": { "type": "string" }, "dimensions": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "quantity": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "fulfilled": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "sku", "name", "dimensions", "price", "quantity", "fulfilled", "created_at", "updated_at" ], "additionalProperties": false } } }, "required": [ "id", "number", "state", "created_at", "updated_at", "aggregate_price_at_creation", "type", "lines" ], "additionalProperties": false } } } } } }, "summary": "List shop orders" }, "post": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "number": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "state": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "aggregate_price_at_creation": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "sku": { "type": "string" }, "name": { "type": "string" }, "dimensions": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "quantity": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "fulfilled": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "sku", "name", "dimensions", "price", "quantity", "fulfilled", "created_at", "updated_at" ], "additionalProperties": false } } }, "required": [ "id", "number", "state", "created_at", "updated_at", "aggregate_price_at_creation", "type", "lines" ], "additionalProperties": false } } } }, "400": { "description": "" }, "404": { "description": "" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currency": { "type": "string" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "quantity": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] } }, "required": [ "sku", "quantity" ], "additionalProperties": false } } }, "required": [ "currency", "lines" ], "additionalProperties": false } } } }, "summary": "Create shop order" } }, "/shops/{id}/orders/{order_id}": { "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "order_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "number": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "state": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "aggregate_price_at_creation": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "sku": { "type": "string" }, "name": { "type": "string" }, "dimensions": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "quantity": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "fulfilled": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "sku", "name", "dimensions", "price", "quantity", "fulfilled", "created_at", "updated_at" ], "additionalProperties": false } } }, "required": [ "id", "number", "state", "created_at", "updated_at", "aggregate_price_at_creation", "type", "lines" ], "additionalProperties": false } } } }, "404": { "description": "" } }, "summary": "Get shop order" } }, "/shops/{id}/orders/quantity": { "post": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "time_increment": { "type": "string" }, "quantity": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] } }, "required": [ "time_increment", "quantity" ], "additionalProperties": false } } } } }, "400": { "description": "" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "precision": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "precision", "from", "to" ], "additionalProperties": false } } } }, "summary": "Get time-bucketed order line quantity sums for a shop" } }, "/shops/{id}/permission_groups": { "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "managed", "custom" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "user_agreement_ids": { "type": "array", "items": { "type": "string" } }, "acl_permissions": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string" }, "get": { "type": "boolean" }, "put": { "type": "boolean" }, "post": { "type": "boolean" }, "patch": { "type": "boolean" }, "delete": { "type": "boolean" }, "query": { "type": "boolean" } }, "required": [ "resource", "get", "put", "post", "patch", "delete", "query" ], "additionalProperties": false } } }, "required": [ "id", "account_id", "name", "type", "created_at", "updated_at", "user_agreement_ids", "acl_permissions" ], "additionalProperties": false } } } } } }, "summary": "List permission groups for a shop" }, "post": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "managed", "custom" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "acl_permissions": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string" }, "get": { "type": "boolean" }, "put": { "type": "boolean" }, "post": { "type": "boolean" }, "patch": { "type": "boolean" }, "delete": { "type": "boolean" }, "query": { "type": "boolean" } }, "required": [ "resource", "get", "put", "post", "patch", "delete", "query" ], "additionalProperties": false } } }, "required": [ "id", "account_id", "name", "type", "created_at", "updated_at", "acl_permissions" ], "additionalProperties": false } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "anyOf": [ { "type": "string", "enum": [ "managed", "custom" ] }, { "type": "null" } ] } }, "required": [ "name" ], "additionalProperties": false } } } }, "summary": "Create permission group" } }, "/shops/{id}/permission_groups/{permission_group_id}": { "delete": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "permission_group_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "" }, "404": { "description": "" } }, "summary": "Delete permission group" }, "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "permission_group_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "managed", "custom" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "user_agreement_ids": { "type": "array", "items": { "type": "string" } }, "acl_permissions": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string" }, "get": { "type": "boolean" }, "put": { "type": "boolean" }, "post": { "type": "boolean" }, "patch": { "type": "boolean" }, "delete": { "type": "boolean" }, "query": { "type": "boolean" } }, "required": [ "resource", "get", "put", "post", "patch", "delete", "query" ], "additionalProperties": false } }, "user_agreements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "accepted": { "type": "boolean" }, "owner": { "type": "boolean" }, "mfa_required": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "user": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "email", "name" ], "additionalProperties": false }, "acl_permissions": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string" }, "get": { "type": "boolean" }, "put": { "type": "boolean" }, "post": { "type": "boolean" }, "patch": { "type": "boolean" }, "delete": { "type": "boolean" }, "query": { "type": "boolean" } }, "required": [ "resource", "get", "put", "post", "patch", "delete", "query" ], "additionalProperties": false } } }, "required": [ "id", "accepted", "owner", "mfa_required", "created_at", "updated_at", "expires_at", "user", "acl_permissions" ], "additionalProperties": false } } }, "required": [ "id", "account_id", "name", "type", "created_at", "updated_at", "user_agreement_ids", "acl_permissions", "user_agreements" ], "additionalProperties": false } } } }, "404": { "description": "" } }, "summary": "Get permission group detail" } }, "/shops/{id}/permission_groups/{permission_group_id}/name": { "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "permission_group_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "managed", "custom" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "user_agreement_ids": { "type": "array", "items": { "type": "string" } }, "acl_permissions": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string" }, "get": { "type": "boolean" }, "put": { "type": "boolean" }, "post": { "type": "boolean" }, "patch": { "type": "boolean" }, "delete": { "type": "boolean" }, "query": { "type": "boolean" } }, "required": [ "resource", "get", "put", "post", "patch", "delete", "query" ], "additionalProperties": false } } }, "required": [ "id", "account_id", "name", "type", "created_at", "updated_at", "user_agreement_ids", "acl_permissions" ], "additionalProperties": false } } } } } }, "summary": "Fuzzy name search for permission groups" } }, "/shops/{id}/permission_groups/{permission_group_id}/permissions": { "put": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "permission_group_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "resource": { "type": "string" }, "get": { "type": "boolean" }, "put": { "type": "boolean" }, "post": { "type": "boolean" }, "patch": { "type": "boolean" }, "delete": { "type": "boolean" }, "query": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "resource", "get", "put", "post", "patch", "delete" ], "additionalProperties": false } } } } }, "summary": "Replace permission group permissions" } }, "/shops/{id}/permission_groups/{permission_group_id}/user_agreement/{user_agreement_id}": { "delete": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "permission_group_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "user_agreement_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object" }, { "type": "array" } ] } } } }, "401": { "description": "" }, "404": { "description": "" } }, "summary": "Detach user agreement from permission group" }, "post": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "permission_group_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "user_agreement_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "401": { "description": "" } }, "summary": "Attach user agreement to permission group" } }, "/shops/{id}/products": { "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Basic || Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "sku": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "deleted_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dimension": {}, "weight": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "volume": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "surface_area": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "primary_material": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bundle_size": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "group": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "description" ], "additionalProperties": false } }, "required": [ "id", "sku", "name", "price", "active", "created_at", "updated_at", "deleted_at", "currency", "dimension", "weight", "volume", "surface_area", "primary_material", "bundle_size", "group" ], "additionalProperties": false } } } } }, "404": { "description": "" } }, "summary": "List products for a shop" } }, "/shops/{id}/reporting/activity_map": { "post": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "position": { "type": "object", "properties": { "x": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "y": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] } }, "required": [ "x", "y" ], "additionalProperties": false }, "amount": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] } }, "required": [ "position", "amount" ], "additionalProperties": false } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "precision": { "type": "integer", "allOf": [ { "maximum": 100 } ] }, "location_bounds": { "type": "object", "properties": { "left": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "right": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "up": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "down": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] } }, "required": [ "left", "right", "up", "down" ], "additionalProperties": false }, "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "precision", "location_bounds", "from", "to" ], "additionalProperties": false } } } }, "summary": "Get shop activity map" } }, "/shops/{id}/reporting/statistics": { "post": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "each": { "type": "array", "items": { "type": "object", "properties": { "time_increment": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "transport_co2e": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "transport_water": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "production_co2e": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "production_water": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "assembly_co2e": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "assembly_water": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "destruction_co2e": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "destruction_water": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "sorting_co2e": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "sorting_water": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "waste_kg": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "per_sku": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] } } } }, "required": [ "time_increment", "transport_co2e", "transport_water", "production_co2e", "production_water", "assembly_co2e", "assembly_water", "destruction_co2e", "destruction_water", "sorting_co2e", "sorting_water", "waste_kg", "per_sku" ], "additionalProperties": false } }, "sum": { "type": "object", "properties": { "time_increment": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "transport_co2e": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "transport_water": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "production_co2e": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "production_water": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "assembly_co2e": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "assembly_water": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "destruction_co2e": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "destruction_water": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "sorting_co2e": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "sorting_water": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "waste_kg": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "per_sku": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] } } } }, "required": [ "time_increment", "transport_co2e", "transport_water", "production_co2e", "production_water", "assembly_co2e", "assembly_water", "destruction_co2e", "destruction_water", "sorting_co2e", "sorting_water", "waste_kg", "per_sku" ], "additionalProperties": false } }, "required": [ "each", "sum" ], "additionalProperties": false } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "precision": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "precision", "from", "to" ], "additionalProperties": false } } } }, "summary": "Get shop reporting statistics" } }, "/shops/{id}/scans/summary": { "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "scans": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] } }, "required": [ "type", "scans" ], "additionalProperties": false } } }, "required": [ "sku", "items" ], "additionalProperties": false } } } } } }, "summary": "Scan type summary grouped by SKU" } }, "/shops/{id}/settings": { "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "ordering": { "anyOf": [ {}, { "type": "null" } ] }, "return_policy_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "default_voucher": { "anyOf": [ {}, { "type": "null" } ] } }, "required": [ "ordering", "return_policy_url" ], "additionalProperties": false } } } }, "404": { "description": "" } }, "summary": "Get shop settings" }, "put": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "ordering": { "anyOf": [ {}, { "type": "null" } ] }, "return_policy_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "default_voucher": { "anyOf": [ {}, { "type": "null" } ] } }, "required": [ "ordering", "return_policy_url" ], "additionalProperties": false } } } }, "404": { "description": "" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "return_policy_url": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "summary": "Update shop settings" } }, "/shops/{id}/settings/default_voucher": { "delete": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "" }, "404": { "description": "" } }, "summary": "Delete shop default voucher" }, "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "conditions": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "404": { "description": "" } }, "summary": "Get shop default voucher" }, "put": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "conditions": { "type": "string" }, "code": { "type": "string" }, "type": { "type": "string" }, "value": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "unit": { "type": "string" } }, "required": [ "conditions", "code", "type", "value", "unit" ], "additionalProperties": false } } } }, "404": { "description": "" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "conditions": { "type": "string" }, "code": { "type": "string" }, "type": { "type": "string", "enum": [ "amount", "gift", "percentage" ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "unit": { "type": "string" } }, "required": [ "conditions", "code", "type", "value", "unit" ], "additionalProperties": false } } } }, "summary": "Set shop default voucher" } }, "/shops/{id}/settings/ordering": { "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "currency": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "shipping_base_cost": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, { "type": "null" } ] }, "shipping_unit_cost": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, { "type": "null" } ] }, "vat": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "404": { "description": "" } }, "summary": "Get shop ordering settings" } }, "/shops/{id}/vouchers": { "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "batch_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "plucked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "batch_id", "code", "link", "created_at", "updated_at", "plucked_at" ], "additionalProperties": false } } } } } }, "summary": "List vouchers for a shop" }, "post": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "batch_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "plucked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "batch_id", "code", "link", "created_at", "updated_at", "plucked_at" ], "additionalProperties": false } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "batch_id": { "type": "string" }, "code": { "type": "string" }, "link": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] } }, "required": [ "batch_id", "code" ], "additionalProperties": false } } } }, "summary": "Create voucher" } }, "/shops/{id}/vouchers/{voucher_id}": { "delete": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "voucher_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "" }, "406": { "description": "" } }, "summary": "Delete voucher" }, "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "voucher_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "batch_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "plucked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "batch_id", "code", "link", "created_at", "updated_at", "plucked_at" ], "additionalProperties": false } } } }, "404": { "description": "" } }, "summary": "Get voucher" } }, "/shops/{id}/vouchers/batches": { "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "voucher_pool_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "conditions": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deleted_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "voucher_pool_id", "type", "value", "unit", "conditions", "created_at", "updated_at", "expires_at", "deleted_at" ], "additionalProperties": false } } } } } }, "summary": "List voucher batches" }, "post": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "voucher_pool_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "conditions": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deleted_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "voucher_pool_id", "type", "value", "unit", "conditions", "created_at", "updated_at", "expires_at", "deleted_at" ], "additionalProperties": false } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "conditions": { "type": "string" }, "type": { "type": "string", "enum": [ "amount", "gift", "percentage" ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "unit": { "type": "string" }, "expires_at": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "voucher_pool_id": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] } }, "required": [ "conditions", "type", "value", "unit" ], "additionalProperties": false } } } }, "summary": "Create voucher batch" } }, "/shops/{id}/vouchers/batches/{batch_id}": { "delete": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "batch_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "" }, "404": { "description": "" } }, "summary": "Delete voucher batch" }, "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "batch_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "voucher_pool_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "conditions": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deleted_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "voucher_pool_id", "type", "value", "unit", "conditions", "created_at", "updated_at", "expires_at", "deleted_at" ], "additionalProperties": false } } } }, "404": { "description": "" } }, "summary": "Get voucher batch" }, "patch": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "batch_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "voucher_pool_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "conditions": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deleted_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "voucher_pool_id", "type", "value", "unit", "conditions", "created_at", "updated_at", "expires_at", "deleted_at" ], "additionalProperties": false } } } }, "404": { "description": "" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "conditions": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "type": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "amount", "gift", "percentage" ] }, { "type": "null" } ] }, { "type": "null" } ] }, "value": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "null" } ] }, { "type": "null" } ] }, "unit": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "expires_at": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "voucher_pool_id": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "summary": "Update voucher batch" } }, "/shops/{id}/vouchers/batches/{batch_id}/codes": { "post": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "batch_id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "" } }, "summary": "Bulk add voucher codes" } }, "/shops/{id}/vouchers/batches/{batch_id}/pluck-voucher": { "post": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "batch_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "" }, "404": { "description": "" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "email" ], "additionalProperties": false } } } }, "summary": "Pluck a voucher from a batch" } }, "/shops/{id}/vouchers/batches/{batch_id}/usage": { "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "batch_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "used": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] } }, "required": [ "total", "used" ], "additionalProperties": false } } } }, "404": { "description": "" } }, "summary": "Get voucher batch usage" } }, "/shops/{id}/vouchers/pools": { "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "countries": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "visibility": { "type": "string" }, "pool_type": { "type": "string" }, "webhook_url": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "name", "countries", "visibility", "pool_type", "created_at", "updated_at" ], "additionalProperties": false } } } } } }, "summary": "List voucher pools" }, "post": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "countries": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "visibility": { "type": "string" }, "pool_type": { "type": "string" }, "webhook_url": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "name", "countries", "visibility", "pool_type", "created_at", "updated_at" ], "additionalProperties": false } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "countries": { "anyOf": [ { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, { "type": "null" } ] }, "visibility": { "type": "string", "enum": [ "private", "private_public", "public" ] }, "pool_type": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "static", "on_demand" ] }, { "type": "null" } ] }, { "type": "null" } ] }, "webhook_url": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] } }, "required": [ "name", "visibility" ], "additionalProperties": false } } } }, "summary": "Create voucher pool" } }, "/shops/{id}/vouchers/pools/{pool_id}": { "delete": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "pool_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "" }, "404": { "description": "" } }, "summary": "Delete voucher pool" }, "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "pool_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "countries": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "visibility": { "type": "string" }, "pool_type": { "type": "string" }, "webhook_url": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "name", "countries", "visibility", "pool_type", "created_at", "updated_at" ], "additionalProperties": false } } } }, "404": { "description": "" } }, "summary": "Get voucher pool" } }, "/shops/{id}/webhooks": { "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "event": { "type": "string" }, "url": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "account_id", "event", "url", "created_at", "updated_at" ], "additionalProperties": false } } } } } }, "summary": "List webhooks for a shop" }, "post": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "event": { "type": "string" }, "url": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "account_id", "event", "url", "created_at", "updated_at" ], "additionalProperties": false } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "enum": [ "order.created", "order.updated" ] }, "url": { "type": "string" } }, "required": [ "event", "url" ], "additionalProperties": false } } } }, "summary": "Create webhook" } }, "/shops/{id}/webhooks/{webhook_id}": { "delete": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "webhook_id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "" }, "404": { "description": "" } }, "summary": "Delete webhook" }, "get": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "webhook_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "event": { "type": "string" }, "url": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "account_id", "event", "url", "created_at", "updated_at" ], "additionalProperties": false } } } }, "404": { "description": "" } }, "summary": "Get webhook" }, "patch": { "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "example": "Bearer " } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "webhook_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "event": { "type": "string" }, "url": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "account_id", "event", "url", "created_at", "updated_at" ], "additionalProperties": false } } } }, "404": { "description": "" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "order.created", "order.updated" ] }, { "type": "null" } ] }, { "type": "null" } ] }, "url": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "summary": "Update webhook" } } } }