{ "openapi": "3.1.0", "info": { "title": "Commerce Layer API", "version": "7.10.1", "contact": { "name": "API Support", "url": "https://commercelayer.io", "email": "support@commercelayer.io" }, "description": "Headless Commerce for Global Brands." }, "servers": [ { "url": "https://{your_organization_slug}.commercelayer.io/api", "description": "API" }, { "url": "https://core.commercelayer.io/users/sign_in", "description": "Sign in" }, { "url": "https://docs.commercelayer.io/api", "description": "API reference" } ], "paths": { "/addresses": { "get": { "operationId": "GET/addresses", "summary": "List all addresses", "description": "List all addresses", "tags": [ "addresses" ], "responses": { "200": { "description": "A list of address objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/addressResponseList" } } } } } }, "post": { "operationId": "POST/addresses", "summary": "Create an address", "description": "Create an address", "tags": [ "addresses" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/addressCreate" } } } }, "responses": { "201": { "description": "The created address object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/addressResponse" } } } } } } }, "/addresses/{addressId}": { "get": { "operationId": "GET/addresses/addressId", "summary": "Retrieve an address", "description": "Retrieve an address", "tags": [ "addresses" ], "parameters": [ { "name": "addressId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The address object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/addressResponse" } } } } } }, "patch": { "operationId": "PATCH/addresses/addressId", "summary": "Update an address", "description": "Update an address", "tags": [ "addresses" ], "parameters": [ { "name": "addressId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/addressUpdate" } } } }, "responses": { "200": { "description": "The updated address object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/addressResponse" } } } } } }, "delete": { "operationId": "DELETE/addresses/addressId", "summary": "Delete an address", "description": "Delete an address", "tags": [ "addresses" ], "parameters": [ { "name": "addressId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/addresses/{addressId}/geocoder": { "get": { "operationId": "GET/addressId/geocoder", "summary": "Retrieve the geocoder associated to the address", "description": "Retrieve the geocoder associated to the address", "tags": [ "has_one", "geocoders" ], "parameters": [ { "name": "addressId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The geocoder associated to the address" } } } }, "/addresses/{addressId}/events": { "get": { "operationId": "GET/addressId/events", "summary": "Retrieve the events associated to the address", "description": "Retrieve the events associated to the address", "tags": [ "has_many", "events" ], "parameters": [ { "name": "addressId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the address" } } } }, "/addresses/{addressId}/tags": { "get": { "operationId": "GET/addressId/tags", "summary": "Retrieve the tags associated to the address", "description": "Retrieve the tags associated to the address", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "addressId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the address" } } } }, "/addresses/{addressId}/event_stores": { "get": { "operationId": "GET/addressId/event_stores", "summary": "Retrieve the event stores associated to the address", "description": "Retrieve the event stores associated to the address", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "addressId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the address" } } } }, "/adjustments": { "get": { "operationId": "GET/adjustments", "summary": "List all adjustments", "description": "List all adjustments", "tags": [ "adjustments" ], "responses": { "200": { "description": "A list of adjustment objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/adjustmentResponseList" } } } } } }, "post": { "operationId": "POST/adjustments", "summary": "Create an adjustment", "description": "Create an adjustment", "tags": [ "adjustments" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/adjustmentCreate" } } } }, "responses": { "201": { "description": "The created adjustment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/adjustmentResponse" } } } } } } }, "/adjustments/{adjustmentId}": { "get": { "operationId": "GET/adjustments/adjustmentId", "summary": "Retrieve an adjustment", "description": "Retrieve an adjustment", "tags": [ "adjustments" ], "parameters": [ { "name": "adjustmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The adjustment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/adjustmentResponse" } } } } } }, "patch": { "operationId": "PATCH/adjustments/adjustmentId", "summary": "Update an adjustment", "description": "Update an adjustment", "tags": [ "adjustments" ], "parameters": [ { "name": "adjustmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/adjustmentUpdate" } } } }, "responses": { "200": { "description": "The updated adjustment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/adjustmentResponse" } } } } } }, "delete": { "operationId": "DELETE/adjustments/adjustmentId", "summary": "Delete an adjustment", "description": "Delete an adjustment", "tags": [ "adjustments" ], "parameters": [ { "name": "adjustmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/adjustments/{adjustmentId}/event_stores": { "get": { "operationId": "GET/adjustmentId/event_stores", "summary": "Retrieve the event stores associated to the adjustment", "description": "Retrieve the event stores associated to the adjustment", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "adjustmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the adjustment" } } } }, "/adyen_gateways": { "get": { "operationId": "GET/adyen_gateways", "summary": "List all adyen gateways", "description": "List all adyen gateways", "tags": [ "adyen_gateways" ], "responses": { "200": { "description": "A list of adyen gateway objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/adyenGatewayResponseList" } } } } } }, "post": { "operationId": "POST/adyen_gateways", "summary": "Create an adyen gateway", "description": "Create an adyen gateway", "tags": [ "adyen_gateways" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/adyenGatewayCreate" } } } }, "responses": { "201": { "description": "The created adyen gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/adyenGatewayResponse" } } } } } } }, "/adyen_gateways/{adyenGatewayId}": { "get": { "operationId": "GET/adyen_gateways/adyenGatewayId", "summary": "Retrieve an adyen gateway", "description": "Retrieve an adyen gateway", "tags": [ "adyen_gateways" ], "parameters": [ { "name": "adyenGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The adyen gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/adyenGatewayResponse" } } } } } }, "patch": { "operationId": "PATCH/adyen_gateways/adyenGatewayId", "summary": "Update an adyen gateway", "description": "Update an adyen gateway", "tags": [ "adyen_gateways" ], "parameters": [ { "name": "adyenGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/adyenGatewayUpdate" } } } }, "responses": { "200": { "description": "The updated adyen gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/adyenGatewayResponse" } } } } } }, "delete": { "operationId": "DELETE/adyen_gateways/adyenGatewayId", "summary": "Delete an adyen gateway", "description": "Delete an adyen gateway", "tags": [ "adyen_gateways" ], "parameters": [ { "name": "adyenGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/adyen_gateways/{adyenGatewayId}/payment_methods": { "get": { "operationId": "GET/adyenGatewayId/payment_methods", "summary": "Retrieve the payment methods associated to the adyen gateway", "description": "Retrieve the payment methods associated to the adyen gateway", "tags": [ "has_many", "payment_methods" ], "parameters": [ { "name": "adyenGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_methods associated to the adyen gateway" } } } }, "/adyen_gateways/{adyenGatewayId}/event_stores": { "get": { "operationId": "GET/adyenGatewayId/event_stores", "summary": "Retrieve the event stores associated to the adyen gateway", "description": "Retrieve the event stores associated to the adyen gateway", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "adyenGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the adyen gateway" } } } }, "/adyen_gateways/{adyenGatewayId}/adyen_payments": { "get": { "operationId": "GET/adyenGatewayId/adyen_payments", "summary": "Retrieve the adyen payments associated to the adyen gateway", "description": "Retrieve the adyen payments associated to the adyen gateway", "tags": [ "has_many", "adyen_payments" ], "parameters": [ { "name": "adyenGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The adyen_payments associated to the adyen gateway" } } } }, "/adyen_payments": { "get": { "operationId": "GET/adyen_payments", "summary": "List all adyen payments", "description": "List all adyen payments", "tags": [ "adyen_payments" ], "responses": { "200": { "description": "A list of adyen payment objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/adyenPaymentResponseList" } } } } } }, "post": { "operationId": "POST/adyen_payments", "summary": "Create an adyen payment", "description": "Create an adyen payment", "tags": [ "adyen_payments" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/adyenPaymentCreate" } } } }, "responses": { "201": { "description": "The created adyen payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/adyenPaymentResponse" } } } } } } }, "/adyen_payments/{adyenPaymentId}": { "get": { "operationId": "GET/adyen_payments/adyenPaymentId", "summary": "Retrieve an adyen payment", "description": "Retrieve an adyen payment", "tags": [ "adyen_payments" ], "parameters": [ { "name": "adyenPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The adyen payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/adyenPaymentResponse" } } } } } }, "patch": { "operationId": "PATCH/adyen_payments/adyenPaymentId", "summary": "Update an adyen payment", "description": "Update an adyen payment", "tags": [ "adyen_payments" ], "parameters": [ { "name": "adyenPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/adyenPaymentUpdate" } } } }, "responses": { "200": { "description": "The updated adyen payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/adyenPaymentResponse" } } } } } }, "delete": { "operationId": "DELETE/adyen_payments/adyenPaymentId", "summary": "Delete an adyen payment", "description": "Delete an adyen payment", "tags": [ "adyen_payments" ], "parameters": [ { "name": "adyenPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/adyen_payments/{adyenPaymentId}/order": { "get": { "operationId": "GET/adyenPaymentId/order", "summary": "Retrieve the order associated to the adyen payment", "description": "Retrieve the order associated to the adyen payment", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "adyenPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order associated to the adyen payment" } } } }, "/adyen_payments/{adyenPaymentId}/payment_gateway": { "get": { "operationId": "GET/adyenPaymentId/payment_gateway", "summary": "Retrieve the payment gateway associated to the adyen payment", "description": "Retrieve the payment gateway associated to the adyen payment", "tags": [ "has_one", "payment_gateways" ], "parameters": [ { "name": "adyenPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_gateway associated to the adyen payment" } } } }, "/adyen_payments/{adyenPaymentId}/event_stores": { "get": { "operationId": "GET/adyenPaymentId/event_stores", "summary": "Retrieve the event stores associated to the adyen payment", "description": "Retrieve the event stores associated to the adyen payment", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "adyenPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the adyen payment" } } } }, "/application": { "get": { "operationId": "GET/application/applicationId", "summary": "Retrieve the application", "description": "Retrieve the application", "tags": [ "application", "singleton" ], "responses": { "200": { "description": "The application object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/applicationResponse" } } } } } } }, "/attachments": { "get": { "operationId": "GET/attachments", "summary": "List all attachments", "description": "List all attachments", "tags": [ "attachments" ], "responses": { "200": { "description": "A list of attachment objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/attachmentResponseList" } } } } } }, "post": { "operationId": "POST/attachments", "summary": "Create an attachment", "description": "Create an attachment", "tags": [ "attachments" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/attachmentCreate" } } } }, "responses": { "201": { "description": "The created attachment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/attachmentResponse" } } } } } } }, "/attachments/{attachmentId}": { "get": { "operationId": "GET/attachments/attachmentId", "summary": "Retrieve an attachment", "description": "Retrieve an attachment", "tags": [ "attachments" ], "parameters": [ { "name": "attachmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/attachmentResponse" } } } } } }, "patch": { "operationId": "PATCH/attachments/attachmentId", "summary": "Update an attachment", "description": "Update an attachment", "tags": [ "attachments" ], "parameters": [ { "name": "attachmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/attachmentUpdate" } } } }, "responses": { "200": { "description": "The updated attachment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/attachmentResponse" } } } } } }, "delete": { "operationId": "DELETE/attachments/attachmentId", "summary": "Delete an attachment", "description": "Delete an attachment", "tags": [ "attachments" ], "parameters": [ { "name": "attachmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/attachments/{attachmentId}/event_stores": { "get": { "operationId": "GET/attachmentId/event_stores", "summary": "Retrieve the event stores associated to the attachment", "description": "Retrieve the event stores associated to the attachment", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "attachmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the attachment" } } } }, "/authorizations": { "get": { "operationId": "GET/authorizations", "summary": "List all authorizations", "description": "List all authorizations", "tags": [ "authorizations" ], "responses": { "200": { "description": "A list of authorization objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/authorizationResponseList" } } } } } } }, "/authorizations/{authorizationId}": { "get": { "operationId": "GET/authorizations/authorizationId", "summary": "Retrieve an authorization", "description": "Retrieve an authorization", "tags": [ "authorizations" ], "parameters": [ { "name": "authorizationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The authorization object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/authorizationResponse" } } } } } }, "patch": { "operationId": "PATCH/authorizations/authorizationId", "summary": "Update an authorization", "description": "Update an authorization", "tags": [ "authorizations" ], "parameters": [ { "name": "authorizationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/authorizationUpdate" } } } }, "responses": { "200": { "description": "The updated authorization object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/authorizationResponse" } } } } } } }, "/authorizations/{authorizationId}/order": { "get": { "operationId": "GET/authorizationId/order", "summary": "Retrieve the order associated to the authorization", "description": "Retrieve the order associated to the authorization", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "authorizationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order associated to the authorization" } } } }, "/authorizations/{authorizationId}/attachments": { "get": { "operationId": "GET/authorizationId/attachments", "summary": "Retrieve the attachments associated to the authorization", "description": "Retrieve the attachments associated to the authorization", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "authorizationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the authorization" } } } }, "/authorizations/{authorizationId}/events": { "get": { "operationId": "GET/authorizationId/events", "summary": "Retrieve the events associated to the authorization", "description": "Retrieve the events associated to the authorization", "tags": [ "has_many", "events" ], "parameters": [ { "name": "authorizationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the authorization" } } } }, "/authorizations/{authorizationId}/event_stores": { "get": { "operationId": "GET/authorizationId/event_stores", "summary": "Retrieve the event stores associated to the authorization", "description": "Retrieve the event stores associated to the authorization", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "authorizationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the authorization" } } } }, "/authorizations/{authorizationId}/captures": { "get": { "operationId": "GET/authorizationId/captures", "summary": "Retrieve the captures associated to the authorization", "description": "Retrieve the captures associated to the authorization", "tags": [ "has_many", "captures" ], "parameters": [ { "name": "authorizationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The captures associated to the authorization" } } } }, "/authorizations/{authorizationId}/voids": { "get": { "operationId": "GET/authorizationId/voids", "summary": "Retrieve the voids associated to the authorization", "description": "Retrieve the voids associated to the authorization", "tags": [ "has_many", "voids" ], "parameters": [ { "name": "authorizationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The voids associated to the authorization" } } } }, "/avalara_accounts": { "get": { "operationId": "GET/avalara_accounts", "summary": "List all avalara accounts", "description": "List all avalara accounts", "tags": [ "avalara_accounts" ], "responses": { "200": { "description": "A list of avalara account objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/avalaraAccountResponseList" } } } } } }, "post": { "operationId": "POST/avalara_accounts", "summary": "Create an avalara account", "description": "Create an avalara account", "tags": [ "avalara_accounts" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/avalaraAccountCreate" } } } }, "responses": { "201": { "description": "The created avalara account object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/avalaraAccountResponse" } } } } } } }, "/avalara_accounts/{avalaraAccountId}": { "get": { "operationId": "GET/avalara_accounts/avalaraAccountId", "summary": "Retrieve an avalara account", "description": "Retrieve an avalara account", "tags": [ "avalara_accounts" ], "parameters": [ { "name": "avalaraAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The avalara account object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/avalaraAccountResponse" } } } } } }, "patch": { "operationId": "PATCH/avalara_accounts/avalaraAccountId", "summary": "Update an avalara account", "description": "Update an avalara account", "tags": [ "avalara_accounts" ], "parameters": [ { "name": "avalaraAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/avalaraAccountUpdate" } } } }, "responses": { "200": { "description": "The updated avalara account object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/avalaraAccountResponse" } } } } } }, "delete": { "operationId": "DELETE/avalara_accounts/avalaraAccountId", "summary": "Delete an avalara account", "description": "Delete an avalara account", "tags": [ "avalara_accounts" ], "parameters": [ { "name": "avalaraAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/avalara_accounts/{avalaraAccountId}/markets": { "get": { "operationId": "GET/avalaraAccountId/markets", "summary": "Retrieve the markets associated to the avalara account", "description": "Retrieve the markets associated to the avalara account", "tags": [ "has_many", "markets" ], "parameters": [ { "name": "avalaraAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The markets associated to the avalara account" } } } }, "/avalara_accounts/{avalaraAccountId}/attachments": { "get": { "operationId": "GET/avalaraAccountId/attachments", "summary": "Retrieve the attachments associated to the avalara account", "description": "Retrieve the attachments associated to the avalara account", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "avalaraAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the avalara account" } } } }, "/avalara_accounts/{avalaraAccountId}/events": { "get": { "operationId": "GET/avalaraAccountId/events", "summary": "Retrieve the events associated to the avalara account", "description": "Retrieve the events associated to the avalara account", "tags": [ "has_many", "events" ], "parameters": [ { "name": "avalaraAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the avalara account" } } } }, "/avalara_accounts/{avalaraAccountId}/event_stores": { "get": { "operationId": "GET/avalaraAccountId/event_stores", "summary": "Retrieve the event stores associated to the avalara account", "description": "Retrieve the event stores associated to the avalara account", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "avalaraAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the avalara account" } } } }, "/avalara_accounts/{avalaraAccountId}/tax_categories": { "get": { "operationId": "GET/avalaraAccountId/tax_categories", "summary": "Retrieve the tax categories associated to the avalara account", "description": "Retrieve the tax categories associated to the avalara account", "tags": [ "has_many", "tax_categories" ], "parameters": [ { "name": "avalaraAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tax_categories associated to the avalara account" } } } }, "/axerve_gateways": { "get": { "operationId": "GET/axerve_gateways", "summary": "List all axerve gateways", "description": "List all axerve gateways", "tags": [ "axerve_gateways" ], "responses": { "200": { "description": "A list of axerve gateway objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/axerveGatewayResponseList" } } } } } }, "post": { "operationId": "POST/axerve_gateways", "summary": "Create an axerve gateway", "description": "Create an axerve gateway", "tags": [ "axerve_gateways" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/axerveGatewayCreate" } } } }, "responses": { "201": { "description": "The created axerve gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/axerveGatewayResponse" } } } } } } }, "/axerve_gateways/{axerveGatewayId}": { "get": { "operationId": "GET/axerve_gateways/axerveGatewayId", "summary": "Retrieve an axerve gateway", "description": "Retrieve an axerve gateway", "tags": [ "axerve_gateways" ], "parameters": [ { "name": "axerveGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The axerve gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/axerveGatewayResponse" } } } } } }, "patch": { "operationId": "PATCH/axerve_gateways/axerveGatewayId", "summary": "Update an axerve gateway", "description": "Update an axerve gateway", "tags": [ "axerve_gateways" ], "parameters": [ { "name": "axerveGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/axerveGatewayUpdate" } } } }, "responses": { "200": { "description": "The updated axerve gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/axerveGatewayResponse" } } } } } }, "delete": { "operationId": "DELETE/axerve_gateways/axerveGatewayId", "summary": "Delete an axerve gateway", "description": "Delete an axerve gateway", "tags": [ "axerve_gateways" ], "parameters": [ { "name": "axerveGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/axerve_gateways/{axerveGatewayId}/payment_methods": { "get": { "operationId": "GET/axerveGatewayId/payment_methods", "summary": "Retrieve the payment methods associated to the axerve gateway", "description": "Retrieve the payment methods associated to the axerve gateway", "tags": [ "has_many", "payment_methods" ], "parameters": [ { "name": "axerveGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_methods associated to the axerve gateway" } } } }, "/axerve_gateways/{axerveGatewayId}/event_stores": { "get": { "operationId": "GET/axerveGatewayId/event_stores", "summary": "Retrieve the event stores associated to the axerve gateway", "description": "Retrieve the event stores associated to the axerve gateway", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "axerveGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the axerve gateway" } } } }, "/axerve_gateways/{axerveGatewayId}/axerve_payments": { "get": { "operationId": "GET/axerveGatewayId/axerve_payments", "summary": "Retrieve the axerve payments associated to the axerve gateway", "description": "Retrieve the axerve payments associated to the axerve gateway", "tags": [ "has_many", "axerve_payments" ], "parameters": [ { "name": "axerveGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The axerve_payments associated to the axerve gateway" } } } }, "/axerve_payments": { "get": { "operationId": "GET/axerve_payments", "summary": "List all axerve payments", "description": "List all axerve payments", "tags": [ "axerve_payments" ], "responses": { "200": { "description": "A list of axerve payment objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/axervePaymentResponseList" } } } } } }, "post": { "operationId": "POST/axerve_payments", "summary": "Create an axerve payment", "description": "Create an axerve payment", "tags": [ "axerve_payments" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/axervePaymentCreate" } } } }, "responses": { "201": { "description": "The created axerve payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/axervePaymentResponse" } } } } } } }, "/axerve_payments/{axervePaymentId}": { "get": { "operationId": "GET/axerve_payments/axervePaymentId", "summary": "Retrieve an axerve payment", "description": "Retrieve an axerve payment", "tags": [ "axerve_payments" ], "parameters": [ { "name": "axervePaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The axerve payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/axervePaymentResponse" } } } } } }, "patch": { "operationId": "PATCH/axerve_payments/axervePaymentId", "summary": "Update an axerve payment", "description": "Update an axerve payment", "tags": [ "axerve_payments" ], "parameters": [ { "name": "axervePaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/axervePaymentUpdate" } } } }, "responses": { "200": { "description": "The updated axerve payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/axervePaymentResponse" } } } } } }, "delete": { "operationId": "DELETE/axerve_payments/axervePaymentId", "summary": "Delete an axerve payment", "description": "Delete an axerve payment", "tags": [ "axerve_payments" ], "parameters": [ { "name": "axervePaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/axerve_payments/{axervePaymentId}/order": { "get": { "operationId": "GET/axervePaymentId/order", "summary": "Retrieve the order associated to the axerve payment", "description": "Retrieve the order associated to the axerve payment", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "axervePaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order associated to the axerve payment" } } } }, "/axerve_payments/{axervePaymentId}/payment_gateway": { "get": { "operationId": "GET/axervePaymentId/payment_gateway", "summary": "Retrieve the payment gateway associated to the axerve payment", "description": "Retrieve the payment gateway associated to the axerve payment", "tags": [ "has_one", "payment_gateways" ], "parameters": [ { "name": "axervePaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_gateway associated to the axerve payment" } } } }, "/axerve_payments/{axervePaymentId}/event_stores": { "get": { "operationId": "GET/axervePaymentId/event_stores", "summary": "Retrieve the event stores associated to the axerve payment", "description": "Retrieve the event stores associated to the axerve payment", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "axervePaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the axerve payment" } } } }, "/bing_geocoders": { "get": { "operationId": "GET/bing_geocoders", "summary": "List all bing geocoders", "description": "List all bing geocoders", "tags": [ "bing_geocoders" ], "responses": { "200": { "description": "A list of bing geocoder objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/bingGeocoderResponseList" } } } } } }, "post": { "operationId": "POST/bing_geocoders", "summary": "Create a bing geocoder", "description": "Create a bing geocoder", "tags": [ "bing_geocoders" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/bingGeocoderCreate" } } } }, "responses": { "201": { "description": "The created bing geocoder object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/bingGeocoderResponse" } } } } } } }, "/bing_geocoders/{bingGeocoderId}": { "get": { "operationId": "GET/bing_geocoders/bingGeocoderId", "summary": "Retrieve a bing geocoder", "description": "Retrieve a bing geocoder", "tags": [ "bing_geocoders" ], "parameters": [ { "name": "bingGeocoderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The bing geocoder object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/bingGeocoderResponse" } } } } } }, "patch": { "operationId": "PATCH/bing_geocoders/bingGeocoderId", "summary": "Update a bing geocoder", "description": "Update a bing geocoder", "tags": [ "bing_geocoders" ], "parameters": [ { "name": "bingGeocoderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/bingGeocoderUpdate" } } } }, "responses": { "200": { "description": "The updated bing geocoder object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/bingGeocoderResponse" } } } } } }, "delete": { "operationId": "DELETE/bing_geocoders/bingGeocoderId", "summary": "Delete a bing geocoder", "description": "Delete a bing geocoder", "tags": [ "bing_geocoders" ], "parameters": [ { "name": "bingGeocoderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/bing_geocoders/{bingGeocoderId}/markets": { "get": { "operationId": "GET/bingGeocoderId/markets", "summary": "Retrieve the markets associated to the bing geocoder", "description": "Retrieve the markets associated to the bing geocoder", "tags": [ "has_many", "markets" ], "parameters": [ { "name": "bingGeocoderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The markets associated to the bing geocoder" } } } }, "/bing_geocoders/{bingGeocoderId}/addresses": { "get": { "operationId": "GET/bingGeocoderId/addresses", "summary": "Retrieve the addresses associated to the bing geocoder", "description": "Retrieve the addresses associated to the bing geocoder", "tags": [ "has_many", "addresses" ], "parameters": [ { "name": "bingGeocoderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The addresses associated to the bing geocoder" } } } }, "/bing_geocoders/{bingGeocoderId}/attachments": { "get": { "operationId": "GET/bingGeocoderId/attachments", "summary": "Retrieve the attachments associated to the bing geocoder", "description": "Retrieve the attachments associated to the bing geocoder", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "bingGeocoderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the bing geocoder" } } } }, "/bing_geocoders/{bingGeocoderId}/event_stores": { "get": { "operationId": "GET/bingGeocoderId/event_stores", "summary": "Retrieve the event stores associated to the bing geocoder", "description": "Retrieve the event stores associated to the bing geocoder", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "bingGeocoderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the bing geocoder" } } } }, "/braintree_gateways": { "get": { "operationId": "GET/braintree_gateways", "summary": "List all braintree gateways", "description": "List all braintree gateways", "tags": [ "braintree_gateways" ], "responses": { "200": { "description": "A list of braintree gateway objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/braintreeGatewayResponseList" } } } } } }, "post": { "operationId": "POST/braintree_gateways", "summary": "Create a braintree gateway", "description": "Create a braintree gateway", "tags": [ "braintree_gateways" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/braintreeGatewayCreate" } } } }, "responses": { "201": { "description": "The created braintree gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/braintreeGatewayResponse" } } } } } } }, "/braintree_gateways/{braintreeGatewayId}": { "get": { "operationId": "GET/braintree_gateways/braintreeGatewayId", "summary": "Retrieve a braintree gateway", "description": "Retrieve a braintree gateway", "tags": [ "braintree_gateways" ], "parameters": [ { "name": "braintreeGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The braintree gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/braintreeGatewayResponse" } } } } } }, "patch": { "operationId": "PATCH/braintree_gateways/braintreeGatewayId", "summary": "Update a braintree gateway", "description": "Update a braintree gateway", "tags": [ "braintree_gateways" ], "parameters": [ { "name": "braintreeGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/braintreeGatewayUpdate" } } } }, "responses": { "200": { "description": "The updated braintree gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/braintreeGatewayResponse" } } } } } }, "delete": { "operationId": "DELETE/braintree_gateways/braintreeGatewayId", "summary": "Delete a braintree gateway", "description": "Delete a braintree gateway", "tags": [ "braintree_gateways" ], "parameters": [ { "name": "braintreeGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/braintree_gateways/{braintreeGatewayId}/payment_methods": { "get": { "operationId": "GET/braintreeGatewayId/payment_methods", "summary": "Retrieve the payment methods associated to the braintree gateway", "description": "Retrieve the payment methods associated to the braintree gateway", "tags": [ "has_many", "payment_methods" ], "parameters": [ { "name": "braintreeGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_methods associated to the braintree gateway" } } } }, "/braintree_gateways/{braintreeGatewayId}/event_stores": { "get": { "operationId": "GET/braintreeGatewayId/event_stores", "summary": "Retrieve the event stores associated to the braintree gateway", "description": "Retrieve the event stores associated to the braintree gateway", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "braintreeGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the braintree gateway" } } } }, "/braintree_gateways/{braintreeGatewayId}/braintree_payments": { "get": { "operationId": "GET/braintreeGatewayId/braintree_payments", "summary": "Retrieve the braintree payments associated to the braintree gateway", "description": "Retrieve the braintree payments associated to the braintree gateway", "tags": [ "has_many", "braintree_payments" ], "parameters": [ { "name": "braintreeGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The braintree_payments associated to the braintree gateway" } } } }, "/braintree_payments": { "get": { "operationId": "GET/braintree_payments", "summary": "List all braintree payments", "description": "List all braintree payments", "tags": [ "braintree_payments" ], "responses": { "200": { "description": "A list of braintree payment objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/braintreePaymentResponseList" } } } } } }, "post": { "operationId": "POST/braintree_payments", "summary": "Create a braintree payment", "description": "Create a braintree payment", "tags": [ "braintree_payments" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/braintreePaymentCreate" } } } }, "responses": { "201": { "description": "The created braintree payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/braintreePaymentResponse" } } } } } } }, "/braintree_payments/{braintreePaymentId}": { "get": { "operationId": "GET/braintree_payments/braintreePaymentId", "summary": "Retrieve a braintree payment", "description": "Retrieve a braintree payment", "tags": [ "braintree_payments" ], "parameters": [ { "name": "braintreePaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The braintree payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/braintreePaymentResponse" } } } } } }, "patch": { "operationId": "PATCH/braintree_payments/braintreePaymentId", "summary": "Update a braintree payment", "description": "Update a braintree payment", "tags": [ "braintree_payments" ], "parameters": [ { "name": "braintreePaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/braintreePaymentUpdate" } } } }, "responses": { "200": { "description": "The updated braintree payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/braintreePaymentResponse" } } } } } }, "delete": { "operationId": "DELETE/braintree_payments/braintreePaymentId", "summary": "Delete a braintree payment", "description": "Delete a braintree payment", "tags": [ "braintree_payments" ], "parameters": [ { "name": "braintreePaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/braintree_payments/{braintreePaymentId}/order": { "get": { "operationId": "GET/braintreePaymentId/order", "summary": "Retrieve the order associated to the braintree payment", "description": "Retrieve the order associated to the braintree payment", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "braintreePaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order associated to the braintree payment" } } } }, "/braintree_payments/{braintreePaymentId}/payment_gateway": { "get": { "operationId": "GET/braintreePaymentId/payment_gateway", "summary": "Retrieve the payment gateway associated to the braintree payment", "description": "Retrieve the payment gateway associated to the braintree payment", "tags": [ "has_one", "payment_gateways" ], "parameters": [ { "name": "braintreePaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_gateway associated to the braintree payment" } } } }, "/braintree_payments/{braintreePaymentId}/event_stores": { "get": { "operationId": "GET/braintreePaymentId/event_stores", "summary": "Retrieve the event stores associated to the braintree payment", "description": "Retrieve the event stores associated to the braintree payment", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "braintreePaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the braintree payment" } } } }, "/bundles": { "get": { "operationId": "GET/bundles", "summary": "List all bundles", "description": "List all bundles", "tags": [ "bundles" ], "responses": { "200": { "description": "A list of bundle objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/bundleResponseList" } } } } } }, "post": { "operationId": "POST/bundles", "summary": "Create a bundle", "description": "Create a bundle", "tags": [ "bundles" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/bundleCreate" } } } }, "responses": { "201": { "description": "The created bundle object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/bundleResponse" } } } } } } }, "/bundles/{bundleId}": { "get": { "operationId": "GET/bundles/bundleId", "summary": "Retrieve a bundle", "description": "Retrieve a bundle", "tags": [ "bundles" ], "parameters": [ { "name": "bundleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The bundle object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/bundleResponse" } } } } } }, "patch": { "operationId": "PATCH/bundles/bundleId", "summary": "Update a bundle", "description": "Update a bundle", "tags": [ "bundles" ], "parameters": [ { "name": "bundleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/bundleUpdate" } } } }, "responses": { "200": { "description": "The updated bundle object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/bundleResponse" } } } } } }, "delete": { "operationId": "DELETE/bundles/bundleId", "summary": "Delete a bundle", "description": "Delete a bundle", "tags": [ "bundles" ], "parameters": [ { "name": "bundleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/bundles/{bundleId}/market": { "get": { "operationId": "GET/bundleId/market", "summary": "Retrieve the market associated to the bundle", "description": "Retrieve the market associated to the bundle", "tags": [ "has_one", "markets" ], "parameters": [ { "name": "bundleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The market associated to the bundle" } } } }, "/bundles/{bundleId}/sku_list": { "get": { "operationId": "GET/bundleId/sku_list", "summary": "Retrieve the sku list associated to the bundle", "description": "Retrieve the sku list associated to the bundle", "tags": [ "has_one", "sku_lists" ], "parameters": [ { "name": "bundleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_list associated to the bundle" } } } }, "/bundles/{bundleId}/skus": { "get": { "operationId": "GET/bundleId/skus", "summary": "Retrieve the skus associated to the bundle", "description": "Retrieve the skus associated to the bundle", "tags": [ "has_many", "skus" ], "parameters": [ { "name": "bundleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The skus associated to the bundle" } } } }, "/bundles/{bundleId}/attachments": { "get": { "operationId": "GET/bundleId/attachments", "summary": "Retrieve the attachments associated to the bundle", "description": "Retrieve the attachments associated to the bundle", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "bundleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the bundle" } } } }, "/bundles/{bundleId}/events": { "get": { "operationId": "GET/bundleId/events", "summary": "Retrieve the events associated to the bundle", "description": "Retrieve the events associated to the bundle", "tags": [ "has_many", "events" ], "parameters": [ { "name": "bundleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the bundle" } } } }, "/bundles/{bundleId}/tags": { "get": { "operationId": "GET/bundleId/tags", "summary": "Retrieve the tags associated to the bundle", "description": "Retrieve the tags associated to the bundle", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "bundleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the bundle" } } } }, "/bundles/{bundleId}/event_stores": { "get": { "operationId": "GET/bundleId/event_stores", "summary": "Retrieve the event stores associated to the bundle", "description": "Retrieve the event stores associated to the bundle", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "bundleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the bundle" } } } }, "/buy_x_pay_y_promotions": { "get": { "operationId": "GET/buy_x_pay_y_promotions", "summary": "List all buy x pay y promotions", "description": "List all buy x pay y promotions", "tags": [ "buy_x_pay_y_promotions" ], "responses": { "200": { "description": "A list of buy x pay y promotion objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/buyXPayYPromotionResponseList" } } } } } }, "post": { "operationId": "POST/buy_x_pay_y_promotions", "summary": "Create a buy x pay y promotion", "description": "Create a buy x pay y promotion", "tags": [ "buy_x_pay_y_promotions" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/buyXPayYPromotionCreate" } } } }, "responses": { "201": { "description": "The created buy x pay y promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/buyXPayYPromotionResponse" } } } } } } }, "/buy_x_pay_y_promotions/{buyXPayYPromotionId}": { "get": { "operationId": "GET/buy_x_pay_y_promotions/buyXPayYPromotionId", "summary": "Retrieve a buy x pay y promotion", "description": "Retrieve a buy x pay y promotion", "tags": [ "buy_x_pay_y_promotions" ], "parameters": [ { "name": "buyXPayYPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The buy x pay y promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/buyXPayYPromotionResponse" } } } } } }, "patch": { "operationId": "PATCH/buy_x_pay_y_promotions/buyXPayYPromotionId", "summary": "Update a buy x pay y promotion", "description": "Update a buy x pay y promotion", "tags": [ "buy_x_pay_y_promotions" ], "parameters": [ { "name": "buyXPayYPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/buyXPayYPromotionUpdate" } } } }, "responses": { "200": { "description": "The updated buy x pay y promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/buyXPayYPromotionResponse" } } } } } }, "delete": { "operationId": "DELETE/buy_x_pay_y_promotions/buyXPayYPromotionId", "summary": "Delete a buy x pay y promotion", "description": "Delete a buy x pay y promotion", "tags": [ "buy_x_pay_y_promotions" ], "parameters": [ { "name": "buyXPayYPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/buy_x_pay_y_promotions/{buyXPayYPromotionId}/market": { "get": { "operationId": "GET/buyXPayYPromotionId/market", "summary": "Retrieve the market associated to the buy x pay y promotion", "description": "Retrieve the market associated to the buy x pay y promotion", "tags": [ "has_one", "markets" ], "parameters": [ { "name": "buyXPayYPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The market associated to the buy x pay y promotion" } } } }, "/buy_x_pay_y_promotions/{buyXPayYPromotionId}/order_amount_promotion_rule": { "get": { "operationId": "GET/buyXPayYPromotionId/order_amount_promotion_rule", "summary": "Retrieve the order amount promotion rule associated to the buy x pay y promotion", "description": "Retrieve the order amount promotion rule associated to the buy x pay y promotion", "tags": [ "has_one", "order_amount_promotion_rules" ], "parameters": [ { "name": "buyXPayYPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order_amount_promotion_rule associated to the buy x pay y promotion" } } } }, "/buy_x_pay_y_promotions/{buyXPayYPromotionId}/sku_list_promotion_rule": { "get": { "operationId": "GET/buyXPayYPromotionId/sku_list_promotion_rule", "summary": "Retrieve the sku list promotion rule associated to the buy x pay y promotion", "description": "Retrieve the sku list promotion rule associated to the buy x pay y promotion", "tags": [ "has_one", "sku_list_promotion_rules" ], "parameters": [ { "name": "buyXPayYPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_list_promotion_rule associated to the buy x pay y promotion" } } } }, "/buy_x_pay_y_promotions/{buyXPayYPromotionId}/coupon_codes_promotion_rule": { "get": { "operationId": "GET/buyXPayYPromotionId/coupon_codes_promotion_rule", "summary": "Retrieve the coupon codes promotion rule associated to the buy x pay y promotion", "description": "Retrieve the coupon codes promotion rule associated to the buy x pay y promotion", "tags": [ "has_one", "coupon_codes_promotion_rules" ], "parameters": [ { "name": "buyXPayYPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupon_codes_promotion_rule associated to the buy x pay y promotion" } } } }, "/buy_x_pay_y_promotions/{buyXPayYPromotionId}/custom_promotion_rule": { "get": { "operationId": "GET/buyXPayYPromotionId/custom_promotion_rule", "summary": "Retrieve the custom promotion rule associated to the buy x pay y promotion", "description": "Retrieve the custom promotion rule associated to the buy x pay y promotion", "tags": [ "has_one", "custom_promotion_rules" ], "parameters": [ { "name": "buyXPayYPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The custom_promotion_rule associated to the buy x pay y promotion" } } } }, "/buy_x_pay_y_promotions/{buyXPayYPromotionId}/sku_list": { "get": { "operationId": "GET/buyXPayYPromotionId/sku_list", "summary": "Retrieve the sku list associated to the buy x pay y promotion", "description": "Retrieve the sku list associated to the buy x pay y promotion", "tags": [ "has_one", "sku_lists" ], "parameters": [ { "name": "buyXPayYPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_list associated to the buy x pay y promotion" } } } }, "/buy_x_pay_y_promotions/{buyXPayYPromotionId}/coupons": { "get": { "operationId": "GET/buyXPayYPromotionId/coupons", "summary": "Retrieve the coupons associated to the buy x pay y promotion", "description": "Retrieve the coupons associated to the buy x pay y promotion", "tags": [ "has_many", "coupons" ], "parameters": [ { "name": "buyXPayYPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupons associated to the buy x pay y promotion" } } } }, "/buy_x_pay_y_promotions/{buyXPayYPromotionId}/attachments": { "get": { "operationId": "GET/buyXPayYPromotionId/attachments", "summary": "Retrieve the attachments associated to the buy x pay y promotion", "description": "Retrieve the attachments associated to the buy x pay y promotion", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "buyXPayYPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the buy x pay y promotion" } } } }, "/buy_x_pay_y_promotions/{buyXPayYPromotionId}/events": { "get": { "operationId": "GET/buyXPayYPromotionId/events", "summary": "Retrieve the events associated to the buy x pay y promotion", "description": "Retrieve the events associated to the buy x pay y promotion", "tags": [ "has_many", "events" ], "parameters": [ { "name": "buyXPayYPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the buy x pay y promotion" } } } }, "/buy_x_pay_y_promotions/{buyXPayYPromotionId}/tags": { "get": { "operationId": "GET/buyXPayYPromotionId/tags", "summary": "Retrieve the tags associated to the buy x pay y promotion", "description": "Retrieve the tags associated to the buy x pay y promotion", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "buyXPayYPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the buy x pay y promotion" } } } }, "/buy_x_pay_y_promotions/{buyXPayYPromotionId}/event_stores": { "get": { "operationId": "GET/buyXPayYPromotionId/event_stores", "summary": "Retrieve the event stores associated to the buy x pay y promotion", "description": "Retrieve the event stores associated to the buy x pay y promotion", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "buyXPayYPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the buy x pay y promotion" } } } }, "/buy_x_pay_y_promotions/{buyXPayYPromotionId}/skus": { "get": { "operationId": "GET/buyXPayYPromotionId/skus", "summary": "Retrieve the skus associated to the buy x pay y promotion", "description": "Retrieve the skus associated to the buy x pay y promotion", "tags": [ "has_many", "skus" ], "parameters": [ { "name": "buyXPayYPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The skus associated to the buy x pay y promotion" } } } }, "/captures": { "get": { "operationId": "GET/captures", "summary": "List all captures", "description": "List all captures", "tags": [ "captures" ], "responses": { "200": { "description": "A list of capture objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/captureResponseList" } } } } } } }, "/captures/{captureId}": { "get": { "operationId": "GET/captures/captureId", "summary": "Retrieve a capture", "description": "Retrieve a capture", "tags": [ "captures" ], "parameters": [ { "name": "captureId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The capture object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/captureResponse" } } } } } }, "patch": { "operationId": "PATCH/captures/captureId", "summary": "Update a capture", "description": "Update a capture", "tags": [ "captures" ], "parameters": [ { "name": "captureId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/captureUpdate" } } } }, "responses": { "200": { "description": "The updated capture object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/captureResponse" } } } } } } }, "/captures/{captureId}/order": { "get": { "operationId": "GET/captureId/order", "summary": "Retrieve the order associated to the capture", "description": "Retrieve the order associated to the capture", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "captureId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order associated to the capture" } } } }, "/captures/{captureId}/attachments": { "get": { "operationId": "GET/captureId/attachments", "summary": "Retrieve the attachments associated to the capture", "description": "Retrieve the attachments associated to the capture", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "captureId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the capture" } } } }, "/captures/{captureId}/events": { "get": { "operationId": "GET/captureId/events", "summary": "Retrieve the events associated to the capture", "description": "Retrieve the events associated to the capture", "tags": [ "has_many", "events" ], "parameters": [ { "name": "captureId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the capture" } } } }, "/captures/{captureId}/event_stores": { "get": { "operationId": "GET/captureId/event_stores", "summary": "Retrieve the event stores associated to the capture", "description": "Retrieve the event stores associated to the capture", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "captureId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the capture" } } } }, "/captures/{captureId}/reference_authorization": { "get": { "operationId": "GET/captureId/reference_authorization", "summary": "Retrieve the reference authorization associated to the capture", "description": "Retrieve the reference authorization associated to the capture", "tags": [ "has_one", "authorizations" ], "parameters": [ { "name": "captureId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The reference_authorization associated to the capture" } } } }, "/captures/{captureId}/refunds": { "get": { "operationId": "GET/captureId/refunds", "summary": "Retrieve the refunds associated to the capture", "description": "Retrieve the refunds associated to the capture", "tags": [ "has_many", "refunds" ], "parameters": [ { "name": "captureId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The refunds associated to the capture" } } } }, "/captures/{captureId}/return": { "get": { "operationId": "GET/captureId/return", "summary": "Retrieve the return associated to the capture", "description": "Retrieve the return associated to the capture", "tags": [ "has_one", "returns" ], "parameters": [ { "name": "captureId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The return associated to the capture" } } } }, "/carrier_accounts": { "get": { "operationId": "GET/carrier_accounts", "summary": "List all carrier accounts", "description": "List all carrier accounts", "tags": [ "carrier_accounts" ], "responses": { "200": { "description": "A list of carrier account objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/carrierAccountResponseList" } } } } } }, "post": { "operationId": "POST/carrier_accounts", "summary": "Create a carrier account", "description": "Create a carrier account", "tags": [ "carrier_accounts" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/carrierAccountCreate" } } } }, "responses": { "201": { "description": "The created carrier account object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/carrierAccountResponse" } } } } } } }, "/carrier_accounts/{carrierAccountId}": { "get": { "operationId": "GET/carrier_accounts/carrierAccountId", "summary": "Retrieve a carrier account", "description": "Retrieve a carrier account", "tags": [ "carrier_accounts" ], "parameters": [ { "name": "carrierAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The carrier account object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/carrierAccountResponse" } } } } } }, "patch": { "operationId": "PATCH/carrier_accounts/carrierAccountId", "summary": "Update a carrier account", "description": "Update a carrier account", "tags": [ "carrier_accounts" ], "parameters": [ { "name": "carrierAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/carrierAccountUpdate" } } } }, "responses": { "200": { "description": "The updated carrier account object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/carrierAccountResponse" } } } } } }, "delete": { "operationId": "DELETE/carrier_accounts/carrierAccountId", "summary": "Delete a carrier account", "description": "Delete a carrier account", "tags": [ "carrier_accounts" ], "parameters": [ { "name": "carrierAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/carrier_accounts/{carrierAccountId}/market": { "get": { "operationId": "GET/carrierAccountId/market", "summary": "Retrieve the market associated to the carrier account", "description": "Retrieve the market associated to the carrier account", "tags": [ "has_one", "markets" ], "parameters": [ { "name": "carrierAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The market associated to the carrier account" } } } }, "/carrier_accounts/{carrierAccountId}/attachments": { "get": { "operationId": "GET/carrierAccountId/attachments", "summary": "Retrieve the attachments associated to the carrier account", "description": "Retrieve the attachments associated to the carrier account", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "carrierAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the carrier account" } } } }, "/carrier_accounts/{carrierAccountId}/event_stores": { "get": { "operationId": "GET/carrierAccountId/event_stores", "summary": "Retrieve the event stores associated to the carrier account", "description": "Retrieve the event stores associated to the carrier account", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "carrierAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the carrier account" } } } }, "/checkout_com_gateways": { "get": { "operationId": "GET/checkout_com_gateways", "summary": "List all checkout.com gateways", "description": "List all checkout.com gateways", "tags": [ "checkout_com_gateways" ], "responses": { "200": { "description": "A list of checkout.com gateway objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/checkoutComGatewayResponseList" } } } } } }, "post": { "operationId": "POST/checkout_com_gateways", "summary": "Create a checkout.com gateway", "description": "Create a checkout.com gateway", "tags": [ "checkout_com_gateways" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/checkoutComGatewayCreate" } } } }, "responses": { "201": { "description": "The created checkout.com gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/checkoutComGatewayResponse" } } } } } } }, "/checkout_com_gateways/{checkoutComGatewayId}": { "get": { "operationId": "GET/checkout_com_gateways/checkoutComGatewayId", "summary": "Retrieve a checkout.com gateway", "description": "Retrieve a checkout.com gateway", "tags": [ "checkout_com_gateways" ], "parameters": [ { "name": "checkoutComGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The checkout.com gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/checkoutComGatewayResponse" } } } } } }, "patch": { "operationId": "PATCH/checkout_com_gateways/checkoutComGatewayId", "summary": "Update a checkout.com gateway", "description": "Update a checkout.com gateway", "tags": [ "checkout_com_gateways" ], "parameters": [ { "name": "checkoutComGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/checkoutComGatewayUpdate" } } } }, "responses": { "200": { "description": "The updated checkout.com gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/checkoutComGatewayResponse" } } } } } }, "delete": { "operationId": "DELETE/checkout_com_gateways/checkoutComGatewayId", "summary": "Delete a checkout.com gateway", "description": "Delete a checkout.com gateway", "tags": [ "checkout_com_gateways" ], "parameters": [ { "name": "checkoutComGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/checkout_com_gateways/{checkoutComGatewayId}/payment_methods": { "get": { "operationId": "GET/checkoutComGatewayId/payment_methods", "summary": "Retrieve the payment methods associated to the checkout.com gateway", "description": "Retrieve the payment methods associated to the checkout.com gateway", "tags": [ "has_many", "payment_methods" ], "parameters": [ { "name": "checkoutComGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_methods associated to the checkout.com gateway" } } } }, "/checkout_com_gateways/{checkoutComGatewayId}/event_stores": { "get": { "operationId": "GET/checkoutComGatewayId/event_stores", "summary": "Retrieve the event stores associated to the checkout.com gateway", "description": "Retrieve the event stores associated to the checkout.com gateway", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "checkoutComGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the checkout.com gateway" } } } }, "/checkout_com_gateways/{checkoutComGatewayId}/checkout_com_payments": { "get": { "operationId": "GET/checkoutComGatewayId/checkout_com_payments", "summary": "Retrieve the checkout com payments associated to the checkout.com gateway", "description": "Retrieve the checkout com payments associated to the checkout.com gateway", "tags": [ "has_many", "checkout_com_payments" ], "parameters": [ { "name": "checkoutComGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The checkout_com_payments associated to the checkout.com gateway" } } } }, "/checkout_com_payments": { "get": { "operationId": "GET/checkout_com_payments", "summary": "List all checkout.com payments", "description": "List all checkout.com payments", "tags": [ "checkout_com_payments" ], "responses": { "200": { "description": "A list of checkout.com payment objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/checkoutComPaymentResponseList" } } } } } }, "post": { "operationId": "POST/checkout_com_payments", "summary": "Create a checkout.com payment", "description": "Create a checkout.com payment", "tags": [ "checkout_com_payments" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/checkoutComPaymentCreate" } } } }, "responses": { "201": { "description": "The created checkout.com payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/checkoutComPaymentResponse" } } } } } } }, "/checkout_com_payments/{checkoutComPaymentId}": { "get": { "operationId": "GET/checkout_com_payments/checkoutComPaymentId", "summary": "Retrieve a checkout.com payment", "description": "Retrieve a checkout.com payment", "tags": [ "checkout_com_payments" ], "parameters": [ { "name": "checkoutComPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The checkout.com payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/checkoutComPaymentResponse" } } } } } }, "patch": { "operationId": "PATCH/checkout_com_payments/checkoutComPaymentId", "summary": "Update a checkout.com payment", "description": "Update a checkout.com payment", "tags": [ "checkout_com_payments" ], "parameters": [ { "name": "checkoutComPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/checkoutComPaymentUpdate" } } } }, "responses": { "200": { "description": "The updated checkout.com payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/checkoutComPaymentResponse" } } } } } }, "delete": { "operationId": "DELETE/checkout_com_payments/checkoutComPaymentId", "summary": "Delete a checkout.com payment", "description": "Delete a checkout.com payment", "tags": [ "checkout_com_payments" ], "parameters": [ { "name": "checkoutComPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/checkout_com_payments/{checkoutComPaymentId}/order": { "get": { "operationId": "GET/checkoutComPaymentId/order", "summary": "Retrieve the order associated to the checkout.com payment", "description": "Retrieve the order associated to the checkout.com payment", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "checkoutComPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order associated to the checkout.com payment" } } } }, "/checkout_com_payments/{checkoutComPaymentId}/payment_gateway": { "get": { "operationId": "GET/checkoutComPaymentId/payment_gateway", "summary": "Retrieve the payment gateway associated to the checkout.com payment", "description": "Retrieve the payment gateway associated to the checkout.com payment", "tags": [ "has_one", "payment_gateways" ], "parameters": [ { "name": "checkoutComPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_gateway associated to the checkout.com payment" } } } }, "/checkout_com_payments/{checkoutComPaymentId}/event_stores": { "get": { "operationId": "GET/checkoutComPaymentId/event_stores", "summary": "Retrieve the event stores associated to the checkout.com payment", "description": "Retrieve the event stores associated to the checkout.com payment", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "checkoutComPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the checkout.com payment" } } } }, "/cleanups": { "get": { "operationId": "GET/cleanups", "summary": "List all cleanups", "description": "List all cleanups", "tags": [ "cleanups" ], "responses": { "200": { "description": "A list of cleanup objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/cleanupResponseList" } } } } } }, "post": { "operationId": "POST/cleanups", "summary": "Create a cleanup", "description": "Create a cleanup", "tags": [ "cleanups" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/cleanupCreate" } } } }, "responses": { "201": { "description": "The created cleanup object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/cleanupResponse" } } } } } } }, "/cleanups/{cleanupId}": { "get": { "operationId": "GET/cleanups/cleanupId", "summary": "Retrieve a cleanup", "description": "Retrieve a cleanup", "tags": [ "cleanups" ], "parameters": [ { "name": "cleanupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The cleanup object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/cleanupResponse" } } } } } }, "patch": { "operationId": "PATCH/cleanups/cleanupId", "summary": "Update a cleanup", "description": "Update a cleanup", "tags": [ "cleanups" ], "parameters": [ { "name": "cleanupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/cleanupUpdate" } } } }, "responses": { "200": { "description": "The updated cleanup object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/cleanupResponse" } } } } } }, "delete": { "operationId": "DELETE/cleanups/cleanupId", "summary": "Delete a cleanup", "description": "Delete a cleanup", "tags": [ "cleanups" ], "parameters": [ { "name": "cleanupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/cleanups/{cleanupId}/events": { "get": { "operationId": "GET/cleanupId/events", "summary": "Retrieve the events associated to the cleanup", "description": "Retrieve the events associated to the cleanup", "tags": [ "has_many", "events" ], "parameters": [ { "name": "cleanupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the cleanup" } } } }, "/cleanups/{cleanupId}/event_stores": { "get": { "operationId": "GET/cleanupId/event_stores", "summary": "Retrieve the event stores associated to the cleanup", "description": "Retrieve the event stores associated to the cleanup", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "cleanupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the cleanup" } } } }, "/coupon_codes_promotion_rules": { "get": { "operationId": "GET/coupon_codes_promotion_rules", "summary": "List all coupon codes promotion rules", "description": "List all coupon codes promotion rules", "tags": [ "coupon_codes_promotion_rules" ], "responses": { "200": { "description": "A list of coupon codes promotion rule objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/couponCodesPromotionRuleResponseList" } } } } } }, "post": { "operationId": "POST/coupon_codes_promotion_rules", "summary": "Create a coupon codes promotion rule", "description": "Create a coupon codes promotion rule", "tags": [ "coupon_codes_promotion_rules" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/couponCodesPromotionRuleCreate" } } } }, "responses": { "201": { "description": "The created coupon codes promotion rule object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/couponCodesPromotionRuleResponse" } } } } } } }, "/coupon_codes_promotion_rules/{couponCodesPromotionRuleId}": { "get": { "operationId": "GET/coupon_codes_promotion_rules/couponCodesPromotionRuleId", "summary": "Retrieve a coupon codes promotion rule", "description": "Retrieve a coupon codes promotion rule", "tags": [ "coupon_codes_promotion_rules" ], "parameters": [ { "name": "couponCodesPromotionRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupon codes promotion rule object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/couponCodesPromotionRuleResponse" } } } } } }, "patch": { "operationId": "PATCH/coupon_codes_promotion_rules/couponCodesPromotionRuleId", "summary": "Update a coupon codes promotion rule", "description": "Update a coupon codes promotion rule", "tags": [ "coupon_codes_promotion_rules" ], "parameters": [ { "name": "couponCodesPromotionRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/couponCodesPromotionRuleUpdate" } } } }, "responses": { "200": { "description": "The updated coupon codes promotion rule object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/couponCodesPromotionRuleResponse" } } } } } }, "delete": { "operationId": "DELETE/coupon_codes_promotion_rules/couponCodesPromotionRuleId", "summary": "Delete a coupon codes promotion rule", "description": "Delete a coupon codes promotion rule", "tags": [ "coupon_codes_promotion_rules" ], "parameters": [ { "name": "couponCodesPromotionRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/coupon_codes_promotion_rules/{couponCodesPromotionRuleId}/event_stores": { "get": { "operationId": "GET/couponCodesPromotionRuleId/event_stores", "summary": "Retrieve the event stores associated to the coupon codes promotion rule", "description": "Retrieve the event stores associated to the coupon codes promotion rule", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "couponCodesPromotionRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the coupon codes promotion rule" } } } }, "/coupon_codes_promotion_rules/{couponCodesPromotionRuleId}/coupons": { "get": { "operationId": "GET/couponCodesPromotionRuleId/coupons", "summary": "Retrieve the coupons associated to the coupon codes promotion rule", "description": "Retrieve the coupons associated to the coupon codes promotion rule", "tags": [ "has_many", "coupons" ], "parameters": [ { "name": "couponCodesPromotionRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupons associated to the coupon codes promotion rule" } } } }, "/coupon_recipients": { "get": { "operationId": "GET/coupon_recipients", "summary": "List all coupon recipients", "description": "List all coupon recipients", "tags": [ "coupon_recipients" ], "responses": { "200": { "description": "A list of coupon recipient objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/couponRecipientResponseList" } } } } } }, "post": { "operationId": "POST/coupon_recipients", "summary": "Create a coupon recipient", "description": "Create a coupon recipient", "tags": [ "coupon_recipients" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/couponRecipientCreate" } } } }, "responses": { "201": { "description": "The created coupon recipient object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/couponRecipientResponse" } } } } } } }, "/coupon_recipients/{couponRecipientId}": { "get": { "operationId": "GET/coupon_recipients/couponRecipientId", "summary": "Retrieve a coupon recipient", "description": "Retrieve a coupon recipient", "tags": [ "coupon_recipients" ], "parameters": [ { "name": "couponRecipientId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupon recipient object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/couponRecipientResponse" } } } } } }, "patch": { "operationId": "PATCH/coupon_recipients/couponRecipientId", "summary": "Update a coupon recipient", "description": "Update a coupon recipient", "tags": [ "coupon_recipients" ], "parameters": [ { "name": "couponRecipientId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/couponRecipientUpdate" } } } }, "responses": { "200": { "description": "The updated coupon recipient object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/couponRecipientResponse" } } } } } }, "delete": { "operationId": "DELETE/coupon_recipients/couponRecipientId", "summary": "Delete a coupon recipient", "description": "Delete a coupon recipient", "tags": [ "coupon_recipients" ], "parameters": [ { "name": "couponRecipientId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/coupon_recipients/{couponRecipientId}/customer": { "get": { "operationId": "GET/couponRecipientId/customer", "summary": "Retrieve the customer associated to the coupon recipient", "description": "Retrieve the customer associated to the coupon recipient", "tags": [ "has_one", "customers" ], "parameters": [ { "name": "couponRecipientId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer associated to the coupon recipient" } } } }, "/coupon_recipients/{couponRecipientId}/event_stores": { "get": { "operationId": "GET/couponRecipientId/event_stores", "summary": "Retrieve the event stores associated to the coupon recipient", "description": "Retrieve the event stores associated to the coupon recipient", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "couponRecipientId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the coupon recipient" } } } }, "/coupon_recipients/{couponRecipientId}/attachments": { "get": { "operationId": "GET/couponRecipientId/attachments", "summary": "Retrieve the attachments associated to the coupon recipient", "description": "Retrieve the attachments associated to the coupon recipient", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "couponRecipientId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the coupon recipient" } } } }, "/coupons": { "get": { "operationId": "GET/coupons", "summary": "List all coupons", "description": "List all coupons", "tags": [ "coupons" ], "responses": { "200": { "description": "A list of coupon objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/couponResponseList" } } } } } }, "post": { "operationId": "POST/coupons", "summary": "Create a coupon", "description": "Create a coupon", "tags": [ "coupons" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/couponCreate" } } } }, "responses": { "201": { "description": "The created coupon object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/couponResponse" } } } } } } }, "/coupons/{couponId}": { "get": { "operationId": "GET/coupons/couponId", "summary": "Retrieve a coupon", "description": "Retrieve a coupon", "tags": [ "coupons" ], "parameters": [ { "name": "couponId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupon object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/couponResponse" } } } } } }, "patch": { "operationId": "PATCH/coupons/couponId", "summary": "Update a coupon", "description": "Update a coupon", "tags": [ "coupons" ], "parameters": [ { "name": "couponId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/couponUpdate" } } } }, "responses": { "200": { "description": "The updated coupon object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/couponResponse" } } } } } }, "delete": { "operationId": "DELETE/coupons/couponId", "summary": "Delete a coupon", "description": "Delete a coupon", "tags": [ "coupons" ], "parameters": [ { "name": "couponId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/coupons/{couponId}/promotion_rule": { "get": { "operationId": "GET/couponId/promotion_rule", "summary": "Retrieve the promotion rule associated to the coupon", "description": "Retrieve the promotion rule associated to the coupon", "tags": [ "has_one", "coupon_codes_promotion_rules" ], "parameters": [ { "name": "couponId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The promotion_rule associated to the coupon" } } } }, "/coupons/{couponId}/coupon_recipient": { "get": { "operationId": "GET/couponId/coupon_recipient", "summary": "Retrieve the coupon recipient associated to the coupon", "description": "Retrieve the coupon recipient associated to the coupon", "tags": [ "has_one", "coupon_recipients" ], "parameters": [ { "name": "couponId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupon_recipient associated to the coupon" } } } }, "/coupons/{couponId}/events": { "get": { "operationId": "GET/couponId/events", "summary": "Retrieve the events associated to the coupon", "description": "Retrieve the events associated to the coupon", "tags": [ "has_many", "events" ], "parameters": [ { "name": "couponId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the coupon" } } } }, "/coupons/{couponId}/tags": { "get": { "operationId": "GET/couponId/tags", "summary": "Retrieve the tags associated to the coupon", "description": "Retrieve the tags associated to the coupon", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "couponId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the coupon" } } } }, "/coupons/{couponId}/event_stores": { "get": { "operationId": "GET/couponId/event_stores", "summary": "Retrieve the event stores associated to the coupon", "description": "Retrieve the event stores associated to the coupon", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "couponId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the coupon" } } } }, "/custom_promotion_rules": { "get": { "operationId": "GET/custom_promotion_rules", "summary": "List all custom promotion rules", "description": "List all custom promotion rules", "tags": [ "custom_promotion_rules" ], "responses": { "200": { "description": "A list of custom promotion rule objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customPromotionRuleResponseList" } } } } } }, "post": { "operationId": "POST/custom_promotion_rules", "summary": "Create a custom promotion rule", "description": "Create a custom promotion rule", "tags": [ "custom_promotion_rules" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customPromotionRuleCreate" } } } }, "responses": { "201": { "description": "The created custom promotion rule object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customPromotionRuleResponse" } } } } } } }, "/custom_promotion_rules/{customPromotionRuleId}": { "get": { "operationId": "GET/custom_promotion_rules/customPromotionRuleId", "summary": "Retrieve a custom promotion rule", "description": "Retrieve a custom promotion rule", "tags": [ "custom_promotion_rules" ], "parameters": [ { "name": "customPromotionRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The custom promotion rule object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customPromotionRuleResponse" } } } } } }, "patch": { "operationId": "PATCH/custom_promotion_rules/customPromotionRuleId", "summary": "Update a custom promotion rule", "description": "Update a custom promotion rule", "tags": [ "custom_promotion_rules" ], "parameters": [ { "name": "customPromotionRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customPromotionRuleUpdate" } } } }, "responses": { "200": { "description": "The updated custom promotion rule object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customPromotionRuleResponse" } } } } } }, "delete": { "operationId": "DELETE/custom_promotion_rules/customPromotionRuleId", "summary": "Delete a custom promotion rule", "description": "Delete a custom promotion rule", "tags": [ "custom_promotion_rules" ], "parameters": [ { "name": "customPromotionRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/custom_promotion_rules/{customPromotionRuleId}/event_stores": { "get": { "operationId": "GET/customPromotionRuleId/event_stores", "summary": "Retrieve the event stores associated to the custom promotion rule", "description": "Retrieve the event stores associated to the custom promotion rule", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "customPromotionRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the custom promotion rule" } } } }, "/customer_addresses": { "get": { "operationId": "GET/customer_addresses", "summary": "List all customer addresses", "description": "List all customer addresses", "tags": [ "customer_addresses" ], "responses": { "200": { "description": "A list of customer address objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerAddressResponseList" } } } } } }, "post": { "operationId": "POST/customer_addresses", "summary": "Create a customer address", "description": "Create a customer address", "tags": [ "customer_addresses" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerAddressCreate" } } } }, "responses": { "201": { "description": "The created customer address object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerAddressResponse" } } } } } } }, "/customer_addresses/{customerAddressId}": { "get": { "operationId": "GET/customer_addresses/customerAddressId", "summary": "Retrieve a customer address", "description": "Retrieve a customer address", "tags": [ "customer_addresses" ], "parameters": [ { "name": "customerAddressId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer address object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerAddressResponse" } } } } } }, "patch": { "operationId": "PATCH/customer_addresses/customerAddressId", "summary": "Update a customer address", "description": "Update a customer address", "tags": [ "customer_addresses" ], "parameters": [ { "name": "customerAddressId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerAddressUpdate" } } } }, "responses": { "200": { "description": "The updated customer address object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerAddressResponse" } } } } } }, "delete": { "operationId": "DELETE/customer_addresses/customerAddressId", "summary": "Delete a customer address", "description": "Delete a customer address", "tags": [ "customer_addresses" ], "parameters": [ { "name": "customerAddressId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/customer_addresses/{customerAddressId}/customer": { "get": { "operationId": "GET/customerAddressId/customer", "summary": "Retrieve the customer associated to the customer address", "description": "Retrieve the customer associated to the customer address", "tags": [ "has_one", "customers" ], "parameters": [ { "name": "customerAddressId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer associated to the customer address" } } } }, "/customer_addresses/{customerAddressId}/address": { "get": { "operationId": "GET/customerAddressId/address", "summary": "Retrieve the address associated to the customer address", "description": "Retrieve the address associated to the customer address", "tags": [ "has_one", "addresses" ], "parameters": [ { "name": "customerAddressId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The address associated to the customer address" } } } }, "/customer_addresses/{customerAddressId}/events": { "get": { "operationId": "GET/customerAddressId/events", "summary": "Retrieve the events associated to the customer address", "description": "Retrieve the events associated to the customer address", "tags": [ "has_many", "events" ], "parameters": [ { "name": "customerAddressId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the customer address" } } } }, "/customer_addresses/{customerAddressId}/event_stores": { "get": { "operationId": "GET/customerAddressId/event_stores", "summary": "Retrieve the event stores associated to the customer address", "description": "Retrieve the event stores associated to the customer address", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "customerAddressId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the customer address" } } } }, "/customer_groups": { "get": { "operationId": "GET/customer_groups", "summary": "List all customer groups", "description": "List all customer groups", "tags": [ "customer_groups" ], "responses": { "200": { "description": "A list of customer group objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerGroupResponseList" } } } } } }, "post": { "operationId": "POST/customer_groups", "summary": "Create a customer group", "description": "Create a customer group", "tags": [ "customer_groups" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerGroupCreate" } } } }, "responses": { "201": { "description": "The created customer group object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerGroupResponse" } } } } } } }, "/customer_groups/{customerGroupId}": { "get": { "operationId": "GET/customer_groups/customerGroupId", "summary": "Retrieve a customer group", "description": "Retrieve a customer group", "tags": [ "customer_groups" ], "parameters": [ { "name": "customerGroupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer group object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerGroupResponse" } } } } } }, "patch": { "operationId": "PATCH/customer_groups/customerGroupId", "summary": "Update a customer group", "description": "Update a customer group", "tags": [ "customer_groups" ], "parameters": [ { "name": "customerGroupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerGroupUpdate" } } } }, "responses": { "200": { "description": "The updated customer group object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerGroupResponse" } } } } } }, "delete": { "operationId": "DELETE/customer_groups/customerGroupId", "summary": "Delete a customer group", "description": "Delete a customer group", "tags": [ "customer_groups" ], "parameters": [ { "name": "customerGroupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/customer_groups/{customerGroupId}/customers": { "get": { "operationId": "GET/customerGroupId/customers", "summary": "Retrieve the customers associated to the customer group", "description": "Retrieve the customers associated to the customer group", "tags": [ "has_many", "customers" ], "parameters": [ { "name": "customerGroupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customers associated to the customer group" } } } }, "/customer_groups/{customerGroupId}/markets": { "get": { "operationId": "GET/customerGroupId/markets", "summary": "Retrieve the markets associated to the customer group", "description": "Retrieve the markets associated to the customer group", "tags": [ "has_many", "markets" ], "parameters": [ { "name": "customerGroupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The markets associated to the customer group" } } } }, "/customer_groups/{customerGroupId}/attachments": { "get": { "operationId": "GET/customerGroupId/attachments", "summary": "Retrieve the attachments associated to the customer group", "description": "Retrieve the attachments associated to the customer group", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "customerGroupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the customer group" } } } }, "/customer_groups/{customerGroupId}/event_stores": { "get": { "operationId": "GET/customerGroupId/event_stores", "summary": "Retrieve the event stores associated to the customer group", "description": "Retrieve the event stores associated to the customer group", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "customerGroupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the customer group" } } } }, "/customer_password_resets": { "get": { "operationId": "GET/customer_password_resets", "summary": "List all customer password resets", "description": "List all customer password resets", "tags": [ "customer_password_resets" ], "responses": { "200": { "description": "A list of customer password reset objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerPasswordResetResponseList" } } } } } }, "post": { "operationId": "POST/customer_password_resets", "summary": "Create a customer password reset", "description": "Create a customer password reset", "tags": [ "customer_password_resets" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerPasswordResetCreate" } } } }, "responses": { "201": { "description": "The created customer password reset object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerPasswordResetResponse" } } } } } } }, "/customer_password_resets/{customerPasswordResetId}": { "get": { "operationId": "GET/customer_password_resets/customerPasswordResetId", "summary": "Retrieve a customer password reset", "description": "Retrieve a customer password reset", "tags": [ "customer_password_resets" ], "parameters": [ { "name": "customerPasswordResetId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer password reset object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerPasswordResetResponse" } } } } } }, "patch": { "operationId": "PATCH/customer_password_resets/customerPasswordResetId", "summary": "Update a customer password reset", "description": "Update a customer password reset", "tags": [ "customer_password_resets" ], "parameters": [ { "name": "customerPasswordResetId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerPasswordResetUpdate" } } } }, "responses": { "200": { "description": "The updated customer password reset object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerPasswordResetResponse" } } } } } }, "delete": { "operationId": "DELETE/customer_password_resets/customerPasswordResetId", "summary": "Delete a customer password reset", "description": "Delete a customer password reset", "tags": [ "customer_password_resets" ], "parameters": [ { "name": "customerPasswordResetId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/customer_password_resets/{customerPasswordResetId}/customer": { "get": { "operationId": "GET/customerPasswordResetId/customer", "summary": "Retrieve the customer associated to the customer password reset", "description": "Retrieve the customer associated to the customer password reset", "tags": [ "has_one", "customers" ], "parameters": [ { "name": "customerPasswordResetId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer associated to the customer password reset" } } } }, "/customer_password_resets/{customerPasswordResetId}/events": { "get": { "operationId": "GET/customerPasswordResetId/events", "summary": "Retrieve the events associated to the customer password reset", "description": "Retrieve the events associated to the customer password reset", "tags": [ "has_many", "events" ], "parameters": [ { "name": "customerPasswordResetId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the customer password reset" } } } }, "/customer_password_resets/{customerPasswordResetId}/event_stores": { "get": { "operationId": "GET/customerPasswordResetId/event_stores", "summary": "Retrieve the event stores associated to the customer password reset", "description": "Retrieve the event stores associated to the customer password reset", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "customerPasswordResetId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the customer password reset" } } } }, "/customer_payment_sources": { "get": { "operationId": "GET/customer_payment_sources", "summary": "List all customer payment sources", "description": "List all customer payment sources", "tags": [ "customer_payment_sources" ], "responses": { "200": { "description": "A list of customer payment source objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerPaymentSourceResponseList" } } } } } }, "post": { "operationId": "POST/customer_payment_sources", "summary": "Create a customer payment source", "description": "Create a customer payment source", "tags": [ "customer_payment_sources" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerPaymentSourceCreate" } } } }, "responses": { "201": { "description": "The created customer payment source object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerPaymentSourceResponse" } } } } } } }, "/customer_payment_sources/{customerPaymentSourceId}": { "get": { "operationId": "GET/customer_payment_sources/customerPaymentSourceId", "summary": "Retrieve a customer payment source", "description": "Retrieve a customer payment source", "tags": [ "customer_payment_sources" ], "parameters": [ { "name": "customerPaymentSourceId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer payment source object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerPaymentSourceResponse" } } } } } }, "patch": { "operationId": "PATCH/customer_payment_sources/customerPaymentSourceId", "summary": "Update a customer payment source", "description": "Update a customer payment source", "tags": [ "customer_payment_sources" ], "parameters": [ { "name": "customerPaymentSourceId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerPaymentSourceUpdate" } } } }, "responses": { "200": { "description": "The updated customer payment source object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerPaymentSourceResponse" } } } } } }, "delete": { "operationId": "DELETE/customer_payment_sources/customerPaymentSourceId", "summary": "Delete a customer payment source", "description": "Delete a customer payment source", "tags": [ "customer_payment_sources" ], "parameters": [ { "name": "customerPaymentSourceId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/customer_payment_sources/{customerPaymentSourceId}/customer": { "get": { "operationId": "GET/customerPaymentSourceId/customer", "summary": "Retrieve the customer associated to the customer payment source", "description": "Retrieve the customer associated to the customer payment source", "tags": [ "has_one", "customers" ], "parameters": [ { "name": "customerPaymentSourceId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer associated to the customer payment source" } } } }, "/customer_payment_sources/{customerPaymentSourceId}/payment_method": { "get": { "operationId": "GET/customerPaymentSourceId/payment_method", "summary": "Retrieve the payment method associated to the customer payment source", "description": "Retrieve the payment method associated to the customer payment source", "tags": [ "has_one", "payment_methods" ], "parameters": [ { "name": "customerPaymentSourceId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_method associated to the customer payment source" } } } }, "/customer_payment_sources/{customerPaymentSourceId}/event_stores": { "get": { "operationId": "GET/customerPaymentSourceId/event_stores", "summary": "Retrieve the event stores associated to the customer payment source", "description": "Retrieve the event stores associated to the customer payment source", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "customerPaymentSourceId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the customer payment source" } } } }, "/customer_subscriptions": { "get": { "operationId": "GET/customer_subscriptions", "summary": "List all customer subscriptions", "description": "List all customer subscriptions", "tags": [ "customer_subscriptions" ], "responses": { "200": { "description": "A list of customer subscription objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerSubscriptionResponseList" } } } } } }, "post": { "operationId": "POST/customer_subscriptions", "summary": "Create a customer subscription", "description": "Create a customer subscription", "tags": [ "customer_subscriptions" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerSubscriptionCreate" } } } }, "responses": { "201": { "description": "The created customer subscription object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerSubscriptionResponse" } } } } } } }, "/customer_subscriptions/{customerSubscriptionId}": { "get": { "operationId": "GET/customer_subscriptions/customerSubscriptionId", "summary": "Retrieve a customer subscription", "description": "Retrieve a customer subscription", "tags": [ "customer_subscriptions" ], "parameters": [ { "name": "customerSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer subscription object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerSubscriptionResponse" } } } } } }, "patch": { "operationId": "PATCH/customer_subscriptions/customerSubscriptionId", "summary": "Update a customer subscription", "description": "Update a customer subscription", "tags": [ "customer_subscriptions" ], "parameters": [ { "name": "customerSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerSubscriptionUpdate" } } } }, "responses": { "200": { "description": "The updated customer subscription object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerSubscriptionResponse" } } } } } }, "delete": { "operationId": "DELETE/customer_subscriptions/customerSubscriptionId", "summary": "Delete a customer subscription", "description": "Delete a customer subscription", "tags": [ "customer_subscriptions" ], "parameters": [ { "name": "customerSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/customer_subscriptions/{customerSubscriptionId}/customer": { "get": { "operationId": "GET/customerSubscriptionId/customer", "summary": "Retrieve the customer associated to the customer subscription", "description": "Retrieve the customer associated to the customer subscription", "tags": [ "has_one", "customers" ], "parameters": [ { "name": "customerSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer associated to the customer subscription" } } } }, "/customer_subscriptions/{customerSubscriptionId}/events": { "get": { "operationId": "GET/customerSubscriptionId/events", "summary": "Retrieve the events associated to the customer subscription", "description": "Retrieve the events associated to the customer subscription", "tags": [ "has_many", "events" ], "parameters": [ { "name": "customerSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the customer subscription" } } } }, "/customer_subscriptions/{customerSubscriptionId}/event_stores": { "get": { "operationId": "GET/customerSubscriptionId/event_stores", "summary": "Retrieve the event stores associated to the customer subscription", "description": "Retrieve the event stores associated to the customer subscription", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "customerSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the customer subscription" } } } }, "/customers": { "get": { "operationId": "GET/customers", "summary": "List all customers", "description": "List all customers", "tags": [ "customers" ], "responses": { "200": { "description": "A list of customer objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerResponseList" } } } } } }, "post": { "operationId": "POST/customers", "summary": "Create a customer", "description": "Create a customer", "tags": [ "customers" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerCreate" } } } }, "responses": { "201": { "description": "The created customer object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerResponse" } } } } } } }, "/customers/{customerId}": { "get": { "operationId": "GET/customers/customerId", "summary": "Retrieve a customer", "description": "Retrieve a customer", "tags": [ "customers" ], "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerResponse" } } } } } }, "patch": { "operationId": "PATCH/customers/customerId", "summary": "Update a customer", "description": "Update a customer", "tags": [ "customers" ], "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerUpdate" } } } }, "responses": { "200": { "description": "The updated customer object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/customerResponse" } } } } } }, "delete": { "operationId": "DELETE/customers/customerId", "summary": "Delete a customer", "description": "Delete a customer", "tags": [ "customers" ], "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/customers/{customerId}/customer_group": { "get": { "operationId": "GET/customerId/customer_group", "summary": "Retrieve the customer group associated to the customer", "description": "Retrieve the customer group associated to the customer", "tags": [ "has_one", "customer_groups" ], "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer_group associated to the customer" } } } }, "/customers/{customerId}/customer_addresses": { "get": { "operationId": "GET/customerId/customer_addresses", "summary": "Retrieve the customer addresses associated to the customer", "description": "Retrieve the customer addresses associated to the customer", "tags": [ "has_many", "customer_addresses" ], "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer_addresses associated to the customer" } } } }, "/customers/{customerId}/customer_payment_sources": { "get": { "operationId": "GET/customerId/customer_payment_sources", "summary": "Retrieve the customer payment sources associated to the customer", "description": "Retrieve the customer payment sources associated to the customer", "tags": [ "has_many", "customer_payment_sources" ], "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer_payment_sources associated to the customer" } } } }, "/customers/{customerId}/customer_subscriptions": { "get": { "operationId": "GET/customerId/customer_subscriptions", "summary": "Retrieve the customer subscriptions associated to the customer", "description": "Retrieve the customer subscriptions associated to the customer", "tags": [ "has_many", "customer_subscriptions" ], "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer_subscriptions associated to the customer" } } } }, "/customers/{customerId}/orders": { "get": { "operationId": "GET/customerId/orders", "summary": "Retrieve the orders associated to the customer", "description": "Retrieve the orders associated to the customer", "tags": [ "has_many", "orders" ], "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The orders associated to the customer" } } } }, "/customers/{customerId}/order_subscriptions": { "get": { "operationId": "GET/customerId/order_subscriptions", "summary": "Retrieve the order subscriptions associated to the customer", "description": "Retrieve the order subscriptions associated to the customer", "tags": [ "has_many", "order_subscriptions" ], "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order_subscriptions associated to the customer" } } } }, "/customers/{customerId}/returns": { "get": { "operationId": "GET/customerId/returns", "summary": "Retrieve the returns associated to the customer", "description": "Retrieve the returns associated to the customer", "tags": [ "has_many", "returns" ], "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The returns associated to the customer" } } } }, "/customers/{customerId}/sku_lists": { "get": { "operationId": "GET/customerId/sku_lists", "summary": "Retrieve the sku lists associated to the customer", "description": "Retrieve the sku lists associated to the customer", "tags": [ "has_many", "sku_lists" ], "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_lists associated to the customer" } } } }, "/customers/{customerId}/attachments": { "get": { "operationId": "GET/customerId/attachments", "summary": "Retrieve the attachments associated to the customer", "description": "Retrieve the attachments associated to the customer", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the customer" } } } }, "/customers/{customerId}/events": { "get": { "operationId": "GET/customerId/events", "summary": "Retrieve the events associated to the customer", "description": "Retrieve the events associated to the customer", "tags": [ "has_many", "events" ], "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the customer" } } } }, "/customers/{customerId}/tags": { "get": { "operationId": "GET/customerId/tags", "summary": "Retrieve the tags associated to the customer", "description": "Retrieve the tags associated to the customer", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the customer" } } } }, "/customers/{customerId}/jwt_customer": { "get": { "operationId": "GET/customerId/jwt_customer", "summary": "Retrieve the jwt customer associated to the customer", "description": "Retrieve the jwt customer associated to the customer", "tags": [ "has_one", "customers" ], "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The jwt_customer associated to the customer" } } } }, "/customers/{customerId}/jwt_markets": { "get": { "operationId": "GET/customerId/jwt_markets", "summary": "Retrieve the jwt markets associated to the customer", "description": "Retrieve the jwt markets associated to the customer", "tags": [ "has_many", "markets" ], "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The jwt_markets associated to the customer" } } } }, "/customers/{customerId}/jwt_stock_locations": { "get": { "operationId": "GET/customerId/jwt_stock_locations", "summary": "Retrieve the jwt stock locations associated to the customer", "description": "Retrieve the jwt stock locations associated to the customer", "tags": [ "has_many", "stock_locations" ], "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The jwt_stock_locations associated to the customer" } } } }, "/customers/{customerId}/event_stores": { "get": { "operationId": "GET/customerId/event_stores", "summary": "Retrieve the event stores associated to the customer", "description": "Retrieve the event stores associated to the customer", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "customerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the customer" } } } }, "/delivery_lead_times": { "get": { "operationId": "GET/delivery_lead_times", "summary": "List all delivery lead times", "description": "List all delivery lead times", "tags": [ "delivery_lead_times" ], "responses": { "200": { "description": "A list of delivery lead time objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/deliveryLeadTimeResponseList" } } } } } }, "post": { "operationId": "POST/delivery_lead_times", "summary": "Create a delivery lead time", "description": "Create a delivery lead time", "tags": [ "delivery_lead_times" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/deliveryLeadTimeCreate" } } } }, "responses": { "201": { "description": "The created delivery lead time object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/deliveryLeadTimeResponse" } } } } } } }, "/delivery_lead_times/{deliveryLeadTimeId}": { "get": { "operationId": "GET/delivery_lead_times/deliveryLeadTimeId", "summary": "Retrieve a delivery lead time", "description": "Retrieve a delivery lead time", "tags": [ "delivery_lead_times" ], "parameters": [ { "name": "deliveryLeadTimeId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The delivery lead time object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/deliveryLeadTimeResponse" } } } } } }, "patch": { "operationId": "PATCH/delivery_lead_times/deliveryLeadTimeId", "summary": "Update a delivery lead time", "description": "Update a delivery lead time", "tags": [ "delivery_lead_times" ], "parameters": [ { "name": "deliveryLeadTimeId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/deliveryLeadTimeUpdate" } } } }, "responses": { "200": { "description": "The updated delivery lead time object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/deliveryLeadTimeResponse" } } } } } }, "delete": { "operationId": "DELETE/delivery_lead_times/deliveryLeadTimeId", "summary": "Delete a delivery lead time", "description": "Delete a delivery lead time", "tags": [ "delivery_lead_times" ], "parameters": [ { "name": "deliveryLeadTimeId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/delivery_lead_times/{deliveryLeadTimeId}/stock_location": { "get": { "operationId": "GET/deliveryLeadTimeId/stock_location", "summary": "Retrieve the stock location associated to the delivery lead time", "description": "Retrieve the stock location associated to the delivery lead time", "tags": [ "has_one", "stock_locations" ], "parameters": [ { "name": "deliveryLeadTimeId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_location associated to the delivery lead time" } } } }, "/delivery_lead_times/{deliveryLeadTimeId}/shipping_method": { "get": { "operationId": "GET/deliveryLeadTimeId/shipping_method", "summary": "Retrieve the shipping method associated to the delivery lead time", "description": "Retrieve the shipping method associated to the delivery lead time", "tags": [ "has_one", "shipping_methods" ], "parameters": [ { "name": "deliveryLeadTimeId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipping_method associated to the delivery lead time" } } } }, "/delivery_lead_times/{deliveryLeadTimeId}/attachments": { "get": { "operationId": "GET/deliveryLeadTimeId/attachments", "summary": "Retrieve the attachments associated to the delivery lead time", "description": "Retrieve the attachments associated to the delivery lead time", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "deliveryLeadTimeId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the delivery lead time" } } } }, "/delivery_lead_times/{deliveryLeadTimeId}/event_stores": { "get": { "operationId": "GET/deliveryLeadTimeId/event_stores", "summary": "Retrieve the event stores associated to the delivery lead time", "description": "Retrieve the event stores associated to the delivery lead time", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "deliveryLeadTimeId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the delivery lead time" } } } }, "/discount_engine_items": { "get": { "operationId": "GET/discount_engine_items", "summary": "List all discount engine items", "description": "List all discount engine items", "tags": [ "discount_engine_items" ], "responses": { "200": { "description": "A list of discount engine item objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/discountEngineItemResponseList" } } } } } } }, "/discount_engine_items/{discountEngineItemId}": { "get": { "operationId": "GET/discount_engine_items/discountEngineItemId", "summary": "Retrieve a discount engine item", "description": "Retrieve a discount engine item", "tags": [ "discount_engine_items" ], "parameters": [ { "name": "discountEngineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The discount engine item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/discountEngineItemResponse" } } } } } } }, "/discount_engine_items/{discountEngineItemId}/discount_engine": { "get": { "operationId": "GET/discountEngineItemId/discount_engine", "summary": "Retrieve the discount engine associated to the discount engine item", "description": "Retrieve the discount engine associated to the discount engine item", "tags": [ "has_one", "discount_engines" ], "parameters": [ { "name": "discountEngineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The discount_engine associated to the discount engine item" } } } }, "/discount_engine_items/{discountEngineItemId}/order": { "get": { "operationId": "GET/discountEngineItemId/order", "summary": "Retrieve the order associated to the discount engine item", "description": "Retrieve the order associated to the discount engine item", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "discountEngineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order associated to the discount engine item" } } } }, "/discount_engine_items/{discountEngineItemId}/event_stores": { "get": { "operationId": "GET/discountEngineItemId/event_stores", "summary": "Retrieve the event stores associated to the discount engine item", "description": "Retrieve the event stores associated to the discount engine item", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "discountEngineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the discount engine item" } } } }, "/discount_engines": { "get": { "operationId": "GET/discount_engines", "summary": "List all discount engines", "description": "List all discount engines", "tags": [ "discount_engines" ], "responses": { "200": { "description": "A list of discount engine objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/discountEngineResponseList" } } } } } } }, "/discount_engines/{discountEngineId}": { "get": { "operationId": "GET/discount_engines/discountEngineId", "summary": "Retrieve a discount engine", "description": "Retrieve a discount engine", "tags": [ "discount_engines" ], "parameters": [ { "name": "discountEngineId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The discount engine object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/discountEngineResponse" } } } } } } }, "/discount_engines/{discountEngineId}/markets": { "get": { "operationId": "GET/discountEngineId/markets", "summary": "Retrieve the markets associated to the discount engine", "description": "Retrieve the markets associated to the discount engine", "tags": [ "has_many", "markets" ], "parameters": [ { "name": "discountEngineId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The markets associated to the discount engine" } } } }, "/discount_engines/{discountEngineId}/discount_engine_items": { "get": { "operationId": "GET/discountEngineId/discount_engine_items", "summary": "Retrieve the discount engine items associated to the discount engine", "description": "Retrieve the discount engine items associated to the discount engine", "tags": [ "has_many", "discount_engine_items" ], "parameters": [ { "name": "discountEngineId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The discount_engine_items associated to the discount engine" } } } }, "/discount_engines/{discountEngineId}/attachments": { "get": { "operationId": "GET/discountEngineId/attachments", "summary": "Retrieve the attachments associated to the discount engine", "description": "Retrieve the attachments associated to the discount engine", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "discountEngineId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the discount engine" } } } }, "/discount_engines/{discountEngineId}/event_stores": { "get": { "operationId": "GET/discountEngineId/event_stores", "summary": "Retrieve the event stores associated to the discount engine", "description": "Retrieve the event stores associated to the discount engine", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "discountEngineId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the discount engine" } } } }, "/easypost_pickups": { "get": { "operationId": "GET/easypost_pickups", "summary": "List all easypost pickups", "description": "List all easypost pickups", "tags": [ "easypost_pickups" ], "responses": { "200": { "description": "A list of easypost pickup objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/easypostPickupResponseList" } } } } } }, "post": { "operationId": "POST/easypost_pickups", "summary": "Create an easypost pickup", "description": "Create an easypost pickup", "tags": [ "easypost_pickups" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/easypostPickupCreate" } } } }, "responses": { "201": { "description": "The created easypost pickup object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/easypostPickupResponse" } } } } } } }, "/easypost_pickups/{easypostPickupId}": { "get": { "operationId": "GET/easypost_pickups/easypostPickupId", "summary": "Retrieve an easypost pickup", "description": "Retrieve an easypost pickup", "tags": [ "easypost_pickups" ], "parameters": [ { "name": "easypostPickupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The easypost pickup object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/easypostPickupResponse" } } } } } }, "patch": { "operationId": "PATCH/easypost_pickups/easypostPickupId", "summary": "Update an easypost pickup", "description": "Update an easypost pickup", "tags": [ "easypost_pickups" ], "parameters": [ { "name": "easypostPickupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/easypostPickupUpdate" } } } }, "responses": { "200": { "description": "The updated easypost pickup object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/easypostPickupResponse" } } } } } }, "delete": { "operationId": "DELETE/easypost_pickups/easypostPickupId", "summary": "Delete an easypost pickup", "description": "Delete an easypost pickup", "tags": [ "easypost_pickups" ], "parameters": [ { "name": "easypostPickupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/easypost_pickups/{easypostPickupId}/shipment": { "get": { "operationId": "GET/easypostPickupId/shipment", "summary": "Retrieve the shipment associated to the easypost pickup", "description": "Retrieve the shipment associated to the easypost pickup", "tags": [ "has_one", "shipments" ], "parameters": [ { "name": "easypostPickupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipment associated to the easypost pickup" } } } }, "/easypost_pickups/{easypostPickupId}/parcels": { "get": { "operationId": "GET/easypostPickupId/parcels", "summary": "Retrieve the parcels associated to the easypost pickup", "description": "Retrieve the parcels associated to the easypost pickup", "tags": [ "has_many", "parcels" ], "parameters": [ { "name": "easypostPickupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The parcels associated to the easypost pickup" } } } }, "/easypost_pickups/{easypostPickupId}/events": { "get": { "operationId": "GET/easypostPickupId/events", "summary": "Retrieve the events associated to the easypost pickup", "description": "Retrieve the events associated to the easypost pickup", "tags": [ "has_many", "events" ], "parameters": [ { "name": "easypostPickupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the easypost pickup" } } } }, "/easypost_pickups/{easypostPickupId}/event_stores": { "get": { "operationId": "GET/easypostPickupId/event_stores", "summary": "Retrieve the event stores associated to the easypost pickup", "description": "Retrieve the event stores associated to the easypost pickup", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "easypostPickupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the easypost pickup" } } } }, "/event_callbacks": { "get": { "operationId": "GET/event_callbacks", "summary": "List all event callbacks", "description": "List all event callbacks", "tags": [ "event_callbacks" ], "responses": { "200": { "description": "A list of event callback objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/eventCallbackResponseList" } } } } } } }, "/event_callbacks/{eventCallbackId}": { "get": { "operationId": "GET/event_callbacks/eventCallbackId", "summary": "Retrieve an event callback", "description": "Retrieve an event callback", "tags": [ "event_callbacks" ], "parameters": [ { "name": "eventCallbackId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event callback object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/eventCallbackResponse" } } } } } } }, "/event_callbacks/{eventCallbackId}/webhook": { "get": { "operationId": "GET/eventCallbackId/webhook", "summary": "Retrieve the webhook associated to the event callback", "description": "Retrieve the webhook associated to the event callback", "tags": [ "has_one", "webhooks" ], "parameters": [ { "name": "eventCallbackId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The webhook associated to the event callback" } } } }, "/event_callbacks/{eventCallbackId}/event_stores": { "get": { "operationId": "GET/eventCallbackId/event_stores", "summary": "Retrieve the event stores associated to the event callback", "description": "Retrieve the event stores associated to the event callback", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "eventCallbackId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the event callback" } } } }, "/event_stores/{eventStoreId}": { "get": { "operationId": "GET/event_stores/eventStoreId", "summary": "Retrieve an event store", "description": "Retrieve an event store", "tags": [ "event_stores" ], "parameters": [ { "name": "eventStoreId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event store object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/eventStoreResponse" } } } } } } }, "/events": { "get": { "operationId": "GET/events", "summary": "List all events", "description": "List all events", "tags": [ "events" ], "responses": { "200": { "description": "A list of event objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/eventResponseList" } } } } } } }, "/events/{eventId}": { "get": { "operationId": "GET/events/eventId", "summary": "Retrieve an event", "description": "Retrieve an event", "tags": [ "events" ], "parameters": [ { "name": "eventId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/eventResponse" } } } } } }, "patch": { "operationId": "PATCH/events/eventId", "summary": "Update an event", "description": "Update an event", "tags": [ "events" ], "parameters": [ { "name": "eventId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/eventUpdate" } } } }, "responses": { "200": { "description": "The updated event object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/eventResponse" } } } } } } }, "/events/{eventId}/webhooks": { "get": { "operationId": "GET/eventId/webhooks", "summary": "Retrieve the webhooks associated to the event", "description": "Retrieve the webhooks associated to the event", "tags": [ "has_many", "webhooks" ], "parameters": [ { "name": "eventId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The webhooks associated to the event" } } } }, "/events/{eventId}/last_event_callbacks": { "get": { "operationId": "GET/eventId/last_event_callbacks", "summary": "Retrieve the last event callbacks associated to the event", "description": "Retrieve the last event callbacks associated to the event", "tags": [ "has_many", "event_callbacks" ], "parameters": [ { "name": "eventId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The last_event_callbacks associated to the event" } } } }, "/events/{eventId}/event_stores": { "get": { "operationId": "GET/eventId/event_stores", "summary": "Retrieve the event stores associated to the event", "description": "Retrieve the event stores associated to the event", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "eventId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the event" } } } }, "/exports": { "get": { "operationId": "GET/exports", "summary": "List all exports", "description": "List all exports", "tags": [ "exports" ], "responses": { "200": { "description": "A list of export objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/exportResponseList" } } } } } }, "post": { "operationId": "POST/exports", "summary": "Create an export", "description": "Create an export", "tags": [ "exports" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/exportCreate" } } } }, "responses": { "201": { "description": "The created export object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/exportResponse" } } } } } } }, "/exports/{exportId}": { "get": { "operationId": "GET/exports/exportId", "summary": "Retrieve an export", "description": "Retrieve an export", "tags": [ "exports" ], "parameters": [ { "name": "exportId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The export object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/exportResponse" } } } } } }, "patch": { "operationId": "PATCH/exports/exportId", "summary": "Update an export", "description": "Update an export", "tags": [ "exports" ], "parameters": [ { "name": "exportId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/exportUpdate" } } } }, "responses": { "200": { "description": "The updated export object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/exportResponse" } } } } } }, "delete": { "operationId": "DELETE/exports/exportId", "summary": "Delete an export", "description": "Delete an export", "tags": [ "exports" ], "parameters": [ { "name": "exportId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/exports/{exportId}/events": { "get": { "operationId": "GET/exportId/events", "summary": "Retrieve the events associated to the export", "description": "Retrieve the events associated to the export", "tags": [ "has_many", "events" ], "parameters": [ { "name": "exportId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the export" } } } }, "/exports/{exportId}/event_stores": { "get": { "operationId": "GET/exportId/event_stores", "summary": "Retrieve the event stores associated to the export", "description": "Retrieve the event stores associated to the export", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "exportId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the export" } } } }, "/external_gateways": { "get": { "operationId": "GET/external_gateways", "summary": "List all external gateways", "description": "List all external gateways", "tags": [ "external_gateways" ], "responses": { "200": { "description": "A list of external gateway objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalGatewayResponseList" } } } } } }, "post": { "operationId": "POST/external_gateways", "summary": "Create an external gateway", "description": "Create an external gateway", "tags": [ "external_gateways" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalGatewayCreate" } } } }, "responses": { "201": { "description": "The created external gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalGatewayResponse" } } } } } } }, "/external_gateways/{externalGatewayId}": { "get": { "operationId": "GET/external_gateways/externalGatewayId", "summary": "Retrieve an external gateway", "description": "Retrieve an external gateway", "tags": [ "external_gateways" ], "parameters": [ { "name": "externalGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The external gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalGatewayResponse" } } } } } }, "patch": { "operationId": "PATCH/external_gateways/externalGatewayId", "summary": "Update an external gateway", "description": "Update an external gateway", "tags": [ "external_gateways" ], "parameters": [ { "name": "externalGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalGatewayUpdate" } } } }, "responses": { "200": { "description": "The updated external gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalGatewayResponse" } } } } } }, "delete": { "operationId": "DELETE/external_gateways/externalGatewayId", "summary": "Delete an external gateway", "description": "Delete an external gateway", "tags": [ "external_gateways" ], "parameters": [ { "name": "externalGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/external_gateways/{externalGatewayId}/payment_methods": { "get": { "operationId": "GET/externalGatewayId/payment_methods", "summary": "Retrieve the payment methods associated to the external gateway", "description": "Retrieve the payment methods associated to the external gateway", "tags": [ "has_many", "payment_methods" ], "parameters": [ { "name": "externalGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_methods associated to the external gateway" } } } }, "/external_gateways/{externalGatewayId}/event_stores": { "get": { "operationId": "GET/externalGatewayId/event_stores", "summary": "Retrieve the event stores associated to the external gateway", "description": "Retrieve the event stores associated to the external gateway", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "externalGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the external gateway" } } } }, "/external_gateways/{externalGatewayId}/external_payments": { "get": { "operationId": "GET/externalGatewayId/external_payments", "summary": "Retrieve the external payments associated to the external gateway", "description": "Retrieve the external payments associated to the external gateway", "tags": [ "has_many", "external_payments" ], "parameters": [ { "name": "externalGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The external_payments associated to the external gateway" } } } }, "/external_payments": { "get": { "operationId": "GET/external_payments", "summary": "List all external payments", "description": "List all external payments", "tags": [ "external_payments" ], "responses": { "200": { "description": "A list of external payment objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalPaymentResponseList" } } } } } }, "post": { "operationId": "POST/external_payments", "summary": "Create an external payment", "description": "Create an external payment", "tags": [ "external_payments" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalPaymentCreate" } } } }, "responses": { "201": { "description": "The created external payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalPaymentResponse" } } } } } } }, "/external_payments/{externalPaymentId}": { "get": { "operationId": "GET/external_payments/externalPaymentId", "summary": "Retrieve an external payment", "description": "Retrieve an external payment", "tags": [ "external_payments" ], "parameters": [ { "name": "externalPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The external payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalPaymentResponse" } } } } } }, "patch": { "operationId": "PATCH/external_payments/externalPaymentId", "summary": "Update an external payment", "description": "Update an external payment", "tags": [ "external_payments" ], "parameters": [ { "name": "externalPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalPaymentUpdate" } } } }, "responses": { "200": { "description": "The updated external payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalPaymentResponse" } } } } } }, "delete": { "operationId": "DELETE/external_payments/externalPaymentId", "summary": "Delete an external payment", "description": "Delete an external payment", "tags": [ "external_payments" ], "parameters": [ { "name": "externalPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/external_payments/{externalPaymentId}/order": { "get": { "operationId": "GET/externalPaymentId/order", "summary": "Retrieve the order associated to the external payment", "description": "Retrieve the order associated to the external payment", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "externalPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order associated to the external payment" } } } }, "/external_payments/{externalPaymentId}/payment_gateway": { "get": { "operationId": "GET/externalPaymentId/payment_gateway", "summary": "Retrieve the payment gateway associated to the external payment", "description": "Retrieve the payment gateway associated to the external payment", "tags": [ "has_one", "payment_gateways" ], "parameters": [ { "name": "externalPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_gateway associated to the external payment" } } } }, "/external_payments/{externalPaymentId}/wallet": { "get": { "operationId": "GET/externalPaymentId/wallet", "summary": "Retrieve the wallet associated to the external payment", "description": "Retrieve the wallet associated to the external payment", "tags": [ "has_one", "customer_payment_sources" ], "parameters": [ { "name": "externalPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The wallet associated to the external payment" } } } }, "/external_payments/{externalPaymentId}/event_stores": { "get": { "operationId": "GET/externalPaymentId/event_stores", "summary": "Retrieve the event stores associated to the external payment", "description": "Retrieve the event stores associated to the external payment", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "externalPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the external payment" } } } }, "/external_promotions": { "get": { "operationId": "GET/external_promotions", "summary": "List all external promotions", "description": "List all external promotions", "tags": [ "external_promotions" ], "responses": { "200": { "description": "A list of external promotion objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalPromotionResponseList" } } } } } }, "post": { "operationId": "POST/external_promotions", "summary": "Create an external promotion", "description": "Create an external promotion", "tags": [ "external_promotions" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalPromotionCreate" } } } }, "responses": { "201": { "description": "The created external promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalPromotionResponse" } } } } } } }, "/external_promotions/{externalPromotionId}": { "get": { "operationId": "GET/external_promotions/externalPromotionId", "summary": "Retrieve an external promotion", "description": "Retrieve an external promotion", "tags": [ "external_promotions" ], "parameters": [ { "name": "externalPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The external promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalPromotionResponse" } } } } } }, "patch": { "operationId": "PATCH/external_promotions/externalPromotionId", "summary": "Update an external promotion", "description": "Update an external promotion", "tags": [ "external_promotions" ], "parameters": [ { "name": "externalPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalPromotionUpdate" } } } }, "responses": { "200": { "description": "The updated external promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalPromotionResponse" } } } } } }, "delete": { "operationId": "DELETE/external_promotions/externalPromotionId", "summary": "Delete an external promotion", "description": "Delete an external promotion", "tags": [ "external_promotions" ], "parameters": [ { "name": "externalPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/external_promotions/{externalPromotionId}/market": { "get": { "operationId": "GET/externalPromotionId/market", "summary": "Retrieve the market associated to the external promotion", "description": "Retrieve the market associated to the external promotion", "tags": [ "has_one", "markets" ], "parameters": [ { "name": "externalPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The market associated to the external promotion" } } } }, "/external_promotions/{externalPromotionId}/order_amount_promotion_rule": { "get": { "operationId": "GET/externalPromotionId/order_amount_promotion_rule", "summary": "Retrieve the order amount promotion rule associated to the external promotion", "description": "Retrieve the order amount promotion rule associated to the external promotion", "tags": [ "has_one", "order_amount_promotion_rules" ], "parameters": [ { "name": "externalPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order_amount_promotion_rule associated to the external promotion" } } } }, "/external_promotions/{externalPromotionId}/sku_list_promotion_rule": { "get": { "operationId": "GET/externalPromotionId/sku_list_promotion_rule", "summary": "Retrieve the sku list promotion rule associated to the external promotion", "description": "Retrieve the sku list promotion rule associated to the external promotion", "tags": [ "has_one", "sku_list_promotion_rules" ], "parameters": [ { "name": "externalPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_list_promotion_rule associated to the external promotion" } } } }, "/external_promotions/{externalPromotionId}/coupon_codes_promotion_rule": { "get": { "operationId": "GET/externalPromotionId/coupon_codes_promotion_rule", "summary": "Retrieve the coupon codes promotion rule associated to the external promotion", "description": "Retrieve the coupon codes promotion rule associated to the external promotion", "tags": [ "has_one", "coupon_codes_promotion_rules" ], "parameters": [ { "name": "externalPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupon_codes_promotion_rule associated to the external promotion" } } } }, "/external_promotions/{externalPromotionId}/custom_promotion_rule": { "get": { "operationId": "GET/externalPromotionId/custom_promotion_rule", "summary": "Retrieve the custom promotion rule associated to the external promotion", "description": "Retrieve the custom promotion rule associated to the external promotion", "tags": [ "has_one", "custom_promotion_rules" ], "parameters": [ { "name": "externalPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The custom_promotion_rule associated to the external promotion" } } } }, "/external_promotions/{externalPromotionId}/sku_list": { "get": { "operationId": "GET/externalPromotionId/sku_list", "summary": "Retrieve the sku list associated to the external promotion", "description": "Retrieve the sku list associated to the external promotion", "tags": [ "has_one", "sku_lists" ], "parameters": [ { "name": "externalPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_list associated to the external promotion" } } } }, "/external_promotions/{externalPromotionId}/coupons": { "get": { "operationId": "GET/externalPromotionId/coupons", "summary": "Retrieve the coupons associated to the external promotion", "description": "Retrieve the coupons associated to the external promotion", "tags": [ "has_many", "coupons" ], "parameters": [ { "name": "externalPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupons associated to the external promotion" } } } }, "/external_promotions/{externalPromotionId}/attachments": { "get": { "operationId": "GET/externalPromotionId/attachments", "summary": "Retrieve the attachments associated to the external promotion", "description": "Retrieve the attachments associated to the external promotion", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "externalPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the external promotion" } } } }, "/external_promotions/{externalPromotionId}/events": { "get": { "operationId": "GET/externalPromotionId/events", "summary": "Retrieve the events associated to the external promotion", "description": "Retrieve the events associated to the external promotion", "tags": [ "has_many", "events" ], "parameters": [ { "name": "externalPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the external promotion" } } } }, "/external_promotions/{externalPromotionId}/tags": { "get": { "operationId": "GET/externalPromotionId/tags", "summary": "Retrieve the tags associated to the external promotion", "description": "Retrieve the tags associated to the external promotion", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "externalPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the external promotion" } } } }, "/external_promotions/{externalPromotionId}/event_stores": { "get": { "operationId": "GET/externalPromotionId/event_stores", "summary": "Retrieve the event stores associated to the external promotion", "description": "Retrieve the event stores associated to the external promotion", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "externalPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the external promotion" } } } }, "/external_promotions/{externalPromotionId}/skus": { "get": { "operationId": "GET/externalPromotionId/skus", "summary": "Retrieve the skus associated to the external promotion", "description": "Retrieve the skus associated to the external promotion", "tags": [ "has_many", "skus" ], "parameters": [ { "name": "externalPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The skus associated to the external promotion" } } } }, "/external_tax_calculators": { "get": { "operationId": "GET/external_tax_calculators", "summary": "List all external tax calculators", "description": "List all external tax calculators", "tags": [ "external_tax_calculators" ], "responses": { "200": { "description": "A list of external tax calculator objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalTaxCalculatorResponseList" } } } } } }, "post": { "operationId": "POST/external_tax_calculators", "summary": "Create an external tax calculator", "description": "Create an external tax calculator", "tags": [ "external_tax_calculators" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalTaxCalculatorCreate" } } } }, "responses": { "201": { "description": "The created external tax calculator object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalTaxCalculatorResponse" } } } } } } }, "/external_tax_calculators/{externalTaxCalculatorId}": { "get": { "operationId": "GET/external_tax_calculators/externalTaxCalculatorId", "summary": "Retrieve an external tax calculator", "description": "Retrieve an external tax calculator", "tags": [ "external_tax_calculators" ], "parameters": [ { "name": "externalTaxCalculatorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The external tax calculator object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalTaxCalculatorResponse" } } } } } }, "patch": { "operationId": "PATCH/external_tax_calculators/externalTaxCalculatorId", "summary": "Update an external tax calculator", "description": "Update an external tax calculator", "tags": [ "external_tax_calculators" ], "parameters": [ { "name": "externalTaxCalculatorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalTaxCalculatorUpdate" } } } }, "responses": { "200": { "description": "The updated external tax calculator object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/externalTaxCalculatorResponse" } } } } } }, "delete": { "operationId": "DELETE/external_tax_calculators/externalTaxCalculatorId", "summary": "Delete an external tax calculator", "description": "Delete an external tax calculator", "tags": [ "external_tax_calculators" ], "parameters": [ { "name": "externalTaxCalculatorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/external_tax_calculators/{externalTaxCalculatorId}/markets": { "get": { "operationId": "GET/externalTaxCalculatorId/markets", "summary": "Retrieve the markets associated to the external tax calculator", "description": "Retrieve the markets associated to the external tax calculator", "tags": [ "has_many", "markets" ], "parameters": [ { "name": "externalTaxCalculatorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The markets associated to the external tax calculator" } } } }, "/external_tax_calculators/{externalTaxCalculatorId}/attachments": { "get": { "operationId": "GET/externalTaxCalculatorId/attachments", "summary": "Retrieve the attachments associated to the external tax calculator", "description": "Retrieve the attachments associated to the external tax calculator", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "externalTaxCalculatorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the external tax calculator" } } } }, "/external_tax_calculators/{externalTaxCalculatorId}/events": { "get": { "operationId": "GET/externalTaxCalculatorId/events", "summary": "Retrieve the events associated to the external tax calculator", "description": "Retrieve the events associated to the external tax calculator", "tags": [ "has_many", "events" ], "parameters": [ { "name": "externalTaxCalculatorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the external tax calculator" } } } }, "/external_tax_calculators/{externalTaxCalculatorId}/event_stores": { "get": { "operationId": "GET/externalTaxCalculatorId/event_stores", "summary": "Retrieve the event stores associated to the external tax calculator", "description": "Retrieve the event stores associated to the external tax calculator", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "externalTaxCalculatorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the external tax calculator" } } } }, "/fixed_amount_promotions": { "get": { "operationId": "GET/fixed_amount_promotions", "summary": "List all fixed amount promotions", "description": "List all fixed amount promotions", "tags": [ "fixed_amount_promotions" ], "responses": { "200": { "description": "A list of fixed amount promotion objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/fixedAmountPromotionResponseList" } } } } } }, "post": { "operationId": "POST/fixed_amount_promotions", "summary": "Create a fixed amount promotion", "description": "Create a fixed amount promotion", "tags": [ "fixed_amount_promotions" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/fixedAmountPromotionCreate" } } } }, "responses": { "201": { "description": "The created fixed amount promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/fixedAmountPromotionResponse" } } } } } } }, "/fixed_amount_promotions/{fixedAmountPromotionId}": { "get": { "operationId": "GET/fixed_amount_promotions/fixedAmountPromotionId", "summary": "Retrieve a fixed amount promotion", "description": "Retrieve a fixed amount promotion", "tags": [ "fixed_amount_promotions" ], "parameters": [ { "name": "fixedAmountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The fixed amount promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/fixedAmountPromotionResponse" } } } } } }, "patch": { "operationId": "PATCH/fixed_amount_promotions/fixedAmountPromotionId", "summary": "Update a fixed amount promotion", "description": "Update a fixed amount promotion", "tags": [ "fixed_amount_promotions" ], "parameters": [ { "name": "fixedAmountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/fixedAmountPromotionUpdate" } } } }, "responses": { "200": { "description": "The updated fixed amount promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/fixedAmountPromotionResponse" } } } } } }, "delete": { "operationId": "DELETE/fixed_amount_promotions/fixedAmountPromotionId", "summary": "Delete a fixed amount promotion", "description": "Delete a fixed amount promotion", "tags": [ "fixed_amount_promotions" ], "parameters": [ { "name": "fixedAmountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/fixed_amount_promotions/{fixedAmountPromotionId}/market": { "get": { "operationId": "GET/fixedAmountPromotionId/market", "summary": "Retrieve the market associated to the fixed amount promotion", "description": "Retrieve the market associated to the fixed amount promotion", "tags": [ "has_one", "markets" ], "parameters": [ { "name": "fixedAmountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The market associated to the fixed amount promotion" } } } }, "/fixed_amount_promotions/{fixedAmountPromotionId}/order_amount_promotion_rule": { "get": { "operationId": "GET/fixedAmountPromotionId/order_amount_promotion_rule", "summary": "Retrieve the order amount promotion rule associated to the fixed amount promotion", "description": "Retrieve the order amount promotion rule associated to the fixed amount promotion", "tags": [ "has_one", "order_amount_promotion_rules" ], "parameters": [ { "name": "fixedAmountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order_amount_promotion_rule associated to the fixed amount promotion" } } } }, "/fixed_amount_promotions/{fixedAmountPromotionId}/sku_list_promotion_rule": { "get": { "operationId": "GET/fixedAmountPromotionId/sku_list_promotion_rule", "summary": "Retrieve the sku list promotion rule associated to the fixed amount promotion", "description": "Retrieve the sku list promotion rule associated to the fixed amount promotion", "tags": [ "has_one", "sku_list_promotion_rules" ], "parameters": [ { "name": "fixedAmountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_list_promotion_rule associated to the fixed amount promotion" } } } }, "/fixed_amount_promotions/{fixedAmountPromotionId}/coupon_codes_promotion_rule": { "get": { "operationId": "GET/fixedAmountPromotionId/coupon_codes_promotion_rule", "summary": "Retrieve the coupon codes promotion rule associated to the fixed amount promotion", "description": "Retrieve the coupon codes promotion rule associated to the fixed amount promotion", "tags": [ "has_one", "coupon_codes_promotion_rules" ], "parameters": [ { "name": "fixedAmountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupon_codes_promotion_rule associated to the fixed amount promotion" } } } }, "/fixed_amount_promotions/{fixedAmountPromotionId}/custom_promotion_rule": { "get": { "operationId": "GET/fixedAmountPromotionId/custom_promotion_rule", "summary": "Retrieve the custom promotion rule associated to the fixed amount promotion", "description": "Retrieve the custom promotion rule associated to the fixed amount promotion", "tags": [ "has_one", "custom_promotion_rules" ], "parameters": [ { "name": "fixedAmountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The custom_promotion_rule associated to the fixed amount promotion" } } } }, "/fixed_amount_promotions/{fixedAmountPromotionId}/sku_list": { "get": { "operationId": "GET/fixedAmountPromotionId/sku_list", "summary": "Retrieve the sku list associated to the fixed amount promotion", "description": "Retrieve the sku list associated to the fixed amount promotion", "tags": [ "has_one", "sku_lists" ], "parameters": [ { "name": "fixedAmountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_list associated to the fixed amount promotion" } } } }, "/fixed_amount_promotions/{fixedAmountPromotionId}/coupons": { "get": { "operationId": "GET/fixedAmountPromotionId/coupons", "summary": "Retrieve the coupons associated to the fixed amount promotion", "description": "Retrieve the coupons associated to the fixed amount promotion", "tags": [ "has_many", "coupons" ], "parameters": [ { "name": "fixedAmountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupons associated to the fixed amount promotion" } } } }, "/fixed_amount_promotions/{fixedAmountPromotionId}/attachments": { "get": { "operationId": "GET/fixedAmountPromotionId/attachments", "summary": "Retrieve the attachments associated to the fixed amount promotion", "description": "Retrieve the attachments associated to the fixed amount promotion", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "fixedAmountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the fixed amount promotion" } } } }, "/fixed_amount_promotions/{fixedAmountPromotionId}/events": { "get": { "operationId": "GET/fixedAmountPromotionId/events", "summary": "Retrieve the events associated to the fixed amount promotion", "description": "Retrieve the events associated to the fixed amount promotion", "tags": [ "has_many", "events" ], "parameters": [ { "name": "fixedAmountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the fixed amount promotion" } } } }, "/fixed_amount_promotions/{fixedAmountPromotionId}/tags": { "get": { "operationId": "GET/fixedAmountPromotionId/tags", "summary": "Retrieve the tags associated to the fixed amount promotion", "description": "Retrieve the tags associated to the fixed amount promotion", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "fixedAmountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the fixed amount promotion" } } } }, "/fixed_amount_promotions/{fixedAmountPromotionId}/event_stores": { "get": { "operationId": "GET/fixedAmountPromotionId/event_stores", "summary": "Retrieve the event stores associated to the fixed amount promotion", "description": "Retrieve the event stores associated to the fixed amount promotion", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "fixedAmountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the fixed amount promotion" } } } }, "/fixed_amount_promotions/{fixedAmountPromotionId}/skus": { "get": { "operationId": "GET/fixedAmountPromotionId/skus", "summary": "Retrieve the skus associated to the fixed amount promotion", "description": "Retrieve the skus associated to the fixed amount promotion", "tags": [ "has_many", "skus" ], "parameters": [ { "name": "fixedAmountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The skus associated to the fixed amount promotion" } } } }, "/fixed_price_promotions": { "get": { "operationId": "GET/fixed_price_promotions", "summary": "List all fixed price promotions", "description": "List all fixed price promotions", "tags": [ "fixed_price_promotions" ], "responses": { "200": { "description": "A list of fixed price promotion objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/fixedPricePromotionResponseList" } } } } } }, "post": { "operationId": "POST/fixed_price_promotions", "summary": "Create a fixed price promotion", "description": "Create a fixed price promotion", "tags": [ "fixed_price_promotions" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/fixedPricePromotionCreate" } } } }, "responses": { "201": { "description": "The created fixed price promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/fixedPricePromotionResponse" } } } } } } }, "/fixed_price_promotions/{fixedPricePromotionId}": { "get": { "operationId": "GET/fixed_price_promotions/fixedPricePromotionId", "summary": "Retrieve a fixed price promotion", "description": "Retrieve a fixed price promotion", "tags": [ "fixed_price_promotions" ], "parameters": [ { "name": "fixedPricePromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The fixed price promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/fixedPricePromotionResponse" } } } } } }, "patch": { "operationId": "PATCH/fixed_price_promotions/fixedPricePromotionId", "summary": "Update a fixed price promotion", "description": "Update a fixed price promotion", "tags": [ "fixed_price_promotions" ], "parameters": [ { "name": "fixedPricePromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/fixedPricePromotionUpdate" } } } }, "responses": { "200": { "description": "The updated fixed price promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/fixedPricePromotionResponse" } } } } } }, "delete": { "operationId": "DELETE/fixed_price_promotions/fixedPricePromotionId", "summary": "Delete a fixed price promotion", "description": "Delete a fixed price promotion", "tags": [ "fixed_price_promotions" ], "parameters": [ { "name": "fixedPricePromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/fixed_price_promotions/{fixedPricePromotionId}/market": { "get": { "operationId": "GET/fixedPricePromotionId/market", "summary": "Retrieve the market associated to the fixed price promotion", "description": "Retrieve the market associated to the fixed price promotion", "tags": [ "has_one", "markets" ], "parameters": [ { "name": "fixedPricePromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The market associated to the fixed price promotion" } } } }, "/fixed_price_promotions/{fixedPricePromotionId}/order_amount_promotion_rule": { "get": { "operationId": "GET/fixedPricePromotionId/order_amount_promotion_rule", "summary": "Retrieve the order amount promotion rule associated to the fixed price promotion", "description": "Retrieve the order amount promotion rule associated to the fixed price promotion", "tags": [ "has_one", "order_amount_promotion_rules" ], "parameters": [ { "name": "fixedPricePromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order_amount_promotion_rule associated to the fixed price promotion" } } } }, "/fixed_price_promotions/{fixedPricePromotionId}/sku_list_promotion_rule": { "get": { "operationId": "GET/fixedPricePromotionId/sku_list_promotion_rule", "summary": "Retrieve the sku list promotion rule associated to the fixed price promotion", "description": "Retrieve the sku list promotion rule associated to the fixed price promotion", "tags": [ "has_one", "sku_list_promotion_rules" ], "parameters": [ { "name": "fixedPricePromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_list_promotion_rule associated to the fixed price promotion" } } } }, "/fixed_price_promotions/{fixedPricePromotionId}/coupon_codes_promotion_rule": { "get": { "operationId": "GET/fixedPricePromotionId/coupon_codes_promotion_rule", "summary": "Retrieve the coupon codes promotion rule associated to the fixed price promotion", "description": "Retrieve the coupon codes promotion rule associated to the fixed price promotion", "tags": [ "has_one", "coupon_codes_promotion_rules" ], "parameters": [ { "name": "fixedPricePromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupon_codes_promotion_rule associated to the fixed price promotion" } } } }, "/fixed_price_promotions/{fixedPricePromotionId}/custom_promotion_rule": { "get": { "operationId": "GET/fixedPricePromotionId/custom_promotion_rule", "summary": "Retrieve the custom promotion rule associated to the fixed price promotion", "description": "Retrieve the custom promotion rule associated to the fixed price promotion", "tags": [ "has_one", "custom_promotion_rules" ], "parameters": [ { "name": "fixedPricePromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The custom_promotion_rule associated to the fixed price promotion" } } } }, "/fixed_price_promotions/{fixedPricePromotionId}/sku_list": { "get": { "operationId": "GET/fixedPricePromotionId/sku_list", "summary": "Retrieve the sku list associated to the fixed price promotion", "description": "Retrieve the sku list associated to the fixed price promotion", "tags": [ "has_one", "sku_lists" ], "parameters": [ { "name": "fixedPricePromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_list associated to the fixed price promotion" } } } }, "/fixed_price_promotions/{fixedPricePromotionId}/coupons": { "get": { "operationId": "GET/fixedPricePromotionId/coupons", "summary": "Retrieve the coupons associated to the fixed price promotion", "description": "Retrieve the coupons associated to the fixed price promotion", "tags": [ "has_many", "coupons" ], "parameters": [ { "name": "fixedPricePromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupons associated to the fixed price promotion" } } } }, "/fixed_price_promotions/{fixedPricePromotionId}/attachments": { "get": { "operationId": "GET/fixedPricePromotionId/attachments", "summary": "Retrieve the attachments associated to the fixed price promotion", "description": "Retrieve the attachments associated to the fixed price promotion", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "fixedPricePromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the fixed price promotion" } } } }, "/fixed_price_promotions/{fixedPricePromotionId}/events": { "get": { "operationId": "GET/fixedPricePromotionId/events", "summary": "Retrieve the events associated to the fixed price promotion", "description": "Retrieve the events associated to the fixed price promotion", "tags": [ "has_many", "events" ], "parameters": [ { "name": "fixedPricePromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the fixed price promotion" } } } }, "/fixed_price_promotions/{fixedPricePromotionId}/tags": { "get": { "operationId": "GET/fixedPricePromotionId/tags", "summary": "Retrieve the tags associated to the fixed price promotion", "description": "Retrieve the tags associated to the fixed price promotion", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "fixedPricePromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the fixed price promotion" } } } }, "/fixed_price_promotions/{fixedPricePromotionId}/event_stores": { "get": { "operationId": "GET/fixedPricePromotionId/event_stores", "summary": "Retrieve the event stores associated to the fixed price promotion", "description": "Retrieve the event stores associated to the fixed price promotion", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "fixedPricePromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the fixed price promotion" } } } }, "/fixed_price_promotions/{fixedPricePromotionId}/skus": { "get": { "operationId": "GET/fixedPricePromotionId/skus", "summary": "Retrieve the skus associated to the fixed price promotion", "description": "Retrieve the skus associated to the fixed price promotion", "tags": [ "has_many", "skus" ], "parameters": [ { "name": "fixedPricePromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The skus associated to the fixed price promotion" } } } }, "/flex_promotions": { "get": { "operationId": "GET/flex_promotions", "summary": "List all flex promotions", "description": "List all flex promotions", "tags": [ "flex_promotions" ], "responses": { "200": { "description": "A list of flex promotion objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/flexPromotionResponseList" } } } } } }, "post": { "operationId": "POST/flex_promotions", "summary": "Create a flex promotion", "description": "Create a flex promotion", "tags": [ "flex_promotions" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/flexPromotionCreate" } } } }, "responses": { "201": { "description": "The created flex promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/flexPromotionResponse" } } } } } } }, "/flex_promotions/{flexPromotionId}": { "get": { "operationId": "GET/flex_promotions/flexPromotionId", "summary": "Retrieve a flex promotion", "description": "Retrieve a flex promotion", "tags": [ "flex_promotions" ], "parameters": [ { "name": "flexPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The flex promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/flexPromotionResponse" } } } } } }, "patch": { "operationId": "PATCH/flex_promotions/flexPromotionId", "summary": "Update a flex promotion", "description": "Update a flex promotion", "tags": [ "flex_promotions" ], "parameters": [ { "name": "flexPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/flexPromotionUpdate" } } } }, "responses": { "200": { "description": "The updated flex promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/flexPromotionResponse" } } } } } }, "delete": { "operationId": "DELETE/flex_promotions/flexPromotionId", "summary": "Delete a flex promotion", "description": "Delete a flex promotion", "tags": [ "flex_promotions" ], "parameters": [ { "name": "flexPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/flex_promotions/{flexPromotionId}/coupon_codes_promotion_rule": { "get": { "operationId": "GET/flexPromotionId/coupon_codes_promotion_rule", "summary": "Retrieve the coupon codes promotion rule associated to the flex promotion", "description": "Retrieve the coupon codes promotion rule associated to the flex promotion", "tags": [ "has_one", "coupon_codes_promotion_rules" ], "parameters": [ { "name": "flexPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupon_codes_promotion_rule associated to the flex promotion" } } } }, "/flex_promotions/{flexPromotionId}/coupons": { "get": { "operationId": "GET/flexPromotionId/coupons", "summary": "Retrieve the coupons associated to the flex promotion", "description": "Retrieve the coupons associated to the flex promotion", "tags": [ "has_many", "coupons" ], "parameters": [ { "name": "flexPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupons associated to the flex promotion" } } } }, "/flex_promotions/{flexPromotionId}/attachments": { "get": { "operationId": "GET/flexPromotionId/attachments", "summary": "Retrieve the attachments associated to the flex promotion", "description": "Retrieve the attachments associated to the flex promotion", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "flexPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the flex promotion" } } } }, "/flex_promotions/{flexPromotionId}/events": { "get": { "operationId": "GET/flexPromotionId/events", "summary": "Retrieve the events associated to the flex promotion", "description": "Retrieve the events associated to the flex promotion", "tags": [ "has_many", "events" ], "parameters": [ { "name": "flexPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the flex promotion" } } } }, "/flex_promotions/{flexPromotionId}/tags": { "get": { "operationId": "GET/flexPromotionId/tags", "summary": "Retrieve the tags associated to the flex promotion", "description": "Retrieve the tags associated to the flex promotion", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "flexPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the flex promotion" } } } }, "/flex_promotions/{flexPromotionId}/event_stores": { "get": { "operationId": "GET/flexPromotionId/event_stores", "summary": "Retrieve the event stores associated to the flex promotion", "description": "Retrieve the event stores associated to the flex promotion", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "flexPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the flex promotion" } } } }, "/free_gift_promotions": { "get": { "operationId": "GET/free_gift_promotions", "summary": "List all free gift promotions", "description": "List all free gift promotions", "tags": [ "free_gift_promotions" ], "responses": { "200": { "description": "A list of free gift promotion objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/freeGiftPromotionResponseList" } } } } } }, "post": { "operationId": "POST/free_gift_promotions", "summary": "Create a free gift promotion", "description": "Create a free gift promotion", "tags": [ "free_gift_promotions" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/freeGiftPromotionCreate" } } } }, "responses": { "201": { "description": "The created free gift promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/freeGiftPromotionResponse" } } } } } } }, "/free_gift_promotions/{freeGiftPromotionId}": { "get": { "operationId": "GET/free_gift_promotions/freeGiftPromotionId", "summary": "Retrieve a free gift promotion", "description": "Retrieve a free gift promotion", "tags": [ "free_gift_promotions" ], "parameters": [ { "name": "freeGiftPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The free gift promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/freeGiftPromotionResponse" } } } } } }, "patch": { "operationId": "PATCH/free_gift_promotions/freeGiftPromotionId", "summary": "Update a free gift promotion", "description": "Update a free gift promotion", "tags": [ "free_gift_promotions" ], "parameters": [ { "name": "freeGiftPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/freeGiftPromotionUpdate" } } } }, "responses": { "200": { "description": "The updated free gift promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/freeGiftPromotionResponse" } } } } } }, "delete": { "operationId": "DELETE/free_gift_promotions/freeGiftPromotionId", "summary": "Delete a free gift promotion", "description": "Delete a free gift promotion", "tags": [ "free_gift_promotions" ], "parameters": [ { "name": "freeGiftPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/free_gift_promotions/{freeGiftPromotionId}/market": { "get": { "operationId": "GET/freeGiftPromotionId/market", "summary": "Retrieve the market associated to the free gift promotion", "description": "Retrieve the market associated to the free gift promotion", "tags": [ "has_one", "markets" ], "parameters": [ { "name": "freeGiftPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The market associated to the free gift promotion" } } } }, "/free_gift_promotions/{freeGiftPromotionId}/order_amount_promotion_rule": { "get": { "operationId": "GET/freeGiftPromotionId/order_amount_promotion_rule", "summary": "Retrieve the order amount promotion rule associated to the free gift promotion", "description": "Retrieve the order amount promotion rule associated to the free gift promotion", "tags": [ "has_one", "order_amount_promotion_rules" ], "parameters": [ { "name": "freeGiftPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order_amount_promotion_rule associated to the free gift promotion" } } } }, "/free_gift_promotions/{freeGiftPromotionId}/sku_list_promotion_rule": { "get": { "operationId": "GET/freeGiftPromotionId/sku_list_promotion_rule", "summary": "Retrieve the sku list promotion rule associated to the free gift promotion", "description": "Retrieve the sku list promotion rule associated to the free gift promotion", "tags": [ "has_one", "sku_list_promotion_rules" ], "parameters": [ { "name": "freeGiftPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_list_promotion_rule associated to the free gift promotion" } } } }, "/free_gift_promotions/{freeGiftPromotionId}/coupon_codes_promotion_rule": { "get": { "operationId": "GET/freeGiftPromotionId/coupon_codes_promotion_rule", "summary": "Retrieve the coupon codes promotion rule associated to the free gift promotion", "description": "Retrieve the coupon codes promotion rule associated to the free gift promotion", "tags": [ "has_one", "coupon_codes_promotion_rules" ], "parameters": [ { "name": "freeGiftPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupon_codes_promotion_rule associated to the free gift promotion" } } } }, "/free_gift_promotions/{freeGiftPromotionId}/custom_promotion_rule": { "get": { "operationId": "GET/freeGiftPromotionId/custom_promotion_rule", "summary": "Retrieve the custom promotion rule associated to the free gift promotion", "description": "Retrieve the custom promotion rule associated to the free gift promotion", "tags": [ "has_one", "custom_promotion_rules" ], "parameters": [ { "name": "freeGiftPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The custom_promotion_rule associated to the free gift promotion" } } } }, "/free_gift_promotions/{freeGiftPromotionId}/sku_list": { "get": { "operationId": "GET/freeGiftPromotionId/sku_list", "summary": "Retrieve the sku list associated to the free gift promotion", "description": "Retrieve the sku list associated to the free gift promotion", "tags": [ "has_one", "sku_lists" ], "parameters": [ { "name": "freeGiftPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_list associated to the free gift promotion" } } } }, "/free_gift_promotions/{freeGiftPromotionId}/coupons": { "get": { "operationId": "GET/freeGiftPromotionId/coupons", "summary": "Retrieve the coupons associated to the free gift promotion", "description": "Retrieve the coupons associated to the free gift promotion", "tags": [ "has_many", "coupons" ], "parameters": [ { "name": "freeGiftPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupons associated to the free gift promotion" } } } }, "/free_gift_promotions/{freeGiftPromotionId}/attachments": { "get": { "operationId": "GET/freeGiftPromotionId/attachments", "summary": "Retrieve the attachments associated to the free gift promotion", "description": "Retrieve the attachments associated to the free gift promotion", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "freeGiftPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the free gift promotion" } } } }, "/free_gift_promotions/{freeGiftPromotionId}/events": { "get": { "operationId": "GET/freeGiftPromotionId/events", "summary": "Retrieve the events associated to the free gift promotion", "description": "Retrieve the events associated to the free gift promotion", "tags": [ "has_many", "events" ], "parameters": [ { "name": "freeGiftPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the free gift promotion" } } } }, "/free_gift_promotions/{freeGiftPromotionId}/tags": { "get": { "operationId": "GET/freeGiftPromotionId/tags", "summary": "Retrieve the tags associated to the free gift promotion", "description": "Retrieve the tags associated to the free gift promotion", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "freeGiftPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the free gift promotion" } } } }, "/free_gift_promotions/{freeGiftPromotionId}/event_stores": { "get": { "operationId": "GET/freeGiftPromotionId/event_stores", "summary": "Retrieve the event stores associated to the free gift promotion", "description": "Retrieve the event stores associated to the free gift promotion", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "freeGiftPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the free gift promotion" } } } }, "/free_gift_promotions/{freeGiftPromotionId}/skus": { "get": { "operationId": "GET/freeGiftPromotionId/skus", "summary": "Retrieve the skus associated to the free gift promotion", "description": "Retrieve the skus associated to the free gift promotion", "tags": [ "has_many", "skus" ], "parameters": [ { "name": "freeGiftPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The skus associated to the free gift promotion" } } } }, "/free_shipping_promotions": { "get": { "operationId": "GET/free_shipping_promotions", "summary": "List all free shipping promotions", "description": "List all free shipping promotions", "tags": [ "free_shipping_promotions" ], "responses": { "200": { "description": "A list of free shipping promotion objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/freeShippingPromotionResponseList" } } } } } }, "post": { "operationId": "POST/free_shipping_promotions", "summary": "Create a free shipping promotion", "description": "Create a free shipping promotion", "tags": [ "free_shipping_promotions" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/freeShippingPromotionCreate" } } } }, "responses": { "201": { "description": "The created free shipping promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/freeShippingPromotionResponse" } } } } } } }, "/free_shipping_promotions/{freeShippingPromotionId}": { "get": { "operationId": "GET/free_shipping_promotions/freeShippingPromotionId", "summary": "Retrieve a free shipping promotion", "description": "Retrieve a free shipping promotion", "tags": [ "free_shipping_promotions" ], "parameters": [ { "name": "freeShippingPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The free shipping promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/freeShippingPromotionResponse" } } } } } }, "patch": { "operationId": "PATCH/free_shipping_promotions/freeShippingPromotionId", "summary": "Update a free shipping promotion", "description": "Update a free shipping promotion", "tags": [ "free_shipping_promotions" ], "parameters": [ { "name": "freeShippingPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/freeShippingPromotionUpdate" } } } }, "responses": { "200": { "description": "The updated free shipping promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/freeShippingPromotionResponse" } } } } } }, "delete": { "operationId": "DELETE/free_shipping_promotions/freeShippingPromotionId", "summary": "Delete a free shipping promotion", "description": "Delete a free shipping promotion", "tags": [ "free_shipping_promotions" ], "parameters": [ { "name": "freeShippingPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/free_shipping_promotions/{freeShippingPromotionId}/market": { "get": { "operationId": "GET/freeShippingPromotionId/market", "summary": "Retrieve the market associated to the free shipping promotion", "description": "Retrieve the market associated to the free shipping promotion", "tags": [ "has_one", "markets" ], "parameters": [ { "name": "freeShippingPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The market associated to the free shipping promotion" } } } }, "/free_shipping_promotions/{freeShippingPromotionId}/order_amount_promotion_rule": { "get": { "operationId": "GET/freeShippingPromotionId/order_amount_promotion_rule", "summary": "Retrieve the order amount promotion rule associated to the free shipping promotion", "description": "Retrieve the order amount promotion rule associated to the free shipping promotion", "tags": [ "has_one", "order_amount_promotion_rules" ], "parameters": [ { "name": "freeShippingPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order_amount_promotion_rule associated to the free shipping promotion" } } } }, "/free_shipping_promotions/{freeShippingPromotionId}/sku_list_promotion_rule": { "get": { "operationId": "GET/freeShippingPromotionId/sku_list_promotion_rule", "summary": "Retrieve the sku list promotion rule associated to the free shipping promotion", "description": "Retrieve the sku list promotion rule associated to the free shipping promotion", "tags": [ "has_one", "sku_list_promotion_rules" ], "parameters": [ { "name": "freeShippingPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_list_promotion_rule associated to the free shipping promotion" } } } }, "/free_shipping_promotions/{freeShippingPromotionId}/coupon_codes_promotion_rule": { "get": { "operationId": "GET/freeShippingPromotionId/coupon_codes_promotion_rule", "summary": "Retrieve the coupon codes promotion rule associated to the free shipping promotion", "description": "Retrieve the coupon codes promotion rule associated to the free shipping promotion", "tags": [ "has_one", "coupon_codes_promotion_rules" ], "parameters": [ { "name": "freeShippingPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupon_codes_promotion_rule associated to the free shipping promotion" } } } }, "/free_shipping_promotions/{freeShippingPromotionId}/custom_promotion_rule": { "get": { "operationId": "GET/freeShippingPromotionId/custom_promotion_rule", "summary": "Retrieve the custom promotion rule associated to the free shipping promotion", "description": "Retrieve the custom promotion rule associated to the free shipping promotion", "tags": [ "has_one", "custom_promotion_rules" ], "parameters": [ { "name": "freeShippingPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The custom_promotion_rule associated to the free shipping promotion" } } } }, "/free_shipping_promotions/{freeShippingPromotionId}/sku_list": { "get": { "operationId": "GET/freeShippingPromotionId/sku_list", "summary": "Retrieve the sku list associated to the free shipping promotion", "description": "Retrieve the sku list associated to the free shipping promotion", "tags": [ "has_one", "sku_lists" ], "parameters": [ { "name": "freeShippingPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_list associated to the free shipping promotion" } } } }, "/free_shipping_promotions/{freeShippingPromotionId}/coupons": { "get": { "operationId": "GET/freeShippingPromotionId/coupons", "summary": "Retrieve the coupons associated to the free shipping promotion", "description": "Retrieve the coupons associated to the free shipping promotion", "tags": [ "has_many", "coupons" ], "parameters": [ { "name": "freeShippingPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupons associated to the free shipping promotion" } } } }, "/free_shipping_promotions/{freeShippingPromotionId}/attachments": { "get": { "operationId": "GET/freeShippingPromotionId/attachments", "summary": "Retrieve the attachments associated to the free shipping promotion", "description": "Retrieve the attachments associated to the free shipping promotion", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "freeShippingPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the free shipping promotion" } } } }, "/free_shipping_promotions/{freeShippingPromotionId}/events": { "get": { "operationId": "GET/freeShippingPromotionId/events", "summary": "Retrieve the events associated to the free shipping promotion", "description": "Retrieve the events associated to the free shipping promotion", "tags": [ "has_many", "events" ], "parameters": [ { "name": "freeShippingPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the free shipping promotion" } } } }, "/free_shipping_promotions/{freeShippingPromotionId}/tags": { "get": { "operationId": "GET/freeShippingPromotionId/tags", "summary": "Retrieve the tags associated to the free shipping promotion", "description": "Retrieve the tags associated to the free shipping promotion", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "freeShippingPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the free shipping promotion" } } } }, "/free_shipping_promotions/{freeShippingPromotionId}/event_stores": { "get": { "operationId": "GET/freeShippingPromotionId/event_stores", "summary": "Retrieve the event stores associated to the free shipping promotion", "description": "Retrieve the event stores associated to the free shipping promotion", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "freeShippingPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the free shipping promotion" } } } }, "/geocoders": { "get": { "operationId": "GET/geocoders", "summary": "List all geocoders", "description": "List all geocoders", "tags": [ "geocoders" ], "responses": { "200": { "description": "A list of geocoder objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/geocoderResponseList" } } } } } } }, "/geocoders/{geocoderId}": { "get": { "operationId": "GET/geocoders/geocoderId", "summary": "Retrieve a geocoder", "description": "Retrieve a geocoder", "tags": [ "geocoders" ], "parameters": [ { "name": "geocoderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The geocoder object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/geocoderResponse" } } } } } } }, "/geocoders/{geocoderId}/markets": { "get": { "operationId": "GET/geocoderId/markets", "summary": "Retrieve the markets associated to the geocoder", "description": "Retrieve the markets associated to the geocoder", "tags": [ "has_many", "markets" ], "parameters": [ { "name": "geocoderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The markets associated to the geocoder" } } } }, "/geocoders/{geocoderId}/addresses": { "get": { "operationId": "GET/geocoderId/addresses", "summary": "Retrieve the addresses associated to the geocoder", "description": "Retrieve the addresses associated to the geocoder", "tags": [ "has_many", "addresses" ], "parameters": [ { "name": "geocoderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The addresses associated to the geocoder" } } } }, "/geocoders/{geocoderId}/attachments": { "get": { "operationId": "GET/geocoderId/attachments", "summary": "Retrieve the attachments associated to the geocoder", "description": "Retrieve the attachments associated to the geocoder", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "geocoderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the geocoder" } } } }, "/geocoders/{geocoderId}/event_stores": { "get": { "operationId": "GET/geocoderId/event_stores", "summary": "Retrieve the event stores associated to the geocoder", "description": "Retrieve the event stores associated to the geocoder", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "geocoderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the geocoder" } } } }, "/gift_card_recipients": { "get": { "operationId": "GET/gift_card_recipients", "summary": "List all gift card recipients", "description": "List all gift card recipients", "tags": [ "gift_card_recipients" ], "responses": { "200": { "description": "A list of gift card recipient objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/giftCardRecipientResponseList" } } } } } }, "post": { "operationId": "POST/gift_card_recipients", "summary": "Create a gift card recipient", "description": "Create a gift card recipient", "tags": [ "gift_card_recipients" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/giftCardRecipientCreate" } } } }, "responses": { "201": { "description": "The created gift card recipient object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/giftCardRecipientResponse" } } } } } } }, "/gift_card_recipients/{giftCardRecipientId}": { "get": { "operationId": "GET/gift_card_recipients/giftCardRecipientId", "summary": "Retrieve a gift card recipient", "description": "Retrieve a gift card recipient", "tags": [ "gift_card_recipients" ], "parameters": [ { "name": "giftCardRecipientId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The gift card recipient object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/giftCardRecipientResponse" } } } } } }, "patch": { "operationId": "PATCH/gift_card_recipients/giftCardRecipientId", "summary": "Update a gift card recipient", "description": "Update a gift card recipient", "tags": [ "gift_card_recipients" ], "parameters": [ { "name": "giftCardRecipientId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/giftCardRecipientUpdate" } } } }, "responses": { "200": { "description": "The updated gift card recipient object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/giftCardRecipientResponse" } } } } } }, "delete": { "operationId": "DELETE/gift_card_recipients/giftCardRecipientId", "summary": "Delete a gift card recipient", "description": "Delete a gift card recipient", "tags": [ "gift_card_recipients" ], "parameters": [ { "name": "giftCardRecipientId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/gift_card_recipients/{giftCardRecipientId}/customer": { "get": { "operationId": "GET/giftCardRecipientId/customer", "summary": "Retrieve the customer associated to the gift card recipient", "description": "Retrieve the customer associated to the gift card recipient", "tags": [ "has_one", "customers" ], "parameters": [ { "name": "giftCardRecipientId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer associated to the gift card recipient" } } } }, "/gift_card_recipients/{giftCardRecipientId}/event_stores": { "get": { "operationId": "GET/giftCardRecipientId/event_stores", "summary": "Retrieve the event stores associated to the gift card recipient", "description": "Retrieve the event stores associated to the gift card recipient", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "giftCardRecipientId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the gift card recipient" } } } }, "/gift_card_recipients/{giftCardRecipientId}/attachments": { "get": { "operationId": "GET/giftCardRecipientId/attachments", "summary": "Retrieve the attachments associated to the gift card recipient", "description": "Retrieve the attachments associated to the gift card recipient", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "giftCardRecipientId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the gift card recipient" } } } }, "/gift_cards": { "get": { "operationId": "GET/gift_cards", "summary": "List all gift cards", "description": "List all gift cards", "tags": [ "gift_cards" ], "responses": { "200": { "description": "A list of gift card objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/giftCardResponseList" } } } } } }, "post": { "operationId": "POST/gift_cards", "summary": "Create a gift card", "description": "Create a gift card", "tags": [ "gift_cards" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/giftCardCreate" } } } }, "responses": { "201": { "description": "The created gift card object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/giftCardResponse" } } } } } } }, "/gift_cards/{giftCardId}": { "get": { "operationId": "GET/gift_cards/giftCardId", "summary": "Retrieve a gift card", "description": "Retrieve a gift card", "tags": [ "gift_cards" ], "parameters": [ { "name": "giftCardId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The gift card object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/giftCardResponse" } } } } } }, "patch": { "operationId": "PATCH/gift_cards/giftCardId", "summary": "Update a gift card", "description": "Update a gift card", "tags": [ "gift_cards" ], "parameters": [ { "name": "giftCardId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/giftCardUpdate" } } } }, "responses": { "200": { "description": "The updated gift card object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/giftCardResponse" } } } } } }, "delete": { "operationId": "DELETE/gift_cards/giftCardId", "summary": "Delete a gift card", "description": "Delete a gift card", "tags": [ "gift_cards" ], "parameters": [ { "name": "giftCardId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/gift_cards/{giftCardId}/market": { "get": { "operationId": "GET/giftCardId/market", "summary": "Retrieve the market associated to the gift card", "description": "Retrieve the market associated to the gift card", "tags": [ "has_one", "markets" ], "parameters": [ { "name": "giftCardId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The market associated to the gift card" } } } }, "/gift_cards/{giftCardId}/gift_card_recipient": { "get": { "operationId": "GET/giftCardId/gift_card_recipient", "summary": "Retrieve the gift card recipient associated to the gift card", "description": "Retrieve the gift card recipient associated to the gift card", "tags": [ "has_one", "gift_card_recipients" ], "parameters": [ { "name": "giftCardId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The gift_card_recipient associated to the gift card" } } } }, "/gift_cards/{giftCardId}/attachments": { "get": { "operationId": "GET/giftCardId/attachments", "summary": "Retrieve the attachments associated to the gift card", "description": "Retrieve the attachments associated to the gift card", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "giftCardId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the gift card" } } } }, "/gift_cards/{giftCardId}/events": { "get": { "operationId": "GET/giftCardId/events", "summary": "Retrieve the events associated to the gift card", "description": "Retrieve the events associated to the gift card", "tags": [ "has_many", "events" ], "parameters": [ { "name": "giftCardId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the gift card" } } } }, "/gift_cards/{giftCardId}/tags": { "get": { "operationId": "GET/giftCardId/tags", "summary": "Retrieve the tags associated to the gift card", "description": "Retrieve the tags associated to the gift card", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "giftCardId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the gift card" } } } }, "/gift_cards/{giftCardId}/event_stores": { "get": { "operationId": "GET/giftCardId/event_stores", "summary": "Retrieve the event stores associated to the gift card", "description": "Retrieve the event stores associated to the gift card", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "giftCardId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the gift card" } } } }, "/google_geocoders": { "get": { "operationId": "GET/google_geocoders", "summary": "List all google geocoders", "description": "List all google geocoders", "tags": [ "google_geocoders" ], "responses": { "200": { "description": "A list of google geocoder objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/googleGeocoderResponseList" } } } } } }, "post": { "operationId": "POST/google_geocoders", "summary": "Create a google geocoder", "description": "Create a google geocoder", "tags": [ "google_geocoders" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/googleGeocoderCreate" } } } }, "responses": { "201": { "description": "The created google geocoder object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/googleGeocoderResponse" } } } } } } }, "/google_geocoders/{googleGeocoderId}": { "get": { "operationId": "GET/google_geocoders/googleGeocoderId", "summary": "Retrieve a google geocoder", "description": "Retrieve a google geocoder", "tags": [ "google_geocoders" ], "parameters": [ { "name": "googleGeocoderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The google geocoder object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/googleGeocoderResponse" } } } } } }, "patch": { "operationId": "PATCH/google_geocoders/googleGeocoderId", "summary": "Update a google geocoder", "description": "Update a google geocoder", "tags": [ "google_geocoders" ], "parameters": [ { "name": "googleGeocoderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/googleGeocoderUpdate" } } } }, "responses": { "200": { "description": "The updated google geocoder object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/googleGeocoderResponse" } } } } } }, "delete": { "operationId": "DELETE/google_geocoders/googleGeocoderId", "summary": "Delete a google geocoder", "description": "Delete a google geocoder", "tags": [ "google_geocoders" ], "parameters": [ { "name": "googleGeocoderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/google_geocoders/{googleGeocoderId}/markets": { "get": { "operationId": "GET/googleGeocoderId/markets", "summary": "Retrieve the markets associated to the google geocoder", "description": "Retrieve the markets associated to the google geocoder", "tags": [ "has_many", "markets" ], "parameters": [ { "name": "googleGeocoderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The markets associated to the google geocoder" } } } }, "/google_geocoders/{googleGeocoderId}/addresses": { "get": { "operationId": "GET/googleGeocoderId/addresses", "summary": "Retrieve the addresses associated to the google geocoder", "description": "Retrieve the addresses associated to the google geocoder", "tags": [ "has_many", "addresses" ], "parameters": [ { "name": "googleGeocoderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The addresses associated to the google geocoder" } } } }, "/google_geocoders/{googleGeocoderId}/attachments": { "get": { "operationId": "GET/googleGeocoderId/attachments", "summary": "Retrieve the attachments associated to the google geocoder", "description": "Retrieve the attachments associated to the google geocoder", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "googleGeocoderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the google geocoder" } } } }, "/google_geocoders/{googleGeocoderId}/event_stores": { "get": { "operationId": "GET/googleGeocoderId/event_stores", "summary": "Retrieve the event stores associated to the google geocoder", "description": "Retrieve the event stores associated to the google geocoder", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "googleGeocoderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the google geocoder" } } } }, "/imports": { "get": { "operationId": "GET/imports", "summary": "List all imports", "description": "List all imports", "tags": [ "imports" ], "responses": { "200": { "description": "A list of import objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/importResponseList" } } } } } }, "post": { "operationId": "POST/imports", "summary": "Create an import", "description": "Create an import", "tags": [ "imports" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/importCreate" } } } }, "responses": { "201": { "description": "The created import object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/importResponse" } } } } } } }, "/imports/{importId}": { "get": { "operationId": "GET/imports/importId", "summary": "Retrieve an import", "description": "Retrieve an import", "tags": [ "imports" ], "parameters": [ { "name": "importId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The import object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/importResponse" } } } } } }, "patch": { "operationId": "PATCH/imports/importId", "summary": "Update an import", "description": "Update an import", "tags": [ "imports" ], "parameters": [ { "name": "importId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/importUpdate" } } } }, "responses": { "200": { "description": "The updated import object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/importResponse" } } } } } }, "delete": { "operationId": "DELETE/imports/importId", "summary": "Delete an import", "description": "Delete an import", "tags": [ "imports" ], "parameters": [ { "name": "importId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/imports/{importId}/events": { "get": { "operationId": "GET/importId/events", "summary": "Retrieve the events associated to the import", "description": "Retrieve the events associated to the import", "tags": [ "has_many", "events" ], "parameters": [ { "name": "importId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the import" } } } }, "/imports/{importId}/event_stores": { "get": { "operationId": "GET/importId/event_stores", "summary": "Retrieve the event stores associated to the import", "description": "Retrieve the event stores associated to the import", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "importId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the import" } } } }, "/in_stock_subscriptions": { "get": { "operationId": "GET/in_stock_subscriptions", "summary": "List all in stock subscriptions", "description": "List all in stock subscriptions", "tags": [ "in_stock_subscriptions" ], "responses": { "200": { "description": "A list of in stock subscription objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inStockSubscriptionResponseList" } } } } } }, "post": { "operationId": "POST/in_stock_subscriptions", "summary": "Create an in stock subscription", "description": "Create an in stock subscription", "tags": [ "in_stock_subscriptions" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inStockSubscriptionCreate" } } } }, "responses": { "201": { "description": "The created in stock subscription object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inStockSubscriptionResponse" } } } } } } }, "/in_stock_subscriptions/{inStockSubscriptionId}": { "get": { "operationId": "GET/in_stock_subscriptions/inStockSubscriptionId", "summary": "Retrieve an in stock subscription", "description": "Retrieve an in stock subscription", "tags": [ "in_stock_subscriptions" ], "parameters": [ { "name": "inStockSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The in stock subscription object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inStockSubscriptionResponse" } } } } } }, "patch": { "operationId": "PATCH/in_stock_subscriptions/inStockSubscriptionId", "summary": "Update an in stock subscription", "description": "Update an in stock subscription", "tags": [ "in_stock_subscriptions" ], "parameters": [ { "name": "inStockSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inStockSubscriptionUpdate" } } } }, "responses": { "200": { "description": "The updated in stock subscription object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inStockSubscriptionResponse" } } } } } }, "delete": { "operationId": "DELETE/in_stock_subscriptions/inStockSubscriptionId", "summary": "Delete an in stock subscription", "description": "Delete an in stock subscription", "tags": [ "in_stock_subscriptions" ], "parameters": [ { "name": "inStockSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/in_stock_subscriptions/{inStockSubscriptionId}/market": { "get": { "operationId": "GET/inStockSubscriptionId/market", "summary": "Retrieve the market associated to the in stock subscription", "description": "Retrieve the market associated to the in stock subscription", "tags": [ "has_one", "markets" ], "parameters": [ { "name": "inStockSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The market associated to the in stock subscription" } } } }, "/in_stock_subscriptions/{inStockSubscriptionId}/customer": { "get": { "operationId": "GET/inStockSubscriptionId/customer", "summary": "Retrieve the customer associated to the in stock subscription", "description": "Retrieve the customer associated to the in stock subscription", "tags": [ "has_one", "customers" ], "parameters": [ { "name": "inStockSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer associated to the in stock subscription" } } } }, "/in_stock_subscriptions/{inStockSubscriptionId}/sku": { "get": { "operationId": "GET/inStockSubscriptionId/sku", "summary": "Retrieve the sku associated to the in stock subscription", "description": "Retrieve the sku associated to the in stock subscription", "tags": [ "has_one", "skus" ], "parameters": [ { "name": "inStockSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku associated to the in stock subscription" } } } }, "/in_stock_subscriptions/{inStockSubscriptionId}/events": { "get": { "operationId": "GET/inStockSubscriptionId/events", "summary": "Retrieve the events associated to the in stock subscription", "description": "Retrieve the events associated to the in stock subscription", "tags": [ "has_many", "events" ], "parameters": [ { "name": "inStockSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the in stock subscription" } } } }, "/in_stock_subscriptions/{inStockSubscriptionId}/event_stores": { "get": { "operationId": "GET/inStockSubscriptionId/event_stores", "summary": "Retrieve the event stores associated to the in stock subscription", "description": "Retrieve the event stores associated to the in stock subscription", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "inStockSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the in stock subscription" } } } }, "/inventory_models": { "get": { "operationId": "GET/inventory_models", "summary": "List all inventory models", "description": "List all inventory models", "tags": [ "inventory_models" ], "responses": { "200": { "description": "A list of inventory model objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inventoryModelResponseList" } } } } } }, "post": { "operationId": "POST/inventory_models", "summary": "Create an inventory model", "description": "Create an inventory model", "tags": [ "inventory_models" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inventoryModelCreate" } } } }, "responses": { "201": { "description": "The created inventory model object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inventoryModelResponse" } } } } } } }, "/inventory_models/{inventoryModelId}": { "get": { "operationId": "GET/inventory_models/inventoryModelId", "summary": "Retrieve an inventory model", "description": "Retrieve an inventory model", "tags": [ "inventory_models" ], "parameters": [ { "name": "inventoryModelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The inventory model object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inventoryModelResponse" } } } } } }, "patch": { "operationId": "PATCH/inventory_models/inventoryModelId", "summary": "Update an inventory model", "description": "Update an inventory model", "tags": [ "inventory_models" ], "parameters": [ { "name": "inventoryModelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inventoryModelUpdate" } } } }, "responses": { "200": { "description": "The updated inventory model object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inventoryModelResponse" } } } } } }, "delete": { "operationId": "DELETE/inventory_models/inventoryModelId", "summary": "Delete an inventory model", "description": "Delete an inventory model", "tags": [ "inventory_models" ], "parameters": [ { "name": "inventoryModelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/inventory_models/{inventoryModelId}/inventory_stock_locations": { "get": { "operationId": "GET/inventoryModelId/inventory_stock_locations", "summary": "Retrieve the inventory stock locations associated to the inventory model", "description": "Retrieve the inventory stock locations associated to the inventory model", "tags": [ "has_many", "inventory_stock_locations" ], "parameters": [ { "name": "inventoryModelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The inventory_stock_locations associated to the inventory model" } } } }, "/inventory_models/{inventoryModelId}/inventory_return_locations": { "get": { "operationId": "GET/inventoryModelId/inventory_return_locations", "summary": "Retrieve the inventory return locations associated to the inventory model", "description": "Retrieve the inventory return locations associated to the inventory model", "tags": [ "has_many", "inventory_return_locations" ], "parameters": [ { "name": "inventoryModelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The inventory_return_locations associated to the inventory model" } } } }, "/inventory_models/{inventoryModelId}/attachments": { "get": { "operationId": "GET/inventoryModelId/attachments", "summary": "Retrieve the attachments associated to the inventory model", "description": "Retrieve the attachments associated to the inventory model", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "inventoryModelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the inventory model" } } } }, "/inventory_models/{inventoryModelId}/event_stores": { "get": { "operationId": "GET/inventoryModelId/event_stores", "summary": "Retrieve the event stores associated to the inventory model", "description": "Retrieve the event stores associated to the inventory model", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "inventoryModelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the inventory model" } } } }, "/inventory_return_locations": { "get": { "operationId": "GET/inventory_return_locations", "summary": "List all inventory return locations", "description": "List all inventory return locations", "tags": [ "inventory_return_locations" ], "responses": { "200": { "description": "A list of inventory return location objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inventoryReturnLocationResponseList" } } } } } }, "post": { "operationId": "POST/inventory_return_locations", "summary": "Create an inventory return location", "description": "Create an inventory return location", "tags": [ "inventory_return_locations" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inventoryReturnLocationCreate" } } } }, "responses": { "201": { "description": "The created inventory return location object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inventoryReturnLocationResponse" } } } } } } }, "/inventory_return_locations/{inventoryReturnLocationId}": { "get": { "operationId": "GET/inventory_return_locations/inventoryReturnLocationId", "summary": "Retrieve an inventory return location", "description": "Retrieve an inventory return location", "tags": [ "inventory_return_locations" ], "parameters": [ { "name": "inventoryReturnLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The inventory return location object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inventoryReturnLocationResponse" } } } } } }, "patch": { "operationId": "PATCH/inventory_return_locations/inventoryReturnLocationId", "summary": "Update an inventory return location", "description": "Update an inventory return location", "tags": [ "inventory_return_locations" ], "parameters": [ { "name": "inventoryReturnLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inventoryReturnLocationUpdate" } } } }, "responses": { "200": { "description": "The updated inventory return location object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inventoryReturnLocationResponse" } } } } } }, "delete": { "operationId": "DELETE/inventory_return_locations/inventoryReturnLocationId", "summary": "Delete an inventory return location", "description": "Delete an inventory return location", "tags": [ "inventory_return_locations" ], "parameters": [ { "name": "inventoryReturnLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/inventory_return_locations/{inventoryReturnLocationId}/stock_location": { "get": { "operationId": "GET/inventoryReturnLocationId/stock_location", "summary": "Retrieve the stock location associated to the inventory return location", "description": "Retrieve the stock location associated to the inventory return location", "tags": [ "has_one", "stock_locations" ], "parameters": [ { "name": "inventoryReturnLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_location associated to the inventory return location" } } } }, "/inventory_return_locations/{inventoryReturnLocationId}/inventory_model": { "get": { "operationId": "GET/inventoryReturnLocationId/inventory_model", "summary": "Retrieve the inventory model associated to the inventory return location", "description": "Retrieve the inventory model associated to the inventory return location", "tags": [ "has_one", "inventory_models" ], "parameters": [ { "name": "inventoryReturnLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The inventory_model associated to the inventory return location" } } } }, "/inventory_return_locations/{inventoryReturnLocationId}/event_stores": { "get": { "operationId": "GET/inventoryReturnLocationId/event_stores", "summary": "Retrieve the event stores associated to the inventory return location", "description": "Retrieve the event stores associated to the inventory return location", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "inventoryReturnLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the inventory return location" } } } }, "/inventory_stock_locations": { "get": { "operationId": "GET/inventory_stock_locations", "summary": "List all inventory stock locations", "description": "List all inventory stock locations", "tags": [ "inventory_stock_locations" ], "responses": { "200": { "description": "A list of inventory stock location objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inventoryStockLocationResponseList" } } } } } }, "post": { "operationId": "POST/inventory_stock_locations", "summary": "Create an inventory stock location", "description": "Create an inventory stock location", "tags": [ "inventory_stock_locations" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inventoryStockLocationCreate" } } } }, "responses": { "201": { "description": "The created inventory stock location object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inventoryStockLocationResponse" } } } } } } }, "/inventory_stock_locations/{inventoryStockLocationId}": { "get": { "operationId": "GET/inventory_stock_locations/inventoryStockLocationId", "summary": "Retrieve an inventory stock location", "description": "Retrieve an inventory stock location", "tags": [ "inventory_stock_locations" ], "parameters": [ { "name": "inventoryStockLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The inventory stock location object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inventoryStockLocationResponse" } } } } } }, "patch": { "operationId": "PATCH/inventory_stock_locations/inventoryStockLocationId", "summary": "Update an inventory stock location", "description": "Update an inventory stock location", "tags": [ "inventory_stock_locations" ], "parameters": [ { "name": "inventoryStockLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inventoryStockLocationUpdate" } } } }, "responses": { "200": { "description": "The updated inventory stock location object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/inventoryStockLocationResponse" } } } } } }, "delete": { "operationId": "DELETE/inventory_stock_locations/inventoryStockLocationId", "summary": "Delete an inventory stock location", "description": "Delete an inventory stock location", "tags": [ "inventory_stock_locations" ], "parameters": [ { "name": "inventoryStockLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/inventory_stock_locations/{inventoryStockLocationId}/stock_location": { "get": { "operationId": "GET/inventoryStockLocationId/stock_location", "summary": "Retrieve the stock location associated to the inventory stock location", "description": "Retrieve the stock location associated to the inventory stock location", "tags": [ "has_one", "stock_locations" ], "parameters": [ { "name": "inventoryStockLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_location associated to the inventory stock location" } } } }, "/inventory_stock_locations/{inventoryStockLocationId}/inventory_model": { "get": { "operationId": "GET/inventoryStockLocationId/inventory_model", "summary": "Retrieve the inventory model associated to the inventory stock location", "description": "Retrieve the inventory model associated to the inventory stock location", "tags": [ "has_one", "inventory_models" ], "parameters": [ { "name": "inventoryStockLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The inventory_model associated to the inventory stock location" } } } }, "/inventory_stock_locations/{inventoryStockLocationId}/event_stores": { "get": { "operationId": "GET/inventoryStockLocationId/event_stores", "summary": "Retrieve the event stores associated to the inventory stock location", "description": "Retrieve the event stores associated to the inventory stock location", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "inventoryStockLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the inventory stock location" } } } }, "/klarna_gateways": { "get": { "operationId": "GET/klarna_gateways", "summary": "List all klarna gateways", "description": "List all klarna gateways", "tags": [ "klarna_gateways" ], "responses": { "200": { "description": "A list of klarna gateway objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/klarnaGatewayResponseList" } } } } } }, "post": { "operationId": "POST/klarna_gateways", "summary": "Create a klarna gateway", "description": "Create a klarna gateway", "tags": [ "klarna_gateways" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/klarnaGatewayCreate" } } } }, "responses": { "201": { "description": "The created klarna gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/klarnaGatewayResponse" } } } } } } }, "/klarna_gateways/{klarnaGatewayId}": { "get": { "operationId": "GET/klarna_gateways/klarnaGatewayId", "summary": "Retrieve a klarna gateway", "description": "Retrieve a klarna gateway", "tags": [ "klarna_gateways" ], "parameters": [ { "name": "klarnaGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The klarna gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/klarnaGatewayResponse" } } } } } }, "patch": { "operationId": "PATCH/klarna_gateways/klarnaGatewayId", "summary": "Update a klarna gateway", "description": "Update a klarna gateway", "tags": [ "klarna_gateways" ], "parameters": [ { "name": "klarnaGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/klarnaGatewayUpdate" } } } }, "responses": { "200": { "description": "The updated klarna gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/klarnaGatewayResponse" } } } } } }, "delete": { "operationId": "DELETE/klarna_gateways/klarnaGatewayId", "summary": "Delete a klarna gateway", "description": "Delete a klarna gateway", "tags": [ "klarna_gateways" ], "parameters": [ { "name": "klarnaGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/klarna_gateways/{klarnaGatewayId}/payment_methods": { "get": { "operationId": "GET/klarnaGatewayId/payment_methods", "summary": "Retrieve the payment methods associated to the klarna gateway", "description": "Retrieve the payment methods associated to the klarna gateway", "tags": [ "has_many", "payment_methods" ], "parameters": [ { "name": "klarnaGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_methods associated to the klarna gateway" } } } }, "/klarna_gateways/{klarnaGatewayId}/event_stores": { "get": { "operationId": "GET/klarnaGatewayId/event_stores", "summary": "Retrieve the event stores associated to the klarna gateway", "description": "Retrieve the event stores associated to the klarna gateway", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "klarnaGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the klarna gateway" } } } }, "/klarna_gateways/{klarnaGatewayId}/klarna_payments": { "get": { "operationId": "GET/klarnaGatewayId/klarna_payments", "summary": "Retrieve the klarna payments associated to the klarna gateway", "description": "Retrieve the klarna payments associated to the klarna gateway", "tags": [ "has_many", "klarna_payments" ], "parameters": [ { "name": "klarnaGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The klarna_payments associated to the klarna gateway" } } } }, "/klarna_payments": { "get": { "operationId": "GET/klarna_payments", "summary": "List all klarna payments", "description": "List all klarna payments", "tags": [ "klarna_payments" ], "responses": { "200": { "description": "A list of klarna payment objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/klarnaPaymentResponseList" } } } } } }, "post": { "operationId": "POST/klarna_payments", "summary": "Create a klarna payment", "description": "Create a klarna payment", "tags": [ "klarna_payments" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/klarnaPaymentCreate" } } } }, "responses": { "201": { "description": "The created klarna payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/klarnaPaymentResponse" } } } } } } }, "/klarna_payments/{klarnaPaymentId}": { "get": { "operationId": "GET/klarna_payments/klarnaPaymentId", "summary": "Retrieve a klarna payment", "description": "Retrieve a klarna payment", "tags": [ "klarna_payments" ], "parameters": [ { "name": "klarnaPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The klarna payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/klarnaPaymentResponse" } } } } } }, "patch": { "operationId": "PATCH/klarna_payments/klarnaPaymentId", "summary": "Update a klarna payment", "description": "Update a klarna payment", "tags": [ "klarna_payments" ], "parameters": [ { "name": "klarnaPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/klarnaPaymentUpdate" } } } }, "responses": { "200": { "description": "The updated klarna payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/klarnaPaymentResponse" } } } } } }, "delete": { "operationId": "DELETE/klarna_payments/klarnaPaymentId", "summary": "Delete a klarna payment", "description": "Delete a klarna payment", "tags": [ "klarna_payments" ], "parameters": [ { "name": "klarnaPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/klarna_payments/{klarnaPaymentId}/order": { "get": { "operationId": "GET/klarnaPaymentId/order", "summary": "Retrieve the order associated to the klarna payment", "description": "Retrieve the order associated to the klarna payment", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "klarnaPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order associated to the klarna payment" } } } }, "/klarna_payments/{klarnaPaymentId}/payment_gateway": { "get": { "operationId": "GET/klarnaPaymentId/payment_gateway", "summary": "Retrieve the payment gateway associated to the klarna payment", "description": "Retrieve the payment gateway associated to the klarna payment", "tags": [ "has_one", "payment_gateways" ], "parameters": [ { "name": "klarnaPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_gateway associated to the klarna payment" } } } }, "/klarna_payments/{klarnaPaymentId}/event_stores": { "get": { "operationId": "GET/klarnaPaymentId/event_stores", "summary": "Retrieve the event stores associated to the klarna payment", "description": "Retrieve the event stores associated to the klarna payment", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "klarnaPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the klarna payment" } } } }, "/line_item_options": { "get": { "operationId": "GET/line_item_options", "summary": "List all line item options", "description": "List all line item options", "tags": [ "line_item_options" ], "responses": { "200": { "description": "A list of line item option objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/lineItemOptionResponseList" } } } } } }, "post": { "operationId": "POST/line_item_options", "summary": "Create a line item option", "description": "Create a line item option", "tags": [ "line_item_options" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/lineItemOptionCreate" } } } }, "responses": { "201": { "description": "The created line item option object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/lineItemOptionResponse" } } } } } } }, "/line_item_options/{lineItemOptionId}": { "get": { "operationId": "GET/line_item_options/lineItemOptionId", "summary": "Retrieve a line item option", "description": "Retrieve a line item option", "tags": [ "line_item_options" ], "parameters": [ { "name": "lineItemOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The line item option object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/lineItemOptionResponse" } } } } } }, "patch": { "operationId": "PATCH/line_item_options/lineItemOptionId", "summary": "Update a line item option", "description": "Update a line item option", "tags": [ "line_item_options" ], "parameters": [ { "name": "lineItemOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/lineItemOptionUpdate" } } } }, "responses": { "200": { "description": "The updated line item option object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/lineItemOptionResponse" } } } } } }, "delete": { "operationId": "DELETE/line_item_options/lineItemOptionId", "summary": "Delete a line item option", "description": "Delete a line item option", "tags": [ "line_item_options" ], "parameters": [ { "name": "lineItemOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/line_item_options/{lineItemOptionId}/line_item": { "get": { "operationId": "GET/lineItemOptionId/line_item", "summary": "Retrieve the line item associated to the line item option", "description": "Retrieve the line item associated to the line item option", "tags": [ "has_one", "line_items" ], "parameters": [ { "name": "lineItemOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The line_item associated to the line item option" } } } }, "/line_item_options/{lineItemOptionId}/sku_option": { "get": { "operationId": "GET/lineItemOptionId/sku_option", "summary": "Retrieve the sku option associated to the line item option", "description": "Retrieve the sku option associated to the line item option", "tags": [ "has_one", "sku_options" ], "parameters": [ { "name": "lineItemOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_option associated to the line item option" } } } }, "/line_item_options/{lineItemOptionId}/events": { "get": { "operationId": "GET/lineItemOptionId/events", "summary": "Retrieve the events associated to the line item option", "description": "Retrieve the events associated to the line item option", "tags": [ "has_many", "events" ], "parameters": [ { "name": "lineItemOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the line item option" } } } }, "/line_item_options/{lineItemOptionId}/tags": { "get": { "operationId": "GET/lineItemOptionId/tags", "summary": "Retrieve the tags associated to the line item option", "description": "Retrieve the tags associated to the line item option", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "lineItemOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the line item option" } } } }, "/line_item_options/{lineItemOptionId}/event_stores": { "get": { "operationId": "GET/lineItemOptionId/event_stores", "summary": "Retrieve the event stores associated to the line item option", "description": "Retrieve the event stores associated to the line item option", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "lineItemOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the line item option" } } } }, "/line_items": { "get": { "operationId": "GET/line_items", "summary": "List all line items", "description": "List all line items", "tags": [ "line_items" ], "responses": { "200": { "description": "A list of line item objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/lineItemResponseList" } } } } } }, "post": { "operationId": "POST/line_items", "summary": "Create a line item", "description": "Create a line item", "tags": [ "line_items" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/lineItemCreate" } } } }, "responses": { "201": { "description": "The created line item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/lineItemResponse" } } } } } } }, "/line_items/{lineItemId}": { "get": { "operationId": "GET/line_items/lineItemId", "summary": "Retrieve a line item", "description": "Retrieve a line item", "tags": [ "line_items" ], "parameters": [ { "name": "lineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The line item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/lineItemResponse" } } } } } }, "patch": { "operationId": "PATCH/line_items/lineItemId", "summary": "Update a line item", "description": "Update a line item", "tags": [ "line_items" ], "parameters": [ { "name": "lineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/lineItemUpdate" } } } }, "responses": { "200": { "description": "The updated line item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/lineItemResponse" } } } } } }, "delete": { "operationId": "DELETE/line_items/lineItemId", "summary": "Delete a line item", "description": "Delete a line item", "tags": [ "line_items" ], "parameters": [ { "name": "lineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/line_items/{lineItemId}/order": { "get": { "operationId": "GET/lineItemId/order", "summary": "Retrieve the order associated to the line item", "description": "Retrieve the order associated to the line item", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "lineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order associated to the line item" } } } }, "/line_items/{lineItemId}/line_item_options": { "get": { "operationId": "GET/lineItemId/line_item_options", "summary": "Retrieve the line item options associated to the line item", "description": "Retrieve the line item options associated to the line item", "tags": [ "has_many", "line_item_options" ], "parameters": [ { "name": "lineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The line_item_options associated to the line item" } } } }, "/line_items/{lineItemId}/return_line_items": { "get": { "operationId": "GET/lineItemId/return_line_items", "summary": "Retrieve the return line items associated to the line item", "description": "Retrieve the return line items associated to the line item", "tags": [ "has_many", "return_line_items" ], "parameters": [ { "name": "lineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The return_line_items associated to the line item" } } } }, "/line_items/{lineItemId}/stock_reservations": { "get": { "operationId": "GET/lineItemId/stock_reservations", "summary": "Retrieve the stock reservations associated to the line item", "description": "Retrieve the stock reservations associated to the line item", "tags": [ "has_many", "stock_reservations" ], "parameters": [ { "name": "lineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_reservations associated to the line item" } } } }, "/line_items/{lineItemId}/stock_line_items": { "get": { "operationId": "GET/lineItemId/stock_line_items", "summary": "Retrieve the stock line items associated to the line item", "description": "Retrieve the stock line items associated to the line item", "tags": [ "has_many", "stock_line_items" ], "parameters": [ { "name": "lineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_line_items associated to the line item" } } } }, "/line_items/{lineItemId}/stock_transfers": { "get": { "operationId": "GET/lineItemId/stock_transfers", "summary": "Retrieve the stock transfers associated to the line item", "description": "Retrieve the stock transfers associated to the line item", "tags": [ "has_many", "stock_transfers" ], "parameters": [ { "name": "lineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_transfers associated to the line item" } } } }, "/line_items/{lineItemId}/notifications": { "get": { "operationId": "GET/lineItemId/notifications", "summary": "Retrieve the notifications associated to the line item", "description": "Retrieve the notifications associated to the line item", "tags": [ "has_many", "notifications" ], "parameters": [ { "name": "lineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The notifications associated to the line item" } } } }, "/line_items/{lineItemId}/events": { "get": { "operationId": "GET/lineItemId/events", "summary": "Retrieve the events associated to the line item", "description": "Retrieve the events associated to the line item", "tags": [ "has_many", "events" ], "parameters": [ { "name": "lineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the line item" } } } }, "/line_items/{lineItemId}/tags": { "get": { "operationId": "GET/lineItemId/tags", "summary": "Retrieve the tags associated to the line item", "description": "Retrieve the tags associated to the line item", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "lineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the line item" } } } }, "/line_items/{lineItemId}/event_stores": { "get": { "operationId": "GET/lineItemId/event_stores", "summary": "Retrieve the event stores associated to the line item", "description": "Retrieve the event stores associated to the line item", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "lineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the line item" } } } }, "/links": { "get": { "operationId": "GET/links", "summary": "List all links", "description": "List all links", "tags": [ "links" ], "responses": { "200": { "description": "A list of link objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/linkResponseList" } } } } } }, "post": { "operationId": "POST/links", "summary": "Create a link", "description": "Create a link", "tags": [ "links" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/linkCreate" } } } }, "responses": { "201": { "description": "The created link object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/linkResponse" } } } } } } }, "/links/{linkId}": { "get": { "operationId": "GET/links/linkId", "summary": "Retrieve a link", "description": "Retrieve a link", "tags": [ "links" ], "parameters": [ { "name": "linkId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The link object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/linkResponse" } } } } } }, "patch": { "operationId": "PATCH/links/linkId", "summary": "Update a link", "description": "Update a link", "tags": [ "links" ], "parameters": [ { "name": "linkId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/linkUpdate" } } } }, "responses": { "200": { "description": "The updated link object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/linkResponse" } } } } } }, "delete": { "operationId": "DELETE/links/linkId", "summary": "Delete a link", "description": "Delete a link", "tags": [ "links" ], "parameters": [ { "name": "linkId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/links/{linkId}/events": { "get": { "operationId": "GET/linkId/events", "summary": "Retrieve the events associated to the link", "description": "Retrieve the events associated to the link", "tags": [ "has_many", "events" ], "parameters": [ { "name": "linkId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the link" } } } }, "/links/{linkId}/event_stores": { "get": { "operationId": "GET/linkId/event_stores", "summary": "Retrieve the event stores associated to the link", "description": "Retrieve the event stores associated to the link", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "linkId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the link" } } } }, "/manual_gateways": { "get": { "operationId": "GET/manual_gateways", "summary": "List all manual gateways", "description": "List all manual gateways", "tags": [ "manual_gateways" ], "responses": { "200": { "description": "A list of manual gateway objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/manualGatewayResponseList" } } } } } }, "post": { "operationId": "POST/manual_gateways", "summary": "Create a manual gateway", "description": "Create a manual gateway", "tags": [ "manual_gateways" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/manualGatewayCreate" } } } }, "responses": { "201": { "description": "The created manual gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/manualGatewayResponse" } } } } } } }, "/manual_gateways/{manualGatewayId}": { "get": { "operationId": "GET/manual_gateways/manualGatewayId", "summary": "Retrieve a manual gateway", "description": "Retrieve a manual gateway", "tags": [ "manual_gateways" ], "parameters": [ { "name": "manualGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The manual gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/manualGatewayResponse" } } } } } }, "patch": { "operationId": "PATCH/manual_gateways/manualGatewayId", "summary": "Update a manual gateway", "description": "Update a manual gateway", "tags": [ "manual_gateways" ], "parameters": [ { "name": "manualGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/manualGatewayUpdate" } } } }, "responses": { "200": { "description": "The updated manual gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/manualGatewayResponse" } } } } } }, "delete": { "operationId": "DELETE/manual_gateways/manualGatewayId", "summary": "Delete a manual gateway", "description": "Delete a manual gateway", "tags": [ "manual_gateways" ], "parameters": [ { "name": "manualGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/manual_gateways/{manualGatewayId}/payment_methods": { "get": { "operationId": "GET/manualGatewayId/payment_methods", "summary": "Retrieve the payment methods associated to the manual gateway", "description": "Retrieve the payment methods associated to the manual gateway", "tags": [ "has_many", "payment_methods" ], "parameters": [ { "name": "manualGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_methods associated to the manual gateway" } } } }, "/manual_gateways/{manualGatewayId}/event_stores": { "get": { "operationId": "GET/manualGatewayId/event_stores", "summary": "Retrieve the event stores associated to the manual gateway", "description": "Retrieve the event stores associated to the manual gateway", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "manualGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the manual gateway" } } } }, "/manual_tax_calculators": { "get": { "operationId": "GET/manual_tax_calculators", "summary": "List all manual tax calculators", "description": "List all manual tax calculators", "tags": [ "manual_tax_calculators" ], "responses": { "200": { "description": "A list of manual tax calculator objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/manualTaxCalculatorResponseList" } } } } } }, "post": { "operationId": "POST/manual_tax_calculators", "summary": "Create a manual tax calculator", "description": "Create a manual tax calculator", "tags": [ "manual_tax_calculators" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/manualTaxCalculatorCreate" } } } }, "responses": { "201": { "description": "The created manual tax calculator object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/manualTaxCalculatorResponse" } } } } } } }, "/manual_tax_calculators/{manualTaxCalculatorId}": { "get": { "operationId": "GET/manual_tax_calculators/manualTaxCalculatorId", "summary": "Retrieve a manual tax calculator", "description": "Retrieve a manual tax calculator", "tags": [ "manual_tax_calculators" ], "parameters": [ { "name": "manualTaxCalculatorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The manual tax calculator object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/manualTaxCalculatorResponse" } } } } } }, "patch": { "operationId": "PATCH/manual_tax_calculators/manualTaxCalculatorId", "summary": "Update a manual tax calculator", "description": "Update a manual tax calculator", "tags": [ "manual_tax_calculators" ], "parameters": [ { "name": "manualTaxCalculatorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/manualTaxCalculatorUpdate" } } } }, "responses": { "200": { "description": "The updated manual tax calculator object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/manualTaxCalculatorResponse" } } } } } }, "delete": { "operationId": "DELETE/manual_tax_calculators/manualTaxCalculatorId", "summary": "Delete a manual tax calculator", "description": "Delete a manual tax calculator", "tags": [ "manual_tax_calculators" ], "parameters": [ { "name": "manualTaxCalculatorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/manual_tax_calculators/{manualTaxCalculatorId}/markets": { "get": { "operationId": "GET/manualTaxCalculatorId/markets", "summary": "Retrieve the markets associated to the manual tax calculator", "description": "Retrieve the markets associated to the manual tax calculator", "tags": [ "has_many", "markets" ], "parameters": [ { "name": "manualTaxCalculatorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The markets associated to the manual tax calculator" } } } }, "/manual_tax_calculators/{manualTaxCalculatorId}/attachments": { "get": { "operationId": "GET/manualTaxCalculatorId/attachments", "summary": "Retrieve the attachments associated to the manual tax calculator", "description": "Retrieve the attachments associated to the manual tax calculator", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "manualTaxCalculatorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the manual tax calculator" } } } }, "/manual_tax_calculators/{manualTaxCalculatorId}/events": { "get": { "operationId": "GET/manualTaxCalculatorId/events", "summary": "Retrieve the events associated to the manual tax calculator", "description": "Retrieve the events associated to the manual tax calculator", "tags": [ "has_many", "events" ], "parameters": [ { "name": "manualTaxCalculatorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the manual tax calculator" } } } }, "/manual_tax_calculators/{manualTaxCalculatorId}/event_stores": { "get": { "operationId": "GET/manualTaxCalculatorId/event_stores", "summary": "Retrieve the event stores associated to the manual tax calculator", "description": "Retrieve the event stores associated to the manual tax calculator", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "manualTaxCalculatorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the manual tax calculator" } } } }, "/manual_tax_calculators/{manualTaxCalculatorId}/tax_rules": { "get": { "operationId": "GET/manualTaxCalculatorId/tax_rules", "summary": "Retrieve the tax rules associated to the manual tax calculator", "description": "Retrieve the tax rules associated to the manual tax calculator", "tags": [ "has_many", "tax_rules" ], "parameters": [ { "name": "manualTaxCalculatorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tax_rules associated to the manual tax calculator" } } } }, "/markets": { "get": { "operationId": "GET/markets", "summary": "List all markets", "description": "List all markets", "tags": [ "markets" ], "responses": { "200": { "description": "A list of market objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/marketResponseList" } } } } } }, "post": { "operationId": "POST/markets", "summary": "Create a market", "description": "Create a market", "tags": [ "markets" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/marketCreate" } } } }, "responses": { "201": { "description": "The created market object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/marketResponse" } } } } } } }, "/markets/{marketId}": { "get": { "operationId": "GET/markets/marketId", "summary": "Retrieve a market", "description": "Retrieve a market", "tags": [ "markets" ], "parameters": [ { "name": "marketId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The market object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/marketResponse" } } } } } }, "patch": { "operationId": "PATCH/markets/marketId", "summary": "Update a market", "description": "Update a market", "tags": [ "markets" ], "parameters": [ { "name": "marketId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/marketUpdate" } } } }, "responses": { "200": { "description": "The updated market object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/marketResponse" } } } } } }, "delete": { "operationId": "DELETE/markets/marketId", "summary": "Delete a market", "description": "Delete a market", "tags": [ "markets" ], "parameters": [ { "name": "marketId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/markets/{marketId}/merchant": { "get": { "operationId": "GET/marketId/merchant", "summary": "Retrieve the merchant associated to the market", "description": "Retrieve the merchant associated to the market", "tags": [ "has_one", "merchants" ], "parameters": [ { "name": "marketId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The merchant associated to the market" } } } }, "/markets/{marketId}/price_list": { "get": { "operationId": "GET/marketId/price_list", "summary": "Retrieve the price list associated to the market", "description": "Retrieve the price list associated to the market", "tags": [ "has_one", "price_lists" ], "parameters": [ { "name": "marketId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The price_list associated to the market" } } } }, "/markets/{marketId}/base_price_list": { "get": { "operationId": "GET/marketId/base_price_list", "summary": "Retrieve the base price list associated to the market", "description": "Retrieve the base price list associated to the market", "tags": [ "has_one", "price_lists" ], "parameters": [ { "name": "marketId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The base_price_list associated to the market" } } } }, "/markets/{marketId}/inventory_model": { "get": { "operationId": "GET/marketId/inventory_model", "summary": "Retrieve the inventory model associated to the market", "description": "Retrieve the inventory model associated to the market", "tags": [ "has_one", "inventory_models" ], "parameters": [ { "name": "marketId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The inventory_model associated to the market" } } } }, "/markets/{marketId}/subscription_model": { "get": { "operationId": "GET/marketId/subscription_model", "summary": "Retrieve the subscription model associated to the market", "description": "Retrieve the subscription model associated to the market", "tags": [ "has_one", "subscription_models" ], "parameters": [ { "name": "marketId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The subscription_model associated to the market" } } } }, "/markets/{marketId}/discount_engine": { "get": { "operationId": "GET/marketId/discount_engine", "summary": "Retrieve the discount engine associated to the market", "description": "Retrieve the discount engine associated to the market", "tags": [ "has_one", "discount_engines" ], "parameters": [ { "name": "marketId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The discount_engine associated to the market" } } } }, "/markets/{marketId}/customer_group": { "get": { "operationId": "GET/marketId/customer_group", "summary": "Retrieve the customer group associated to the market", "description": "Retrieve the customer group associated to the market", "tags": [ "has_one", "customer_groups" ], "parameters": [ { "name": "marketId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer_group associated to the market" } } } }, "/markets/{marketId}/geocoder": { "get": { "operationId": "GET/marketId/geocoder", "summary": "Retrieve the geocoder associated to the market", "description": "Retrieve the geocoder associated to the market", "tags": [ "has_one", "geocoders" ], "parameters": [ { "name": "marketId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The geocoder associated to the market" } } } }, "/markets/{marketId}/default_shipping_method": { "get": { "operationId": "GET/marketId/default_shipping_method", "summary": "Retrieve the default shipping method associated to the market", "description": "Retrieve the default shipping method associated to the market", "tags": [ "has_one", "shipping_methods" ], "parameters": [ { "name": "marketId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The default_shipping_method associated to the market" } } } }, "/markets/{marketId}/default_payment_method": { "get": { "operationId": "GET/marketId/default_payment_method", "summary": "Retrieve the default payment method associated to the market", "description": "Retrieve the default payment method associated to the market", "tags": [ "has_one", "payment_methods" ], "parameters": [ { "name": "marketId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The default_payment_method associated to the market" } } } }, "/markets/{marketId}/stores": { "get": { "operationId": "GET/marketId/stores", "summary": "Retrieve the stores associated to the market", "description": "Retrieve the stores associated to the market", "tags": [ "has_many", "stores" ], "parameters": [ { "name": "marketId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stores associated to the market" } } } }, "/markets/{marketId}/price_list_schedulers": { "get": { "operationId": "GET/marketId/price_list_schedulers", "summary": "Retrieve the price list schedulers associated to the market", "description": "Retrieve the price list schedulers associated to the market", "tags": [ "has_many", "price_list_schedulers" ], "parameters": [ { "name": "marketId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The price_list_schedulers associated to the market" } } } }, "/markets/{marketId}/attachments": { "get": { "operationId": "GET/marketId/attachments", "summary": "Retrieve the attachments associated to the market", "description": "Retrieve the attachments associated to the market", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "marketId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the market" } } } }, "/markets/{marketId}/event_stores": { "get": { "operationId": "GET/marketId/event_stores", "summary": "Retrieve the event stores associated to the market", "description": "Retrieve the event stores associated to the market", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "marketId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the market" } } } }, "/merchants": { "get": { "operationId": "GET/merchants", "summary": "List all merchants", "description": "List all merchants", "tags": [ "merchants" ], "responses": { "200": { "description": "A list of merchant objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/merchantResponseList" } } } } } }, "post": { "operationId": "POST/merchants", "summary": "Create a merchant", "description": "Create a merchant", "tags": [ "merchants" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/merchantCreate" } } } }, "responses": { "201": { "description": "The created merchant object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/merchantResponse" } } } } } } }, "/merchants/{merchantId}": { "get": { "operationId": "GET/merchants/merchantId", "summary": "Retrieve a merchant", "description": "Retrieve a merchant", "tags": [ "merchants" ], "parameters": [ { "name": "merchantId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The merchant object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/merchantResponse" } } } } } }, "patch": { "operationId": "PATCH/merchants/merchantId", "summary": "Update a merchant", "description": "Update a merchant", "tags": [ "merchants" ], "parameters": [ { "name": "merchantId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/merchantUpdate" } } } }, "responses": { "200": { "description": "The updated merchant object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/merchantResponse" } } } } } }, "delete": { "operationId": "DELETE/merchants/merchantId", "summary": "Delete a merchant", "description": "Delete a merchant", "tags": [ "merchants" ], "parameters": [ { "name": "merchantId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/merchants/{merchantId}/address": { "get": { "operationId": "GET/merchantId/address", "summary": "Retrieve the address associated to the merchant", "description": "Retrieve the address associated to the merchant", "tags": [ "has_one", "addresses" ], "parameters": [ { "name": "merchantId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The address associated to the merchant" } } } }, "/merchants/{merchantId}/attachments": { "get": { "operationId": "GET/merchantId/attachments", "summary": "Retrieve the attachments associated to the merchant", "description": "Retrieve the attachments associated to the merchant", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "merchantId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the merchant" } } } }, "/merchants/{merchantId}/event_stores": { "get": { "operationId": "GET/merchantId/event_stores", "summary": "Retrieve the event stores associated to the merchant", "description": "Retrieve the event stores associated to the merchant", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "merchantId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the merchant" } } } }, "/notifications": { "get": { "operationId": "GET/notifications", "summary": "List all notifications", "description": "List all notifications", "tags": [ "notifications" ], "responses": { "200": { "description": "A list of notification objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/notificationResponseList" } } } } } }, "post": { "operationId": "POST/notifications", "summary": "Create a notification", "description": "Create a notification", "tags": [ "notifications" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/notificationCreate" } } } }, "responses": { "201": { "description": "The created notification object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/notificationResponse" } } } } } } }, "/notifications/{notificationId}": { "get": { "operationId": "GET/notifications/notificationId", "summary": "Retrieve a notification", "description": "Retrieve a notification", "tags": [ "notifications" ], "parameters": [ { "name": "notificationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The notification object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/notificationResponse" } } } } } }, "patch": { "operationId": "PATCH/notifications/notificationId", "summary": "Update a notification", "description": "Update a notification", "tags": [ "notifications" ], "parameters": [ { "name": "notificationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/notificationUpdate" } } } }, "responses": { "200": { "description": "The updated notification object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/notificationResponse" } } } } } }, "delete": { "operationId": "DELETE/notifications/notificationId", "summary": "Delete a notification", "description": "Delete a notification", "tags": [ "notifications" ], "parameters": [ { "name": "notificationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/notifications/{notificationId}/event_stores": { "get": { "operationId": "GET/notificationId/event_stores", "summary": "Retrieve the event stores associated to the notification", "description": "Retrieve the event stores associated to the notification", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "notificationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the notification" } } } }, "/order_amount_promotion_rules": { "get": { "operationId": "GET/order_amount_promotion_rules", "summary": "List all order amount promotion rules", "description": "List all order amount promotion rules", "tags": [ "order_amount_promotion_rules" ], "responses": { "200": { "description": "A list of order amount promotion rule objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderAmountPromotionRuleResponseList" } } } } } }, "post": { "operationId": "POST/order_amount_promotion_rules", "summary": "Create an order amount promotion rule", "description": "Create an order amount promotion rule", "tags": [ "order_amount_promotion_rules" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderAmountPromotionRuleCreate" } } } }, "responses": { "201": { "description": "The created order amount promotion rule object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderAmountPromotionRuleResponse" } } } } } } }, "/order_amount_promotion_rules/{orderAmountPromotionRuleId}": { "get": { "operationId": "GET/order_amount_promotion_rules/orderAmountPromotionRuleId", "summary": "Retrieve an order amount promotion rule", "description": "Retrieve an order amount promotion rule", "tags": [ "order_amount_promotion_rules" ], "parameters": [ { "name": "orderAmountPromotionRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order amount promotion rule object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderAmountPromotionRuleResponse" } } } } } }, "patch": { "operationId": "PATCH/order_amount_promotion_rules/orderAmountPromotionRuleId", "summary": "Update an order amount promotion rule", "description": "Update an order amount promotion rule", "tags": [ "order_amount_promotion_rules" ], "parameters": [ { "name": "orderAmountPromotionRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderAmountPromotionRuleUpdate" } } } }, "responses": { "200": { "description": "The updated order amount promotion rule object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderAmountPromotionRuleResponse" } } } } } }, "delete": { "operationId": "DELETE/order_amount_promotion_rules/orderAmountPromotionRuleId", "summary": "Delete an order amount promotion rule", "description": "Delete an order amount promotion rule", "tags": [ "order_amount_promotion_rules" ], "parameters": [ { "name": "orderAmountPromotionRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/order_amount_promotion_rules/{orderAmountPromotionRuleId}/event_stores": { "get": { "operationId": "GET/orderAmountPromotionRuleId/event_stores", "summary": "Retrieve the event stores associated to the order amount promotion rule", "description": "Retrieve the event stores associated to the order amount promotion rule", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "orderAmountPromotionRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the order amount promotion rule" } } } }, "/order_copies": { "get": { "operationId": "GET/order_copies", "summary": "List all order copies", "description": "List all order copies", "tags": [ "order_copies" ], "responses": { "200": { "description": "A list of order copy objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderCopyResponseList" } } } } } }, "post": { "operationId": "POST/order_copies", "summary": "Create an order copy", "description": "Create an order copy", "tags": [ "order_copies" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderCopyCreate" } } } }, "responses": { "201": { "description": "The created order copy object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderCopyResponse" } } } } } } }, "/order_copies/{orderCopyId}": { "get": { "operationId": "GET/order_copies/orderCopyId", "summary": "Retrieve an order copy", "description": "Retrieve an order copy", "tags": [ "order_copies" ], "parameters": [ { "name": "orderCopyId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order copy object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderCopyResponse" } } } } } }, "patch": { "operationId": "PATCH/order_copies/orderCopyId", "summary": "Update an order copy", "description": "Update an order copy", "tags": [ "order_copies" ], "parameters": [ { "name": "orderCopyId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderCopyUpdate" } } } }, "responses": { "200": { "description": "The updated order copy object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderCopyResponse" } } } } } }, "delete": { "operationId": "DELETE/order_copies/orderCopyId", "summary": "Delete an order copy", "description": "Delete an order copy", "tags": [ "order_copies" ], "parameters": [ { "name": "orderCopyId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/order_copies/{orderCopyId}/source_order": { "get": { "operationId": "GET/orderCopyId/source_order", "summary": "Retrieve the source order associated to the order copy", "description": "Retrieve the source order associated to the order copy", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "orderCopyId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The source_order associated to the order copy" } } } }, "/order_copies/{orderCopyId}/target_order": { "get": { "operationId": "GET/orderCopyId/target_order", "summary": "Retrieve the target order associated to the order copy", "description": "Retrieve the target order associated to the order copy", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "orderCopyId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The target_order associated to the order copy" } } } }, "/order_copies/{orderCopyId}/events": { "get": { "operationId": "GET/orderCopyId/events", "summary": "Retrieve the events associated to the order copy", "description": "Retrieve the events associated to the order copy", "tags": [ "has_many", "events" ], "parameters": [ { "name": "orderCopyId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the order copy" } } } }, "/order_copies/{orderCopyId}/event_stores": { "get": { "operationId": "GET/orderCopyId/event_stores", "summary": "Retrieve the event stores associated to the order copy", "description": "Retrieve the event stores associated to the order copy", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "orderCopyId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the order copy" } } } }, "/order_copies/{orderCopyId}/order_subscription": { "get": { "operationId": "GET/orderCopyId/order_subscription", "summary": "Retrieve the order subscription associated to the order copy", "description": "Retrieve the order subscription associated to the order copy", "tags": [ "has_one", "order_subscriptions" ], "parameters": [ { "name": "orderCopyId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order_subscription associated to the order copy" } } } }, "/order_factories": { "get": { "operationId": "GET/order_factories", "summary": "List all order factories", "description": "List all order factories", "tags": [ "order_factories" ], "responses": { "200": { "description": "A list of order factory objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderFactoryResponseList" } } } } } } }, "/order_factories/{orderFactoryId}": { "get": { "operationId": "GET/order_factories/orderFactoryId", "summary": "Retrieve an order factory", "description": "Retrieve an order factory", "tags": [ "order_factories" ], "parameters": [ { "name": "orderFactoryId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order factory object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderFactoryResponse" } } } } } } }, "/order_factories/{orderFactoryId}/source_order": { "get": { "operationId": "GET/orderFactoryId/source_order", "summary": "Retrieve the source order associated to the order factory", "description": "Retrieve the source order associated to the order factory", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "orderFactoryId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The source_order associated to the order factory" } } } }, "/order_factories/{orderFactoryId}/target_order": { "get": { "operationId": "GET/orderFactoryId/target_order", "summary": "Retrieve the target order associated to the order factory", "description": "Retrieve the target order associated to the order factory", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "orderFactoryId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The target_order associated to the order factory" } } } }, "/order_factories/{orderFactoryId}/events": { "get": { "operationId": "GET/orderFactoryId/events", "summary": "Retrieve the events associated to the order factory", "description": "Retrieve the events associated to the order factory", "tags": [ "has_many", "events" ], "parameters": [ { "name": "orderFactoryId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the order factory" } } } }, "/order_factories/{orderFactoryId}/event_stores": { "get": { "operationId": "GET/orderFactoryId/event_stores", "summary": "Retrieve the event stores associated to the order factory", "description": "Retrieve the event stores associated to the order factory", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "orderFactoryId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the order factory" } } } }, "/order_subscription_items": { "get": { "operationId": "GET/order_subscription_items", "summary": "List all order subscription items", "description": "List all order subscription items", "tags": [ "order_subscription_items" ], "responses": { "200": { "description": "A list of order subscription item objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderSubscriptionItemResponseList" } } } } } }, "post": { "operationId": "POST/order_subscription_items", "summary": "Create an order subscription item", "description": "Create an order subscription item", "tags": [ "order_subscription_items" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderSubscriptionItemCreate" } } } }, "responses": { "201": { "description": "The created order subscription item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderSubscriptionItemResponse" } } } } } } }, "/order_subscription_items/{orderSubscriptionItemId}": { "get": { "operationId": "GET/order_subscription_items/orderSubscriptionItemId", "summary": "Retrieve an order subscription item", "description": "Retrieve an order subscription item", "tags": [ "order_subscription_items" ], "parameters": [ { "name": "orderSubscriptionItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order subscription item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderSubscriptionItemResponse" } } } } } }, "patch": { "operationId": "PATCH/order_subscription_items/orderSubscriptionItemId", "summary": "Update an order subscription item", "description": "Update an order subscription item", "tags": [ "order_subscription_items" ], "parameters": [ { "name": "orderSubscriptionItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderSubscriptionItemUpdate" } } } }, "responses": { "200": { "description": "The updated order subscription item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderSubscriptionItemResponse" } } } } } }, "delete": { "operationId": "DELETE/order_subscription_items/orderSubscriptionItemId", "summary": "Delete an order subscription item", "description": "Delete an order subscription item", "tags": [ "order_subscription_items" ], "parameters": [ { "name": "orderSubscriptionItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/order_subscription_items/{orderSubscriptionItemId}/order_subscription": { "get": { "operationId": "GET/orderSubscriptionItemId/order_subscription", "summary": "Retrieve the order subscription associated to the order subscription item", "description": "Retrieve the order subscription associated to the order subscription item", "tags": [ "has_one", "order_subscriptions" ], "parameters": [ { "name": "orderSubscriptionItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order_subscription associated to the order subscription item" } } } }, "/order_subscription_items/{orderSubscriptionItemId}/source_line_item": { "get": { "operationId": "GET/orderSubscriptionItemId/source_line_item", "summary": "Retrieve the source line item associated to the order subscription item", "description": "Retrieve the source line item associated to the order subscription item", "tags": [ "has_one", "line_items" ], "parameters": [ { "name": "orderSubscriptionItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The source_line_item associated to the order subscription item" } } } }, "/order_subscription_items/{orderSubscriptionItemId}/event_stores": { "get": { "operationId": "GET/orderSubscriptionItemId/event_stores", "summary": "Retrieve the event stores associated to the order subscription item", "description": "Retrieve the event stores associated to the order subscription item", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "orderSubscriptionItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the order subscription item" } } } }, "/order_subscriptions": { "get": { "operationId": "GET/order_subscriptions", "summary": "List all order subscriptions", "description": "List all order subscriptions", "tags": [ "order_subscriptions" ], "responses": { "200": { "description": "A list of order subscription objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderSubscriptionResponseList" } } } } } }, "post": { "operationId": "POST/order_subscriptions", "summary": "Create an order subscription", "description": "Create an order subscription", "tags": [ "order_subscriptions" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderSubscriptionCreate" } } } }, "responses": { "201": { "description": "The created order subscription object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderSubscriptionResponse" } } } } } } }, "/order_subscriptions/{orderSubscriptionId}": { "get": { "operationId": "GET/order_subscriptions/orderSubscriptionId", "summary": "Retrieve an order subscription", "description": "Retrieve an order subscription", "tags": [ "order_subscriptions" ], "parameters": [ { "name": "orderSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order subscription object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderSubscriptionResponse" } } } } } }, "patch": { "operationId": "PATCH/order_subscriptions/orderSubscriptionId", "summary": "Update an order subscription", "description": "Update an order subscription", "tags": [ "order_subscriptions" ], "parameters": [ { "name": "orderSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderSubscriptionUpdate" } } } }, "responses": { "200": { "description": "The updated order subscription object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderSubscriptionResponse" } } } } } }, "delete": { "operationId": "DELETE/order_subscriptions/orderSubscriptionId", "summary": "Delete an order subscription", "description": "Delete an order subscription", "tags": [ "order_subscriptions" ], "parameters": [ { "name": "orderSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/order_subscriptions/{orderSubscriptionId}/market": { "get": { "operationId": "GET/orderSubscriptionId/market", "summary": "Retrieve the market associated to the order subscription", "description": "Retrieve the market associated to the order subscription", "tags": [ "has_one", "markets" ], "parameters": [ { "name": "orderSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The market associated to the order subscription" } } } }, "/order_subscriptions/{orderSubscriptionId}/subscription_model": { "get": { "operationId": "GET/orderSubscriptionId/subscription_model", "summary": "Retrieve the subscription model associated to the order subscription", "description": "Retrieve the subscription model associated to the order subscription", "tags": [ "has_one", "subscription_models" ], "parameters": [ { "name": "orderSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The subscription_model associated to the order subscription" } } } }, "/order_subscriptions/{orderSubscriptionId}/source_order": { "get": { "operationId": "GET/orderSubscriptionId/source_order", "summary": "Retrieve the source order associated to the order subscription", "description": "Retrieve the source order associated to the order subscription", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "orderSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The source_order associated to the order subscription" } } } }, "/order_subscriptions/{orderSubscriptionId}/customer": { "get": { "operationId": "GET/orderSubscriptionId/customer", "summary": "Retrieve the customer associated to the order subscription", "description": "Retrieve the customer associated to the order subscription", "tags": [ "has_one", "customers" ], "parameters": [ { "name": "orderSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer associated to the order subscription" } } } }, "/order_subscriptions/{orderSubscriptionId}/customer_payment_source": { "get": { "operationId": "GET/orderSubscriptionId/customer_payment_source", "summary": "Retrieve the customer payment source associated to the order subscription", "description": "Retrieve the customer payment source associated to the order subscription", "tags": [ "has_one", "customer_payment_sources" ], "parameters": [ { "name": "orderSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer_payment_source associated to the order subscription" } } } }, "/order_subscriptions/{orderSubscriptionId}/order_subscription_items": { "get": { "operationId": "GET/orderSubscriptionId/order_subscription_items", "summary": "Retrieve the order subscription items associated to the order subscription", "description": "Retrieve the order subscription items associated to the order subscription", "tags": [ "has_many", "order_subscription_items" ], "parameters": [ { "name": "orderSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order_subscription_items associated to the order subscription" } } } }, "/order_subscriptions/{orderSubscriptionId}/order_factories": { "get": { "operationId": "GET/orderSubscriptionId/order_factories", "summary": "Retrieve the order factories associated to the order subscription", "description": "Retrieve the order factories associated to the order subscription", "tags": [ "has_many", "order_factories" ], "parameters": [ { "name": "orderSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order_factories associated to the order subscription" } } } }, "/order_subscriptions/{orderSubscriptionId}/recurring_order_copies": { "get": { "operationId": "GET/orderSubscriptionId/recurring_order_copies", "summary": "Retrieve the recurring order copies associated to the order subscription", "description": "Retrieve the recurring order copies associated to the order subscription", "tags": [ "has_many", "recurring_order_copies" ], "parameters": [ { "name": "orderSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The recurring_order_copies associated to the order subscription" } } } }, "/order_subscriptions/{orderSubscriptionId}/orders": { "get": { "operationId": "GET/orderSubscriptionId/orders", "summary": "Retrieve the orders associated to the order subscription", "description": "Retrieve the orders associated to the order subscription", "tags": [ "has_many", "orders" ], "parameters": [ { "name": "orderSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The orders associated to the order subscription" } } } }, "/order_subscriptions/{orderSubscriptionId}/events": { "get": { "operationId": "GET/orderSubscriptionId/events", "summary": "Retrieve the events associated to the order subscription", "description": "Retrieve the events associated to the order subscription", "tags": [ "has_many", "events" ], "parameters": [ { "name": "orderSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the order subscription" } } } }, "/order_subscriptions/{orderSubscriptionId}/tags": { "get": { "operationId": "GET/orderSubscriptionId/tags", "summary": "Retrieve the tags associated to the order subscription", "description": "Retrieve the tags associated to the order subscription", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "orderSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the order subscription" } } } }, "/order_subscriptions/{orderSubscriptionId}/event_stores": { "get": { "operationId": "GET/orderSubscriptionId/event_stores", "summary": "Retrieve the event stores associated to the order subscription", "description": "Retrieve the event stores associated to the order subscription", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "orderSubscriptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the order subscription" } } } }, "/orders": { "get": { "operationId": "GET/orders", "summary": "List all orders", "description": "List all orders", "tags": [ "orders" ], "responses": { "200": { "description": "A list of order objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderResponseList" } } } } } }, "post": { "operationId": "POST/orders", "summary": "Create an order", "description": "Create an order", "tags": [ "orders" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderCreate" } } } }, "responses": { "201": { "description": "The created order object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderResponse" } } } } } } }, "/orders/{orderId}": { "get": { "operationId": "GET/orders/orderId", "summary": "Retrieve an order", "description": "Retrieve an order", "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderResponse" } } } } } }, "patch": { "operationId": "PATCH/orders/orderId", "summary": "Update an order", "description": "Update an order", "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderUpdate" } } } }, "responses": { "200": { "description": "The updated order object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/orderResponse" } } } } } }, "delete": { "operationId": "DELETE/orders/orderId", "summary": "Delete an order", "description": "Delete an order", "tags": [ "orders" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/orders/{orderId}/market": { "get": { "operationId": "GET/orderId/market", "summary": "Retrieve the market associated to the order", "description": "Retrieve the market associated to the order", "tags": [ "has_one", "markets" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The market associated to the order" } } } }, "/orders/{orderId}/customer": { "get": { "operationId": "GET/orderId/customer", "summary": "Retrieve the customer associated to the order", "description": "Retrieve the customer associated to the order", "tags": [ "has_one", "customers" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer associated to the order" } } } }, "/orders/{orderId}/shipping_address": { "get": { "operationId": "GET/orderId/shipping_address", "summary": "Retrieve the shipping address associated to the order", "description": "Retrieve the shipping address associated to the order", "tags": [ "has_one", "addresses" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipping_address associated to the order" } } } }, "/orders/{orderId}/billing_address": { "get": { "operationId": "GET/orderId/billing_address", "summary": "Retrieve the billing address associated to the order", "description": "Retrieve the billing address associated to the order", "tags": [ "has_one", "addresses" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The billing_address associated to the order" } } } }, "/orders/{orderId}/store": { "get": { "operationId": "GET/orderId/store", "summary": "Retrieve the store associated to the order", "description": "Retrieve the store associated to the order", "tags": [ "has_one", "stores" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The store associated to the order" } } } }, "/orders/{orderId}/default_shipping_method": { "get": { "operationId": "GET/orderId/default_shipping_method", "summary": "Retrieve the default shipping method associated to the order", "description": "Retrieve the default shipping method associated to the order", "tags": [ "has_one", "shipping_methods" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The default_shipping_method associated to the order" } } } }, "/orders/{orderId}/default_payment_method": { "get": { "operationId": "GET/orderId/default_payment_method", "summary": "Retrieve the default payment method associated to the order", "description": "Retrieve the default payment method associated to the order", "tags": [ "has_one", "payment_methods" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The default_payment_method associated to the order" } } } }, "/orders/{orderId}/available_payment_methods": { "get": { "operationId": "GET/orderId/available_payment_methods", "summary": "Retrieve the available payment methods associated to the order", "description": "Retrieve the available payment methods associated to the order", "tags": [ "has_many", "payment_methods" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The available_payment_methods associated to the order" } } } }, "/orders/{orderId}/available_customer_payment_sources": { "get": { "operationId": "GET/orderId/available_customer_payment_sources", "summary": "Retrieve the available customer payment sources associated to the order", "description": "Retrieve the available customer payment sources associated to the order", "tags": [ "has_many", "customer_payment_sources" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The available_customer_payment_sources associated to the order" } } } }, "/orders/{orderId}/available_free_skus": { "get": { "operationId": "GET/orderId/available_free_skus", "summary": "Retrieve the available free skus associated to the order", "description": "Retrieve the available free skus associated to the order", "tags": [ "has_many", "skus" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The available_free_skus associated to the order" } } } }, "/orders/{orderId}/available_free_bundles": { "get": { "operationId": "GET/orderId/available_free_bundles", "summary": "Retrieve the available free bundles associated to the order", "description": "Retrieve the available free bundles associated to the order", "tags": [ "has_many", "bundles" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The available_free_bundles associated to the order" } } } }, "/orders/{orderId}/payment_method": { "get": { "operationId": "GET/orderId/payment_method", "summary": "Retrieve the payment method associated to the order", "description": "Retrieve the payment method associated to the order", "tags": [ "has_one", "payment_methods" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_method associated to the order" } } } }, "/orders/{orderId}/discount_engine_item": { "get": { "operationId": "GET/orderId/discount_engine_item", "summary": "Retrieve the discount engine item associated to the order", "description": "Retrieve the discount engine item associated to the order", "tags": [ "has_one", "discount_engine_items" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The discount_engine_item associated to the order" } } } }, "/orders/{orderId}/line_items": { "get": { "operationId": "GET/orderId/line_items", "summary": "Retrieve the line items associated to the order", "description": "Retrieve the line items associated to the order", "tags": [ "has_many", "line_items" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The line_items associated to the order" } } } }, "/orders/{orderId}/line_item_options": { "get": { "operationId": "GET/orderId/line_item_options", "summary": "Retrieve the line item options associated to the order", "description": "Retrieve the line item options associated to the order", "tags": [ "has_many", "line_item_options" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The line_item_options associated to the order" } } } }, "/orders/{orderId}/stock_reservations": { "get": { "operationId": "GET/orderId/stock_reservations", "summary": "Retrieve the stock reservations associated to the order", "description": "Retrieve the stock reservations associated to the order", "tags": [ "has_many", "stock_reservations" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_reservations associated to the order" } } } }, "/orders/{orderId}/stock_line_items": { "get": { "operationId": "GET/orderId/stock_line_items", "summary": "Retrieve the stock line items associated to the order", "description": "Retrieve the stock line items associated to the order", "tags": [ "has_many", "stock_line_items" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_line_items associated to the order" } } } }, "/orders/{orderId}/stock_transfers": { "get": { "operationId": "GET/orderId/stock_transfers", "summary": "Retrieve the stock transfers associated to the order", "description": "Retrieve the stock transfers associated to the order", "tags": [ "has_many", "stock_transfers" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_transfers associated to the order" } } } }, "/orders/{orderId}/shipments": { "get": { "operationId": "GET/orderId/shipments", "summary": "Retrieve the shipments associated to the order", "description": "Retrieve the shipments associated to the order", "tags": [ "has_many", "shipments" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipments associated to the order" } } } }, "/orders/{orderId}/payment_options": { "get": { "operationId": "GET/orderId/payment_options", "summary": "Retrieve the payment options associated to the order", "description": "Retrieve the payment options associated to the order", "tags": [ "has_many", "payment_options" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_options associated to the order" } } } }, "/orders/{orderId}/authorizations": { "get": { "operationId": "GET/orderId/authorizations", "summary": "Retrieve the authorizations associated to the order", "description": "Retrieve the authorizations associated to the order", "tags": [ "has_many", "authorizations" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The authorizations associated to the order" } } } }, "/orders/{orderId}/captures": { "get": { "operationId": "GET/orderId/captures", "summary": "Retrieve the captures associated to the order", "description": "Retrieve the captures associated to the order", "tags": [ "has_many", "captures" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The captures associated to the order" } } } }, "/orders/{orderId}/voids": { "get": { "operationId": "GET/orderId/voids", "summary": "Retrieve the voids associated to the order", "description": "Retrieve the voids associated to the order", "tags": [ "has_many", "voids" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The voids associated to the order" } } } }, "/orders/{orderId}/refunds": { "get": { "operationId": "GET/orderId/refunds", "summary": "Retrieve the refunds associated to the order", "description": "Retrieve the refunds associated to the order", "tags": [ "has_many", "refunds" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The refunds associated to the order" } } } }, "/orders/{orderId}/returns": { "get": { "operationId": "GET/orderId/returns", "summary": "Retrieve the returns associated to the order", "description": "Retrieve the returns associated to the order", "tags": [ "has_many", "returns" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The returns associated to the order" } } } }, "/orders/{orderId}/order_subscription": { "get": { "operationId": "GET/orderId/order_subscription", "summary": "Retrieve the order subscription associated to the order", "description": "Retrieve the order subscription associated to the order", "tags": [ "has_one", "order_subscriptions" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order_subscription associated to the order" } } } }, "/orders/{orderId}/order_subscriptions": { "get": { "operationId": "GET/orderId/order_subscriptions", "summary": "Retrieve the order subscriptions associated to the order", "description": "Retrieve the order subscriptions associated to the order", "tags": [ "has_many", "order_subscriptions" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order_subscriptions associated to the order" } } } }, "/orders/{orderId}/order_factories": { "get": { "operationId": "GET/orderId/order_factories", "summary": "Retrieve the order factories associated to the order", "description": "Retrieve the order factories associated to the order", "tags": [ "has_many", "order_factories" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order_factories associated to the order" } } } }, "/orders/{orderId}/order_copies": { "get": { "operationId": "GET/orderId/order_copies", "summary": "Retrieve the order copies associated to the order", "description": "Retrieve the order copies associated to the order", "tags": [ "has_many", "order_copies" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order_copies associated to the order" } } } }, "/orders/{orderId}/recurring_order_copies": { "get": { "operationId": "GET/orderId/recurring_order_copies", "summary": "Retrieve the recurring order copies associated to the order", "description": "Retrieve the recurring order copies associated to the order", "tags": [ "has_many", "recurring_order_copies" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The recurring_order_copies associated to the order" } } } }, "/orders/{orderId}/attachments": { "get": { "operationId": "GET/orderId/attachments", "summary": "Retrieve the attachments associated to the order", "description": "Retrieve the attachments associated to the order", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the order" } } } }, "/orders/{orderId}/notifications": { "get": { "operationId": "GET/orderId/notifications", "summary": "Retrieve the notifications associated to the order", "description": "Retrieve the notifications associated to the order", "tags": [ "has_many", "notifications" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The notifications associated to the order" } } } }, "/orders/{orderId}/links": { "get": { "operationId": "GET/orderId/links", "summary": "Retrieve the links associated to the order", "description": "Retrieve the links associated to the order", "tags": [ "has_many", "links" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The links associated to the order" } } } }, "/orders/{orderId}/resource_errors": { "get": { "operationId": "GET/orderId/resource_errors", "summary": "Retrieve the resource errors associated to the order", "description": "Retrieve the resource errors associated to the order", "tags": [ "has_many", "resource_errors" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The resource_errors associated to the order" } } } }, "/orders/{orderId}/events": { "get": { "operationId": "GET/orderId/events", "summary": "Retrieve the events associated to the order", "description": "Retrieve the events associated to the order", "tags": [ "has_many", "events" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the order" } } } }, "/orders/{orderId}/tags": { "get": { "operationId": "GET/orderId/tags", "summary": "Retrieve the tags associated to the order", "description": "Retrieve the tags associated to the order", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the order" } } } }, "/orders/{orderId}/event_stores": { "get": { "operationId": "GET/orderId/event_stores", "summary": "Retrieve the event stores associated to the order", "description": "Retrieve the event stores associated to the order", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "orderId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the order" } } } }, "/organization": { "get": { "operationId": "GET/organization/organizationId", "summary": "Retrieve the organization", "description": "Retrieve the organization", "tags": [ "organization", "singleton" ], "responses": { "200": { "description": "The organization object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/organizationResponse" } } } } } } }, "/organization/{organizationId}/event_stores": { "get": { "operationId": "GET/organizationId/event_stores", "summary": "Retrieve the event stores associated to the organization", "description": "Retrieve the event stores associated to the organization", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the organization" } } } }, "/packages": { "get": { "operationId": "GET/packages", "summary": "List all packages", "description": "List all packages", "tags": [ "packages" ], "responses": { "200": { "description": "A list of package objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/packageResponseList" } } } } } }, "post": { "operationId": "POST/packages", "summary": "Create a package", "description": "Create a package", "tags": [ "packages" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/packageCreate" } } } }, "responses": { "201": { "description": "The created package object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/packageResponse" } } } } } } }, "/packages/{packageId}": { "get": { "operationId": "GET/packages/packageId", "summary": "Retrieve a package", "description": "Retrieve a package", "tags": [ "packages" ], "parameters": [ { "name": "packageId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The package object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/packageResponse" } } } } } }, "patch": { "operationId": "PATCH/packages/packageId", "summary": "Update a package", "description": "Update a package", "tags": [ "packages" ], "parameters": [ { "name": "packageId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/packageUpdate" } } } }, "responses": { "200": { "description": "The updated package object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/packageResponse" } } } } } }, "delete": { "operationId": "DELETE/packages/packageId", "summary": "Delete a package", "description": "Delete a package", "tags": [ "packages" ], "parameters": [ { "name": "packageId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/packages/{packageId}/stock_location": { "get": { "operationId": "GET/packageId/stock_location", "summary": "Retrieve the stock location associated to the package", "description": "Retrieve the stock location associated to the package", "tags": [ "has_one", "stock_locations" ], "parameters": [ { "name": "packageId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_location associated to the package" } } } }, "/packages/{packageId}/parcels": { "get": { "operationId": "GET/packageId/parcels", "summary": "Retrieve the parcels associated to the package", "description": "Retrieve the parcels associated to the package", "tags": [ "has_many", "parcels" ], "parameters": [ { "name": "packageId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The parcels associated to the package" } } } }, "/packages/{packageId}/attachments": { "get": { "operationId": "GET/packageId/attachments", "summary": "Retrieve the attachments associated to the package", "description": "Retrieve the attachments associated to the package", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "packageId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the package" } } } }, "/packages/{packageId}/event_stores": { "get": { "operationId": "GET/packageId/event_stores", "summary": "Retrieve the event stores associated to the package", "description": "Retrieve the event stores associated to the package", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "packageId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the package" } } } }, "/parcel_line_items": { "get": { "operationId": "GET/parcel_line_items", "summary": "List all parcel line items", "description": "List all parcel line items", "tags": [ "parcel_line_items" ], "responses": { "200": { "description": "A list of parcel line item objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/parcelLineItemResponseList" } } } } } }, "post": { "operationId": "POST/parcel_line_items", "summary": "Create a parcel line item", "description": "Create a parcel line item", "tags": [ "parcel_line_items" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/parcelLineItemCreate" } } } }, "responses": { "201": { "description": "The created parcel line item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/parcelLineItemResponse" } } } } } } }, "/parcel_line_items/{parcelLineItemId}": { "get": { "operationId": "GET/parcel_line_items/parcelLineItemId", "summary": "Retrieve a parcel line item", "description": "Retrieve a parcel line item", "tags": [ "parcel_line_items" ], "parameters": [ { "name": "parcelLineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The parcel line item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/parcelLineItemResponse" } } } } } }, "patch": { "operationId": "PATCH/parcel_line_items/parcelLineItemId", "summary": "Update a parcel line item", "description": "Update a parcel line item", "tags": [ "parcel_line_items" ], "parameters": [ { "name": "parcelLineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/parcelLineItemUpdate" } } } }, "responses": { "200": { "description": "The updated parcel line item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/parcelLineItemResponse" } } } } } }, "delete": { "operationId": "DELETE/parcel_line_items/parcelLineItemId", "summary": "Delete a parcel line item", "description": "Delete a parcel line item", "tags": [ "parcel_line_items" ], "parameters": [ { "name": "parcelLineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/parcel_line_items/{parcelLineItemId}/parcel": { "get": { "operationId": "GET/parcelLineItemId/parcel", "summary": "Retrieve the parcel associated to the parcel line item", "description": "Retrieve the parcel associated to the parcel line item", "tags": [ "has_one", "parcels" ], "parameters": [ { "name": "parcelLineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The parcel associated to the parcel line item" } } } }, "/parcel_line_items/{parcelLineItemId}/stock_line_item": { "get": { "operationId": "GET/parcelLineItemId/stock_line_item", "summary": "Retrieve the stock line item associated to the parcel line item", "description": "Retrieve the stock line item associated to the parcel line item", "tags": [ "has_one", "stock_line_items" ], "parameters": [ { "name": "parcelLineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_line_item associated to the parcel line item" } } } }, "/parcel_line_items/{parcelLineItemId}/event_stores": { "get": { "operationId": "GET/parcelLineItemId/event_stores", "summary": "Retrieve the event stores associated to the parcel line item", "description": "Retrieve the event stores associated to the parcel line item", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "parcelLineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the parcel line item" } } } }, "/parcels": { "get": { "operationId": "GET/parcels", "summary": "List all parcels", "description": "List all parcels", "tags": [ "parcels" ], "responses": { "200": { "description": "A list of parcel objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/parcelResponseList" } } } } } }, "post": { "operationId": "POST/parcels", "summary": "Create a parcel", "description": "Create a parcel", "tags": [ "parcels" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/parcelCreate" } } } }, "responses": { "201": { "description": "The created parcel object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/parcelResponse" } } } } } } }, "/parcels/{parcelId}": { "get": { "operationId": "GET/parcels/parcelId", "summary": "Retrieve a parcel", "description": "Retrieve a parcel", "tags": [ "parcels" ], "parameters": [ { "name": "parcelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The parcel object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/parcelResponse" } } } } } }, "patch": { "operationId": "PATCH/parcels/parcelId", "summary": "Update a parcel", "description": "Update a parcel", "tags": [ "parcels" ], "parameters": [ { "name": "parcelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/parcelUpdate" } } } }, "responses": { "200": { "description": "The updated parcel object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/parcelResponse" } } } } } }, "delete": { "operationId": "DELETE/parcels/parcelId", "summary": "Delete a parcel", "description": "Delete a parcel", "tags": [ "parcels" ], "parameters": [ { "name": "parcelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/parcels/{parcelId}/shipment": { "get": { "operationId": "GET/parcelId/shipment", "summary": "Retrieve the shipment associated to the parcel", "description": "Retrieve the shipment associated to the parcel", "tags": [ "has_one", "shipments" ], "parameters": [ { "name": "parcelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipment associated to the parcel" } } } }, "/parcels/{parcelId}/package": { "get": { "operationId": "GET/parcelId/package", "summary": "Retrieve the package associated to the parcel", "description": "Retrieve the package associated to the parcel", "tags": [ "has_one", "packages" ], "parameters": [ { "name": "parcelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The package associated to the parcel" } } } }, "/parcels/{parcelId}/parcel_line_items": { "get": { "operationId": "GET/parcelId/parcel_line_items", "summary": "Retrieve the parcel line items associated to the parcel", "description": "Retrieve the parcel line items associated to the parcel", "tags": [ "has_many", "parcel_line_items" ], "parameters": [ { "name": "parcelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The parcel_line_items associated to the parcel" } } } }, "/parcels/{parcelId}/attachments": { "get": { "operationId": "GET/parcelId/attachments", "summary": "Retrieve the attachments associated to the parcel", "description": "Retrieve the attachments associated to the parcel", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "parcelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the parcel" } } } }, "/parcels/{parcelId}/events": { "get": { "operationId": "GET/parcelId/events", "summary": "Retrieve the events associated to the parcel", "description": "Retrieve the events associated to the parcel", "tags": [ "has_many", "events" ], "parameters": [ { "name": "parcelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the parcel" } } } }, "/parcels/{parcelId}/event_stores": { "get": { "operationId": "GET/parcelId/event_stores", "summary": "Retrieve the event stores associated to the parcel", "description": "Retrieve the event stores associated to the parcel", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "parcelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the parcel" } } } }, "/payment_gateways": { "get": { "operationId": "GET/payment_gateways", "summary": "List all payment gateways", "description": "List all payment gateways", "tags": [ "payment_gateways" ], "responses": { "200": { "description": "A list of payment gateway objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paymentGatewayResponseList" } } } } } } }, "/payment_gateways/{paymentGatewayId}": { "get": { "operationId": "GET/payment_gateways/paymentGatewayId", "summary": "Retrieve a payment gateway", "description": "Retrieve a payment gateway", "tags": [ "payment_gateways" ], "parameters": [ { "name": "paymentGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paymentGatewayResponse" } } } } } } }, "/payment_gateways/{paymentGatewayId}/payment_methods": { "get": { "operationId": "GET/paymentGatewayId/payment_methods", "summary": "Retrieve the payment methods associated to the payment gateway", "description": "Retrieve the payment methods associated to the payment gateway", "tags": [ "has_many", "payment_methods" ], "parameters": [ { "name": "paymentGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_methods associated to the payment gateway" } } } }, "/payment_gateways/{paymentGatewayId}/event_stores": { "get": { "operationId": "GET/paymentGatewayId/event_stores", "summary": "Retrieve the event stores associated to the payment gateway", "description": "Retrieve the event stores associated to the payment gateway", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "paymentGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the payment gateway" } } } }, "/payment_methods": { "get": { "operationId": "GET/payment_methods", "summary": "List all payment methods", "description": "List all payment methods", "tags": [ "payment_methods" ], "responses": { "200": { "description": "A list of payment method objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paymentMethodResponseList" } } } } } }, "post": { "operationId": "POST/payment_methods", "summary": "Create a payment method", "description": "Create a payment method", "tags": [ "payment_methods" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paymentMethodCreate" } } } }, "responses": { "201": { "description": "The created payment method object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paymentMethodResponse" } } } } } } }, "/payment_methods/{paymentMethodId}": { "get": { "operationId": "GET/payment_methods/paymentMethodId", "summary": "Retrieve a payment method", "description": "Retrieve a payment method", "tags": [ "payment_methods" ], "parameters": [ { "name": "paymentMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment method object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paymentMethodResponse" } } } } } }, "patch": { "operationId": "PATCH/payment_methods/paymentMethodId", "summary": "Update a payment method", "description": "Update a payment method", "tags": [ "payment_methods" ], "parameters": [ { "name": "paymentMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paymentMethodUpdate" } } } }, "responses": { "200": { "description": "The updated payment method object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paymentMethodResponse" } } } } } }, "delete": { "operationId": "DELETE/payment_methods/paymentMethodId", "summary": "Delete a payment method", "description": "Delete a payment method", "tags": [ "payment_methods" ], "parameters": [ { "name": "paymentMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/payment_methods/{paymentMethodId}/market": { "get": { "operationId": "GET/paymentMethodId/market", "summary": "Retrieve the market associated to the payment method", "description": "Retrieve the market associated to the payment method", "tags": [ "has_one", "markets" ], "parameters": [ { "name": "paymentMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The market associated to the payment method" } } } }, "/payment_methods/{paymentMethodId}/payment_gateway": { "get": { "operationId": "GET/paymentMethodId/payment_gateway", "summary": "Retrieve the payment gateway associated to the payment method", "description": "Retrieve the payment gateway associated to the payment method", "tags": [ "has_one", "payment_gateways" ], "parameters": [ { "name": "paymentMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_gateway associated to the payment method" } } } }, "/payment_methods/{paymentMethodId}/store": { "get": { "operationId": "GET/paymentMethodId/store", "summary": "Retrieve the store associated to the payment method", "description": "Retrieve the store associated to the payment method", "tags": [ "has_one", "stores" ], "parameters": [ { "name": "paymentMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The store associated to the payment method" } } } }, "/payment_methods/{paymentMethodId}/attachments": { "get": { "operationId": "GET/paymentMethodId/attachments", "summary": "Retrieve the attachments associated to the payment method", "description": "Retrieve the attachments associated to the payment method", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "paymentMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the payment method" } } } }, "/payment_methods/{paymentMethodId}/event_stores": { "get": { "operationId": "GET/paymentMethodId/event_stores", "summary": "Retrieve the event stores associated to the payment method", "description": "Retrieve the event stores associated to the payment method", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "paymentMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the payment method" } } } }, "/payment_options": { "get": { "operationId": "GET/payment_options", "summary": "List all payment options", "description": "List all payment options", "tags": [ "payment_options" ], "responses": { "200": { "description": "A list of payment option objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paymentOptionResponseList" } } } } } }, "post": { "operationId": "POST/payment_options", "summary": "Create a payment option", "description": "Create a payment option", "tags": [ "payment_options" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paymentOptionCreate" } } } }, "responses": { "201": { "description": "The created payment option object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paymentOptionResponse" } } } } } } }, "/payment_options/{paymentOptionId}": { "get": { "operationId": "GET/payment_options/paymentOptionId", "summary": "Retrieve a payment option", "description": "Retrieve a payment option", "tags": [ "payment_options" ], "parameters": [ { "name": "paymentOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment option object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paymentOptionResponse" } } } } } }, "patch": { "operationId": "PATCH/payment_options/paymentOptionId", "summary": "Update a payment option", "description": "Update a payment option", "tags": [ "payment_options" ], "parameters": [ { "name": "paymentOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paymentOptionUpdate" } } } }, "responses": { "200": { "description": "The updated payment option object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paymentOptionResponse" } } } } } }, "delete": { "operationId": "DELETE/payment_options/paymentOptionId", "summary": "Delete a payment option", "description": "Delete a payment option", "tags": [ "payment_options" ], "parameters": [ { "name": "paymentOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/payment_options/{paymentOptionId}/order": { "get": { "operationId": "GET/paymentOptionId/order", "summary": "Retrieve the order associated to the payment option", "description": "Retrieve the order associated to the payment option", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "paymentOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order associated to the payment option" } } } }, "/payment_options/{paymentOptionId}/attachments": { "get": { "operationId": "GET/paymentOptionId/attachments", "summary": "Retrieve the attachments associated to the payment option", "description": "Retrieve the attachments associated to the payment option", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "paymentOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the payment option" } } } }, "/payment_options/{paymentOptionId}/event_stores": { "get": { "operationId": "GET/paymentOptionId/event_stores", "summary": "Retrieve the event stores associated to the payment option", "description": "Retrieve the event stores associated to the payment option", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "paymentOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the payment option" } } } }, "/paypal_gateways": { "get": { "operationId": "GET/paypal_gateways", "summary": "List all paypal gateways", "description": "List all paypal gateways", "tags": [ "paypal_gateways" ], "responses": { "200": { "description": "A list of paypal gateway objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paypalGatewayResponseList" } } } } } }, "post": { "operationId": "POST/paypal_gateways", "summary": "Create a paypal gateway", "description": "Create a paypal gateway", "tags": [ "paypal_gateways" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paypalGatewayCreate" } } } }, "responses": { "201": { "description": "The created paypal gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paypalGatewayResponse" } } } } } } }, "/paypal_gateways/{paypalGatewayId}": { "get": { "operationId": "GET/paypal_gateways/paypalGatewayId", "summary": "Retrieve a paypal gateway", "description": "Retrieve a paypal gateway", "tags": [ "paypal_gateways" ], "parameters": [ { "name": "paypalGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The paypal gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paypalGatewayResponse" } } } } } }, "patch": { "operationId": "PATCH/paypal_gateways/paypalGatewayId", "summary": "Update a paypal gateway", "description": "Update a paypal gateway", "tags": [ "paypal_gateways" ], "parameters": [ { "name": "paypalGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paypalGatewayUpdate" } } } }, "responses": { "200": { "description": "The updated paypal gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paypalGatewayResponse" } } } } } }, "delete": { "operationId": "DELETE/paypal_gateways/paypalGatewayId", "summary": "Delete a paypal gateway", "description": "Delete a paypal gateway", "tags": [ "paypal_gateways" ], "parameters": [ { "name": "paypalGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/paypal_gateways/{paypalGatewayId}/payment_methods": { "get": { "operationId": "GET/paypalGatewayId/payment_methods", "summary": "Retrieve the payment methods associated to the paypal gateway", "description": "Retrieve the payment methods associated to the paypal gateway", "tags": [ "has_many", "payment_methods" ], "parameters": [ { "name": "paypalGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_methods associated to the paypal gateway" } } } }, "/paypal_gateways/{paypalGatewayId}/event_stores": { "get": { "operationId": "GET/paypalGatewayId/event_stores", "summary": "Retrieve the event stores associated to the paypal gateway", "description": "Retrieve the event stores associated to the paypal gateway", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "paypalGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the paypal gateway" } } } }, "/paypal_gateways/{paypalGatewayId}/paypal_payments": { "get": { "operationId": "GET/paypalGatewayId/paypal_payments", "summary": "Retrieve the paypal payments associated to the paypal gateway", "description": "Retrieve the paypal payments associated to the paypal gateway", "tags": [ "has_many", "paypal_payments" ], "parameters": [ { "name": "paypalGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The paypal_payments associated to the paypal gateway" } } } }, "/paypal_payments": { "get": { "operationId": "GET/paypal_payments", "summary": "List all paypal payments", "description": "List all paypal payments", "tags": [ "paypal_payments" ], "responses": { "200": { "description": "A list of paypal payment objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paypalPaymentResponseList" } } } } } }, "post": { "operationId": "POST/paypal_payments", "summary": "Create a paypal payment", "description": "Create a paypal payment", "tags": [ "paypal_payments" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paypalPaymentCreate" } } } }, "responses": { "201": { "description": "The created paypal payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paypalPaymentResponse" } } } } } } }, "/paypal_payments/{paypalPaymentId}": { "get": { "operationId": "GET/paypal_payments/paypalPaymentId", "summary": "Retrieve a paypal payment", "description": "Retrieve a paypal payment", "tags": [ "paypal_payments" ], "parameters": [ { "name": "paypalPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The paypal payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paypalPaymentResponse" } } } } } }, "patch": { "operationId": "PATCH/paypal_payments/paypalPaymentId", "summary": "Update a paypal payment", "description": "Update a paypal payment", "tags": [ "paypal_payments" ], "parameters": [ { "name": "paypalPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paypalPaymentUpdate" } } } }, "responses": { "200": { "description": "The updated paypal payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/paypalPaymentResponse" } } } } } }, "delete": { "operationId": "DELETE/paypal_payments/paypalPaymentId", "summary": "Delete a paypal payment", "description": "Delete a paypal payment", "tags": [ "paypal_payments" ], "parameters": [ { "name": "paypalPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/paypal_payments/{paypalPaymentId}/order": { "get": { "operationId": "GET/paypalPaymentId/order", "summary": "Retrieve the order associated to the paypal payment", "description": "Retrieve the order associated to the paypal payment", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "paypalPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order associated to the paypal payment" } } } }, "/paypal_payments/{paypalPaymentId}/payment_gateway": { "get": { "operationId": "GET/paypalPaymentId/payment_gateway", "summary": "Retrieve the payment gateway associated to the paypal payment", "description": "Retrieve the payment gateway associated to the paypal payment", "tags": [ "has_one", "payment_gateways" ], "parameters": [ { "name": "paypalPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_gateway associated to the paypal payment" } } } }, "/paypal_payments/{paypalPaymentId}/event_stores": { "get": { "operationId": "GET/paypalPaymentId/event_stores", "summary": "Retrieve the event stores associated to the paypal payment", "description": "Retrieve the event stores associated to the paypal payment", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "paypalPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the paypal payment" } } } }, "/percentage_discount_promotions": { "get": { "operationId": "GET/percentage_discount_promotions", "summary": "List all percentage discount promotions", "description": "List all percentage discount promotions", "tags": [ "percentage_discount_promotions" ], "responses": { "200": { "description": "A list of percentage discount promotion objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/percentageDiscountPromotionResponseList" } } } } } }, "post": { "operationId": "POST/percentage_discount_promotions", "summary": "Create a percentage discount promotion", "description": "Create a percentage discount promotion", "tags": [ "percentage_discount_promotions" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/percentageDiscountPromotionCreate" } } } }, "responses": { "201": { "description": "The created percentage discount promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/percentageDiscountPromotionResponse" } } } } } } }, "/percentage_discount_promotions/{percentageDiscountPromotionId}": { "get": { "operationId": "GET/percentage_discount_promotions/percentageDiscountPromotionId", "summary": "Retrieve a percentage discount promotion", "description": "Retrieve a percentage discount promotion", "tags": [ "percentage_discount_promotions" ], "parameters": [ { "name": "percentageDiscountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The percentage discount promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/percentageDiscountPromotionResponse" } } } } } }, "patch": { "operationId": "PATCH/percentage_discount_promotions/percentageDiscountPromotionId", "summary": "Update a percentage discount promotion", "description": "Update a percentage discount promotion", "tags": [ "percentage_discount_promotions" ], "parameters": [ { "name": "percentageDiscountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/percentageDiscountPromotionUpdate" } } } }, "responses": { "200": { "description": "The updated percentage discount promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/percentageDiscountPromotionResponse" } } } } } }, "delete": { "operationId": "DELETE/percentage_discount_promotions/percentageDiscountPromotionId", "summary": "Delete a percentage discount promotion", "description": "Delete a percentage discount promotion", "tags": [ "percentage_discount_promotions" ], "parameters": [ { "name": "percentageDiscountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/percentage_discount_promotions/{percentageDiscountPromotionId}/market": { "get": { "operationId": "GET/percentageDiscountPromotionId/market", "summary": "Retrieve the market associated to the percentage discount promotion", "description": "Retrieve the market associated to the percentage discount promotion", "tags": [ "has_one", "markets" ], "parameters": [ { "name": "percentageDiscountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The market associated to the percentage discount promotion" } } } }, "/percentage_discount_promotions/{percentageDiscountPromotionId}/order_amount_promotion_rule": { "get": { "operationId": "GET/percentageDiscountPromotionId/order_amount_promotion_rule", "summary": "Retrieve the order amount promotion rule associated to the percentage discount promotion", "description": "Retrieve the order amount promotion rule associated to the percentage discount promotion", "tags": [ "has_one", "order_amount_promotion_rules" ], "parameters": [ { "name": "percentageDiscountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order_amount_promotion_rule associated to the percentage discount promotion" } } } }, "/percentage_discount_promotions/{percentageDiscountPromotionId}/sku_list_promotion_rule": { "get": { "operationId": "GET/percentageDiscountPromotionId/sku_list_promotion_rule", "summary": "Retrieve the sku list promotion rule associated to the percentage discount promotion", "description": "Retrieve the sku list promotion rule associated to the percentage discount promotion", "tags": [ "has_one", "sku_list_promotion_rules" ], "parameters": [ { "name": "percentageDiscountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_list_promotion_rule associated to the percentage discount promotion" } } } }, "/percentage_discount_promotions/{percentageDiscountPromotionId}/coupon_codes_promotion_rule": { "get": { "operationId": "GET/percentageDiscountPromotionId/coupon_codes_promotion_rule", "summary": "Retrieve the coupon codes promotion rule associated to the percentage discount promotion", "description": "Retrieve the coupon codes promotion rule associated to the percentage discount promotion", "tags": [ "has_one", "coupon_codes_promotion_rules" ], "parameters": [ { "name": "percentageDiscountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupon_codes_promotion_rule associated to the percentage discount promotion" } } } }, "/percentage_discount_promotions/{percentageDiscountPromotionId}/custom_promotion_rule": { "get": { "operationId": "GET/percentageDiscountPromotionId/custom_promotion_rule", "summary": "Retrieve the custom promotion rule associated to the percentage discount promotion", "description": "Retrieve the custom promotion rule associated to the percentage discount promotion", "tags": [ "has_one", "custom_promotion_rules" ], "parameters": [ { "name": "percentageDiscountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The custom_promotion_rule associated to the percentage discount promotion" } } } }, "/percentage_discount_promotions/{percentageDiscountPromotionId}/sku_list": { "get": { "operationId": "GET/percentageDiscountPromotionId/sku_list", "summary": "Retrieve the sku list associated to the percentage discount promotion", "description": "Retrieve the sku list associated to the percentage discount promotion", "tags": [ "has_one", "sku_lists" ], "parameters": [ { "name": "percentageDiscountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_list associated to the percentage discount promotion" } } } }, "/percentage_discount_promotions/{percentageDiscountPromotionId}/coupons": { "get": { "operationId": "GET/percentageDiscountPromotionId/coupons", "summary": "Retrieve the coupons associated to the percentage discount promotion", "description": "Retrieve the coupons associated to the percentage discount promotion", "tags": [ "has_many", "coupons" ], "parameters": [ { "name": "percentageDiscountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupons associated to the percentage discount promotion" } } } }, "/percentage_discount_promotions/{percentageDiscountPromotionId}/attachments": { "get": { "operationId": "GET/percentageDiscountPromotionId/attachments", "summary": "Retrieve the attachments associated to the percentage discount promotion", "description": "Retrieve the attachments associated to the percentage discount promotion", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "percentageDiscountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the percentage discount promotion" } } } }, "/percentage_discount_promotions/{percentageDiscountPromotionId}/events": { "get": { "operationId": "GET/percentageDiscountPromotionId/events", "summary": "Retrieve the events associated to the percentage discount promotion", "description": "Retrieve the events associated to the percentage discount promotion", "tags": [ "has_many", "events" ], "parameters": [ { "name": "percentageDiscountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the percentage discount promotion" } } } }, "/percentage_discount_promotions/{percentageDiscountPromotionId}/tags": { "get": { "operationId": "GET/percentageDiscountPromotionId/tags", "summary": "Retrieve the tags associated to the percentage discount promotion", "description": "Retrieve the tags associated to the percentage discount promotion", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "percentageDiscountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the percentage discount promotion" } } } }, "/percentage_discount_promotions/{percentageDiscountPromotionId}/event_stores": { "get": { "operationId": "GET/percentageDiscountPromotionId/event_stores", "summary": "Retrieve the event stores associated to the percentage discount promotion", "description": "Retrieve the event stores associated to the percentage discount promotion", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "percentageDiscountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the percentage discount promotion" } } } }, "/percentage_discount_promotions/{percentageDiscountPromotionId}/skus": { "get": { "operationId": "GET/percentageDiscountPromotionId/skus", "summary": "Retrieve the skus associated to the percentage discount promotion", "description": "Retrieve the skus associated to the percentage discount promotion", "tags": [ "has_many", "skus" ], "parameters": [ { "name": "percentageDiscountPromotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The skus associated to the percentage discount promotion" } } } }, "/pickups": { "get": { "operationId": "GET/pickups", "summary": "List all pickups", "description": "List all pickups", "tags": [ "pickups" ], "responses": { "200": { "description": "A list of pickup objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/pickupResponseList" } } } } } } }, "/pickups/{pickupId}": { "get": { "operationId": "GET/pickups/pickupId", "summary": "Retrieve a pickup", "description": "Retrieve a pickup", "tags": [ "pickups" ], "parameters": [ { "name": "pickupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The pickup object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/pickupResponse" } } } } } } }, "/pickups/{pickupId}/shipment": { "get": { "operationId": "GET/pickupId/shipment", "summary": "Retrieve the shipment associated to the pickup", "description": "Retrieve the shipment associated to the pickup", "tags": [ "has_one", "shipments" ], "parameters": [ { "name": "pickupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipment associated to the pickup" } } } }, "/pickups/{pickupId}/parcels": { "get": { "operationId": "GET/pickupId/parcels", "summary": "Retrieve the parcels associated to the pickup", "description": "Retrieve the parcels associated to the pickup", "tags": [ "has_many", "parcels" ], "parameters": [ { "name": "pickupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The parcels associated to the pickup" } } } }, "/pickups/{pickupId}/events": { "get": { "operationId": "GET/pickupId/events", "summary": "Retrieve the events associated to the pickup", "description": "Retrieve the events associated to the pickup", "tags": [ "has_many", "events" ], "parameters": [ { "name": "pickupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the pickup" } } } }, "/pickups/{pickupId}/event_stores": { "get": { "operationId": "GET/pickupId/event_stores", "summary": "Retrieve the event stores associated to the pickup", "description": "Retrieve the event stores associated to the pickup", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "pickupId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the pickup" } } } }, "/price_frequency_tiers": { "get": { "operationId": "GET/price_frequency_tiers", "summary": "List all price frequency tiers", "description": "List all price frequency tiers", "tags": [ "price_frequency_tiers" ], "responses": { "200": { "description": "A list of price frequency tier objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceFrequencyTierResponseList" } } } } } }, "post": { "operationId": "POST/price_frequency_tiers", "summary": "Create a price frequency tier", "description": "Create a price frequency tier", "tags": [ "price_frequency_tiers" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceFrequencyTierCreate" } } } }, "responses": { "201": { "description": "The created price frequency tier object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceFrequencyTierResponse" } } } } } } }, "/price_frequency_tiers/{priceFrequencyTierId}": { "get": { "operationId": "GET/price_frequency_tiers/priceFrequencyTierId", "summary": "Retrieve a price frequency tier", "description": "Retrieve a price frequency tier", "tags": [ "price_frequency_tiers" ], "parameters": [ { "name": "priceFrequencyTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The price frequency tier object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceFrequencyTierResponse" } } } } } }, "patch": { "operationId": "PATCH/price_frequency_tiers/priceFrequencyTierId", "summary": "Update a price frequency tier", "description": "Update a price frequency tier", "tags": [ "price_frequency_tiers" ], "parameters": [ { "name": "priceFrequencyTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceFrequencyTierUpdate" } } } }, "responses": { "200": { "description": "The updated price frequency tier object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceFrequencyTierResponse" } } } } } }, "delete": { "operationId": "DELETE/price_frequency_tiers/priceFrequencyTierId", "summary": "Delete a price frequency tier", "description": "Delete a price frequency tier", "tags": [ "price_frequency_tiers" ], "parameters": [ { "name": "priceFrequencyTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/price_frequency_tiers/{priceFrequencyTierId}/price": { "get": { "operationId": "GET/priceFrequencyTierId/price", "summary": "Retrieve the price associated to the price frequency tier", "description": "Retrieve the price associated to the price frequency tier", "tags": [ "has_one", "prices" ], "parameters": [ { "name": "priceFrequencyTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The price associated to the price frequency tier" } } } }, "/price_frequency_tiers/{priceFrequencyTierId}/attachments": { "get": { "operationId": "GET/priceFrequencyTierId/attachments", "summary": "Retrieve the attachments associated to the price frequency tier", "description": "Retrieve the attachments associated to the price frequency tier", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "priceFrequencyTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the price frequency tier" } } } }, "/price_frequency_tiers/{priceFrequencyTierId}/event_stores": { "get": { "operationId": "GET/priceFrequencyTierId/event_stores", "summary": "Retrieve the event stores associated to the price frequency tier", "description": "Retrieve the event stores associated to the price frequency tier", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "priceFrequencyTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the price frequency tier" } } } }, "/price_frequency_tiers/{priceFrequencyTierId}/events": { "get": { "operationId": "GET/priceFrequencyTierId/events", "summary": "Retrieve the events associated to the price frequency tier", "description": "Retrieve the events associated to the price frequency tier", "tags": [ "has_many", "events" ], "parameters": [ { "name": "priceFrequencyTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the price frequency tier" } } } }, "/price_list_schedulers": { "get": { "operationId": "GET/price_list_schedulers", "summary": "List all price list schedulers", "description": "List all price list schedulers", "tags": [ "price_list_schedulers" ], "responses": { "200": { "description": "A list of price list scheduler objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceListSchedulerResponseList" } } } } } }, "post": { "operationId": "POST/price_list_schedulers", "summary": "Create a price list scheduler", "description": "Create a price list scheduler", "tags": [ "price_list_schedulers" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceListSchedulerCreate" } } } }, "responses": { "201": { "description": "The created price list scheduler object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceListSchedulerResponse" } } } } } } }, "/price_list_schedulers/{priceListSchedulerId}": { "get": { "operationId": "GET/price_list_schedulers/priceListSchedulerId", "summary": "Retrieve a price list scheduler", "description": "Retrieve a price list scheduler", "tags": [ "price_list_schedulers" ], "parameters": [ { "name": "priceListSchedulerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The price list scheduler object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceListSchedulerResponse" } } } } } }, "patch": { "operationId": "PATCH/price_list_schedulers/priceListSchedulerId", "summary": "Update a price list scheduler", "description": "Update a price list scheduler", "tags": [ "price_list_schedulers" ], "parameters": [ { "name": "priceListSchedulerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceListSchedulerUpdate" } } } }, "responses": { "200": { "description": "The updated price list scheduler object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceListSchedulerResponse" } } } } } }, "delete": { "operationId": "DELETE/price_list_schedulers/priceListSchedulerId", "summary": "Delete a price list scheduler", "description": "Delete a price list scheduler", "tags": [ "price_list_schedulers" ], "parameters": [ { "name": "priceListSchedulerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/price_list_schedulers/{priceListSchedulerId}/market": { "get": { "operationId": "GET/priceListSchedulerId/market", "summary": "Retrieve the market associated to the price list scheduler", "description": "Retrieve the market associated to the price list scheduler", "tags": [ "has_one", "markets" ], "parameters": [ { "name": "priceListSchedulerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The market associated to the price list scheduler" } } } }, "/price_list_schedulers/{priceListSchedulerId}/price_list": { "get": { "operationId": "GET/priceListSchedulerId/price_list", "summary": "Retrieve the price list associated to the price list scheduler", "description": "Retrieve the price list associated to the price list scheduler", "tags": [ "has_one", "price_lists" ], "parameters": [ { "name": "priceListSchedulerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The price_list associated to the price list scheduler" } } } }, "/price_list_schedulers/{priceListSchedulerId}/events": { "get": { "operationId": "GET/priceListSchedulerId/events", "summary": "Retrieve the events associated to the price list scheduler", "description": "Retrieve the events associated to the price list scheduler", "tags": [ "has_many", "events" ], "parameters": [ { "name": "priceListSchedulerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the price list scheduler" } } } }, "/price_list_schedulers/{priceListSchedulerId}/event_stores": { "get": { "operationId": "GET/priceListSchedulerId/event_stores", "summary": "Retrieve the event stores associated to the price list scheduler", "description": "Retrieve the event stores associated to the price list scheduler", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "priceListSchedulerId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the price list scheduler" } } } }, "/price_lists": { "get": { "operationId": "GET/price_lists", "summary": "List all price lists", "description": "List all price lists", "tags": [ "price_lists" ], "responses": { "200": { "description": "A list of price list objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceListResponseList" } } } } } }, "post": { "operationId": "POST/price_lists", "summary": "Create a price list", "description": "Create a price list", "tags": [ "price_lists" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceListCreate" } } } }, "responses": { "201": { "description": "The created price list object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceListResponse" } } } } } } }, "/price_lists/{priceListId}": { "get": { "operationId": "GET/price_lists/priceListId", "summary": "Retrieve a price list", "description": "Retrieve a price list", "tags": [ "price_lists" ], "parameters": [ { "name": "priceListId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The price list object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceListResponse" } } } } } }, "patch": { "operationId": "PATCH/price_lists/priceListId", "summary": "Update a price list", "description": "Update a price list", "tags": [ "price_lists" ], "parameters": [ { "name": "priceListId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceListUpdate" } } } }, "responses": { "200": { "description": "The updated price list object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceListResponse" } } } } } }, "delete": { "operationId": "DELETE/price_lists/priceListId", "summary": "Delete a price list", "description": "Delete a price list", "tags": [ "price_lists" ], "parameters": [ { "name": "priceListId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/price_lists/{priceListId}/prices": { "get": { "operationId": "GET/priceListId/prices", "summary": "Retrieve the prices associated to the price list", "description": "Retrieve the prices associated to the price list", "tags": [ "has_many", "prices" ], "parameters": [ { "name": "priceListId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The prices associated to the price list" } } } }, "/price_lists/{priceListId}/price_list_schedulers": { "get": { "operationId": "GET/priceListId/price_list_schedulers", "summary": "Retrieve the price list schedulers associated to the price list", "description": "Retrieve the price list schedulers associated to the price list", "tags": [ "has_many", "price_list_schedulers" ], "parameters": [ { "name": "priceListId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The price_list_schedulers associated to the price list" } } } }, "/price_lists/{priceListId}/attachments": { "get": { "operationId": "GET/priceListId/attachments", "summary": "Retrieve the attachments associated to the price list", "description": "Retrieve the attachments associated to the price list", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "priceListId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the price list" } } } }, "/price_lists/{priceListId}/event_stores": { "get": { "operationId": "GET/priceListId/event_stores", "summary": "Retrieve the event stores associated to the price list", "description": "Retrieve the event stores associated to the price list", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "priceListId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the price list" } } } }, "/price_tiers": { "get": { "operationId": "GET/price_tiers", "summary": "List all price tiers", "description": "List all price tiers", "tags": [ "price_tiers" ], "responses": { "200": { "description": "A list of price tier objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceTierResponseList" } } } } } } }, "/price_tiers/{priceTierId}": { "get": { "operationId": "GET/price_tiers/priceTierId", "summary": "Retrieve a price tier", "description": "Retrieve a price tier", "tags": [ "price_tiers" ], "parameters": [ { "name": "priceTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The price tier object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceTierResponse" } } } } } } }, "/price_tiers/{priceTierId}/price": { "get": { "operationId": "GET/priceTierId/price", "summary": "Retrieve the price associated to the price tier", "description": "Retrieve the price associated to the price tier", "tags": [ "has_one", "prices" ], "parameters": [ { "name": "priceTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The price associated to the price tier" } } } }, "/price_tiers/{priceTierId}/attachments": { "get": { "operationId": "GET/priceTierId/attachments", "summary": "Retrieve the attachments associated to the price tier", "description": "Retrieve the attachments associated to the price tier", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "priceTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the price tier" } } } }, "/price_tiers/{priceTierId}/event_stores": { "get": { "operationId": "GET/priceTierId/event_stores", "summary": "Retrieve the event stores associated to the price tier", "description": "Retrieve the event stores associated to the price tier", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "priceTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the price tier" } } } }, "/price_volume_tiers": { "get": { "operationId": "GET/price_volume_tiers", "summary": "List all price volume tiers", "description": "List all price volume tiers", "tags": [ "price_volume_tiers" ], "responses": { "200": { "description": "A list of price volume tier objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceVolumeTierResponseList" } } } } } }, "post": { "operationId": "POST/price_volume_tiers", "summary": "Create a price volume tier", "description": "Create a price volume tier", "tags": [ "price_volume_tiers" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceVolumeTierCreate" } } } }, "responses": { "201": { "description": "The created price volume tier object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceVolumeTierResponse" } } } } } } }, "/price_volume_tiers/{priceVolumeTierId}": { "get": { "operationId": "GET/price_volume_tiers/priceVolumeTierId", "summary": "Retrieve a price volume tier", "description": "Retrieve a price volume tier", "tags": [ "price_volume_tiers" ], "parameters": [ { "name": "priceVolumeTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The price volume tier object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceVolumeTierResponse" } } } } } }, "patch": { "operationId": "PATCH/price_volume_tiers/priceVolumeTierId", "summary": "Update a price volume tier", "description": "Update a price volume tier", "tags": [ "price_volume_tiers" ], "parameters": [ { "name": "priceVolumeTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceVolumeTierUpdate" } } } }, "responses": { "200": { "description": "The updated price volume tier object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceVolumeTierResponse" } } } } } }, "delete": { "operationId": "DELETE/price_volume_tiers/priceVolumeTierId", "summary": "Delete a price volume tier", "description": "Delete a price volume tier", "tags": [ "price_volume_tiers" ], "parameters": [ { "name": "priceVolumeTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/price_volume_tiers/{priceVolumeTierId}/price": { "get": { "operationId": "GET/priceVolumeTierId/price", "summary": "Retrieve the price associated to the price volume tier", "description": "Retrieve the price associated to the price volume tier", "tags": [ "has_one", "prices" ], "parameters": [ { "name": "priceVolumeTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The price associated to the price volume tier" } } } }, "/price_volume_tiers/{priceVolumeTierId}/attachments": { "get": { "operationId": "GET/priceVolumeTierId/attachments", "summary": "Retrieve the attachments associated to the price volume tier", "description": "Retrieve the attachments associated to the price volume tier", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "priceVolumeTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the price volume tier" } } } }, "/price_volume_tiers/{priceVolumeTierId}/event_stores": { "get": { "operationId": "GET/priceVolumeTierId/event_stores", "summary": "Retrieve the event stores associated to the price volume tier", "description": "Retrieve the event stores associated to the price volume tier", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "priceVolumeTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the price volume tier" } } } }, "/price_volume_tiers/{priceVolumeTierId}/events": { "get": { "operationId": "GET/priceVolumeTierId/events", "summary": "Retrieve the events associated to the price volume tier", "description": "Retrieve the events associated to the price volume tier", "tags": [ "has_many", "events" ], "parameters": [ { "name": "priceVolumeTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the price volume tier" } } } }, "/prices": { "get": { "operationId": "GET/prices", "summary": "List all prices", "description": "List all prices", "tags": [ "prices" ], "responses": { "200": { "description": "A list of price objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceResponseList" } } } } } }, "post": { "operationId": "POST/prices", "summary": "Create a price", "description": "Create a price", "tags": [ "prices" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceCreate" } } } }, "responses": { "201": { "description": "The created price object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceResponse" } } } } } } }, "/prices/{priceId}": { "get": { "operationId": "GET/prices/priceId", "summary": "Retrieve a price", "description": "Retrieve a price", "tags": [ "prices" ], "parameters": [ { "name": "priceId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The price object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceResponse" } } } } } }, "patch": { "operationId": "PATCH/prices/priceId", "summary": "Update a price", "description": "Update a price", "tags": [ "prices" ], "parameters": [ { "name": "priceId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceUpdate" } } } }, "responses": { "200": { "description": "The updated price object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/priceResponse" } } } } } }, "delete": { "operationId": "DELETE/prices/priceId", "summary": "Delete a price", "description": "Delete a price", "tags": [ "prices" ], "parameters": [ { "name": "priceId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/prices/{priceId}/price_list": { "get": { "operationId": "GET/priceId/price_list", "summary": "Retrieve the price list associated to the price", "description": "Retrieve the price list associated to the price", "tags": [ "has_one", "price_lists" ], "parameters": [ { "name": "priceId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The price_list associated to the price" } } } }, "/prices/{priceId}/sku": { "get": { "operationId": "GET/priceId/sku", "summary": "Retrieve the sku associated to the price", "description": "Retrieve the sku associated to the price", "tags": [ "has_one", "skus" ], "parameters": [ { "name": "priceId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku associated to the price" } } } }, "/prices/{priceId}/price_tiers": { "get": { "operationId": "GET/priceId/price_tiers", "summary": "Retrieve the price tiers associated to the price", "description": "Retrieve the price tiers associated to the price", "tags": [ "has_many", "price_tiers" ], "parameters": [ { "name": "priceId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The price_tiers associated to the price" } } } }, "/prices/{priceId}/price_volume_tiers": { "get": { "operationId": "GET/priceId/price_volume_tiers", "summary": "Retrieve the price volume tiers associated to the price", "description": "Retrieve the price volume tiers associated to the price", "tags": [ "has_many", "price_volume_tiers" ], "parameters": [ { "name": "priceId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The price_volume_tiers associated to the price" } } } }, "/prices/{priceId}/price_frequency_tiers": { "get": { "operationId": "GET/priceId/price_frequency_tiers", "summary": "Retrieve the price frequency tiers associated to the price", "description": "Retrieve the price frequency tiers associated to the price", "tags": [ "has_many", "price_frequency_tiers" ], "parameters": [ { "name": "priceId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The price_frequency_tiers associated to the price" } } } }, "/prices/{priceId}/attachments": { "get": { "operationId": "GET/priceId/attachments", "summary": "Retrieve the attachments associated to the price", "description": "Retrieve the attachments associated to the price", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "priceId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the price" } } } }, "/prices/{priceId}/jwt_customer": { "get": { "operationId": "GET/priceId/jwt_customer", "summary": "Retrieve the jwt customer associated to the price", "description": "Retrieve the jwt customer associated to the price", "tags": [ "has_one", "customers" ], "parameters": [ { "name": "priceId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The jwt_customer associated to the price" } } } }, "/prices/{priceId}/jwt_markets": { "get": { "operationId": "GET/priceId/jwt_markets", "summary": "Retrieve the jwt markets associated to the price", "description": "Retrieve the jwt markets associated to the price", "tags": [ "has_many", "markets" ], "parameters": [ { "name": "priceId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The jwt_markets associated to the price" } } } }, "/prices/{priceId}/jwt_stock_locations": { "get": { "operationId": "GET/priceId/jwt_stock_locations", "summary": "Retrieve the jwt stock locations associated to the price", "description": "Retrieve the jwt stock locations associated to the price", "tags": [ "has_many", "stock_locations" ], "parameters": [ { "name": "priceId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The jwt_stock_locations associated to the price" } } } }, "/prices/{priceId}/event_stores": { "get": { "operationId": "GET/priceId/event_stores", "summary": "Retrieve the event stores associated to the price", "description": "Retrieve the event stores associated to the price", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "priceId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the price" } } } }, "/promotion_rules": { "get": { "operationId": "GET/promotion_rules", "summary": "List all promotion rules", "description": "List all promotion rules", "tags": [ "promotion_rules" ], "responses": { "200": { "description": "A list of promotion rule objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/promotionRuleResponseList" } } } } } } }, "/promotion_rules/{promotionRuleId}": { "get": { "operationId": "GET/promotion_rules/promotionRuleId", "summary": "Retrieve a promotion rule", "description": "Retrieve a promotion rule", "tags": [ "promotion_rules" ], "parameters": [ { "name": "promotionRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The promotion rule object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/promotionRuleResponse" } } } } } } }, "/promotion_rules/{promotionRuleId}/event_stores": { "get": { "operationId": "GET/promotionRuleId/event_stores", "summary": "Retrieve the event stores associated to the promotion rule", "description": "Retrieve the event stores associated to the promotion rule", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "promotionRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the promotion rule" } } } }, "/promotions": { "get": { "operationId": "GET/promotions", "summary": "List all promotions", "description": "List all promotions", "tags": [ "promotions" ], "responses": { "200": { "description": "A list of promotion objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/promotionResponseList" } } } } } } }, "/promotions/{promotionId}": { "get": { "operationId": "GET/promotions/promotionId", "summary": "Retrieve a promotion", "description": "Retrieve a promotion", "tags": [ "promotions" ], "parameters": [ { "name": "promotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The promotion object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/promotionResponse" } } } } } } }, "/promotions/{promotionId}/market": { "get": { "operationId": "GET/promotionId/market", "summary": "Retrieve the market associated to the promotion", "description": "Retrieve the market associated to the promotion", "tags": [ "has_one", "markets" ], "parameters": [ { "name": "promotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The market associated to the promotion" } } } }, "/promotions/{promotionId}/order_amount_promotion_rule": { "get": { "operationId": "GET/promotionId/order_amount_promotion_rule", "summary": "Retrieve the order amount promotion rule associated to the promotion", "description": "Retrieve the order amount promotion rule associated to the promotion", "tags": [ "has_one", "order_amount_promotion_rules" ], "parameters": [ { "name": "promotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order_amount_promotion_rule associated to the promotion" } } } }, "/promotions/{promotionId}/sku_list_promotion_rule": { "get": { "operationId": "GET/promotionId/sku_list_promotion_rule", "summary": "Retrieve the sku list promotion rule associated to the promotion", "description": "Retrieve the sku list promotion rule associated to the promotion", "tags": [ "has_one", "sku_list_promotion_rules" ], "parameters": [ { "name": "promotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_list_promotion_rule associated to the promotion" } } } }, "/promotions/{promotionId}/coupon_codes_promotion_rule": { "get": { "operationId": "GET/promotionId/coupon_codes_promotion_rule", "summary": "Retrieve the coupon codes promotion rule associated to the promotion", "description": "Retrieve the coupon codes promotion rule associated to the promotion", "tags": [ "has_one", "coupon_codes_promotion_rules" ], "parameters": [ { "name": "promotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupon_codes_promotion_rule associated to the promotion" } } } }, "/promotions/{promotionId}/custom_promotion_rule": { "get": { "operationId": "GET/promotionId/custom_promotion_rule", "summary": "Retrieve the custom promotion rule associated to the promotion", "description": "Retrieve the custom promotion rule associated to the promotion", "tags": [ "has_one", "custom_promotion_rules" ], "parameters": [ { "name": "promotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The custom_promotion_rule associated to the promotion" } } } }, "/promotions/{promotionId}/sku_list": { "get": { "operationId": "GET/promotionId/sku_list", "summary": "Retrieve the sku list associated to the promotion", "description": "Retrieve the sku list associated to the promotion", "tags": [ "has_one", "sku_lists" ], "parameters": [ { "name": "promotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_list associated to the promotion" } } } }, "/promotions/{promotionId}/coupons": { "get": { "operationId": "GET/promotionId/coupons", "summary": "Retrieve the coupons associated to the promotion", "description": "Retrieve the coupons associated to the promotion", "tags": [ "has_many", "coupons" ], "parameters": [ { "name": "promotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The coupons associated to the promotion" } } } }, "/promotions/{promotionId}/attachments": { "get": { "operationId": "GET/promotionId/attachments", "summary": "Retrieve the attachments associated to the promotion", "description": "Retrieve the attachments associated to the promotion", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "promotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the promotion" } } } }, "/promotions/{promotionId}/events": { "get": { "operationId": "GET/promotionId/events", "summary": "Retrieve the events associated to the promotion", "description": "Retrieve the events associated to the promotion", "tags": [ "has_many", "events" ], "parameters": [ { "name": "promotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the promotion" } } } }, "/promotions/{promotionId}/tags": { "get": { "operationId": "GET/promotionId/tags", "summary": "Retrieve the tags associated to the promotion", "description": "Retrieve the tags associated to the promotion", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "promotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the promotion" } } } }, "/promotions/{promotionId}/event_stores": { "get": { "operationId": "GET/promotionId/event_stores", "summary": "Retrieve the event stores associated to the promotion", "description": "Retrieve the event stores associated to the promotion", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "promotionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the promotion" } } } }, "/recurring_order_copies": { "get": { "operationId": "GET/recurring_order_copies", "summary": "List all recurring order copies", "description": "List all recurring order copies", "tags": [ "recurring_order_copies" ], "responses": { "200": { "description": "A list of recurring order copy objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/recurringOrderCopyResponseList" } } } } } }, "post": { "operationId": "POST/recurring_order_copies", "summary": "Create a recurring order copy", "description": "Create a recurring order copy", "tags": [ "recurring_order_copies" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/recurringOrderCopyCreate" } } } }, "responses": { "201": { "description": "The created recurring order copy object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/recurringOrderCopyResponse" } } } } } } }, "/recurring_order_copies/{recurringOrderCopyId}": { "get": { "operationId": "GET/recurring_order_copies/recurringOrderCopyId", "summary": "Retrieve a recurring order copy", "description": "Retrieve a recurring order copy", "tags": [ "recurring_order_copies" ], "parameters": [ { "name": "recurringOrderCopyId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The recurring order copy object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/recurringOrderCopyResponse" } } } } } }, "patch": { "operationId": "PATCH/recurring_order_copies/recurringOrderCopyId", "summary": "Update a recurring order copy", "description": "Update a recurring order copy", "tags": [ "recurring_order_copies" ], "parameters": [ { "name": "recurringOrderCopyId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/recurringOrderCopyUpdate" } } } }, "responses": { "200": { "description": "The updated recurring order copy object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/recurringOrderCopyResponse" } } } } } }, "delete": { "operationId": "DELETE/recurring_order_copies/recurringOrderCopyId", "summary": "Delete a recurring order copy", "description": "Delete a recurring order copy", "tags": [ "recurring_order_copies" ], "parameters": [ { "name": "recurringOrderCopyId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/recurring_order_copies/{recurringOrderCopyId}/source_order": { "get": { "operationId": "GET/recurringOrderCopyId/source_order", "summary": "Retrieve the source order associated to the recurring order copy", "description": "Retrieve the source order associated to the recurring order copy", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "recurringOrderCopyId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The source_order associated to the recurring order copy" } } } }, "/recurring_order_copies/{recurringOrderCopyId}/target_order": { "get": { "operationId": "GET/recurringOrderCopyId/target_order", "summary": "Retrieve the target order associated to the recurring order copy", "description": "Retrieve the target order associated to the recurring order copy", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "recurringOrderCopyId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The target_order associated to the recurring order copy" } } } }, "/recurring_order_copies/{recurringOrderCopyId}/events": { "get": { "operationId": "GET/recurringOrderCopyId/events", "summary": "Retrieve the events associated to the recurring order copy", "description": "Retrieve the events associated to the recurring order copy", "tags": [ "has_many", "events" ], "parameters": [ { "name": "recurringOrderCopyId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the recurring order copy" } } } }, "/recurring_order_copies/{recurringOrderCopyId}/event_stores": { "get": { "operationId": "GET/recurringOrderCopyId/event_stores", "summary": "Retrieve the event stores associated to the recurring order copy", "description": "Retrieve the event stores associated to the recurring order copy", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "recurringOrderCopyId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the recurring order copy" } } } }, "/recurring_order_copies/{recurringOrderCopyId}/order_subscription": { "get": { "operationId": "GET/recurringOrderCopyId/order_subscription", "summary": "Retrieve the order subscription associated to the recurring order copy", "description": "Retrieve the order subscription associated to the recurring order copy", "tags": [ "has_one", "order_subscriptions" ], "parameters": [ { "name": "recurringOrderCopyId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order_subscription associated to the recurring order copy" } } } }, "/refunds": { "get": { "operationId": "GET/refunds", "summary": "List all refunds", "description": "List all refunds", "tags": [ "refunds" ], "responses": { "200": { "description": "A list of refund objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/refundResponseList" } } } } } } }, "/refunds/{refundId}": { "get": { "operationId": "GET/refunds/refundId", "summary": "Retrieve a refund", "description": "Retrieve a refund", "tags": [ "refunds" ], "parameters": [ { "name": "refundId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The refund object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/refundResponse" } } } } } }, "patch": { "operationId": "PATCH/refunds/refundId", "summary": "Update a refund", "description": "Update a refund", "tags": [ "refunds" ], "parameters": [ { "name": "refundId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/refundUpdate" } } } }, "responses": { "200": { "description": "The updated refund object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/refundResponse" } } } } } } }, "/refunds/{refundId}/order": { "get": { "operationId": "GET/refundId/order", "summary": "Retrieve the order associated to the refund", "description": "Retrieve the order associated to the refund", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "refundId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order associated to the refund" } } } }, "/refunds/{refundId}/attachments": { "get": { "operationId": "GET/refundId/attachments", "summary": "Retrieve the attachments associated to the refund", "description": "Retrieve the attachments associated to the refund", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "refundId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the refund" } } } }, "/refunds/{refundId}/events": { "get": { "operationId": "GET/refundId/events", "summary": "Retrieve the events associated to the refund", "description": "Retrieve the events associated to the refund", "tags": [ "has_many", "events" ], "parameters": [ { "name": "refundId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the refund" } } } }, "/refunds/{refundId}/event_stores": { "get": { "operationId": "GET/refundId/event_stores", "summary": "Retrieve the event stores associated to the refund", "description": "Retrieve the event stores associated to the refund", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "refundId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the refund" } } } }, "/refunds/{refundId}/reference_capture": { "get": { "operationId": "GET/refundId/reference_capture", "summary": "Retrieve the reference capture associated to the refund", "description": "Retrieve the reference capture associated to the refund", "tags": [ "has_one", "captures" ], "parameters": [ { "name": "refundId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The reference_capture associated to the refund" } } } }, "/refunds/{refundId}/return": { "get": { "operationId": "GET/refundId/return", "summary": "Retrieve the return associated to the refund", "description": "Retrieve the return associated to the refund", "tags": [ "has_one", "returns" ], "parameters": [ { "name": "refundId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The return associated to the refund" } } } }, "/reserved_stocks": { "get": { "operationId": "GET/reserved_stocks", "summary": "List all reserved stocks", "description": "List all reserved stocks", "tags": [ "reserved_stocks" ], "responses": { "200": { "description": "A list of reserved stock objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/reservedStockResponseList" } } } } } } }, "/reserved_stocks/{reservedStockId}": { "get": { "operationId": "GET/reserved_stocks/reservedStockId", "summary": "Retrieve a reserved stock", "description": "Retrieve a reserved stock", "tags": [ "reserved_stocks" ], "parameters": [ { "name": "reservedStockId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The reserved stock object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/reservedStockResponse" } } } } } } }, "/reserved_stocks/{reservedStockId}/stock_item": { "get": { "operationId": "GET/reservedStockId/stock_item", "summary": "Retrieve the stock item associated to the reserved stock", "description": "Retrieve the stock item associated to the reserved stock", "tags": [ "has_one", "stock_items" ], "parameters": [ { "name": "reservedStockId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_item associated to the reserved stock" } } } }, "/reserved_stocks/{reservedStockId}/sku": { "get": { "operationId": "GET/reservedStockId/sku", "summary": "Retrieve the sku associated to the reserved stock", "description": "Retrieve the sku associated to the reserved stock", "tags": [ "has_one", "skus" ], "parameters": [ { "name": "reservedStockId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku associated to the reserved stock" } } } }, "/reserved_stocks/{reservedStockId}/stock_reservations": { "get": { "operationId": "GET/reservedStockId/stock_reservations", "summary": "Retrieve the stock reservations associated to the reserved stock", "description": "Retrieve the stock reservations associated to the reserved stock", "tags": [ "has_many", "stock_reservations" ], "parameters": [ { "name": "reservedStockId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_reservations associated to the reserved stock" } } } }, "/reserved_stocks/{reservedStockId}/event_stores": { "get": { "operationId": "GET/reservedStockId/event_stores", "summary": "Retrieve the event stores associated to the reserved stock", "description": "Retrieve the event stores associated to the reserved stock", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "reservedStockId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the reserved stock" } } } }, "/resource_errors": { "get": { "operationId": "GET/resource_errors", "summary": "List all resource errors", "description": "List all resource errors", "tags": [ "resource_errors" ], "responses": { "200": { "description": "A list of resource error objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/resourceErrorResponseList" } } } } } } }, "/resource_errors/{resourceErrorId}": { "get": { "operationId": "GET/resource_errors/resourceErrorId", "summary": "Retrieve a resource error", "description": "Retrieve a resource error", "tags": [ "resource_errors" ], "parameters": [ { "name": "resourceErrorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The resource error object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/resourceErrorResponse" } } } } } } }, "/resource_errors/{resourceErrorId}/event_stores": { "get": { "operationId": "GET/resourceErrorId/event_stores", "summary": "Retrieve the event stores associated to the resource error", "description": "Retrieve the event stores associated to the resource error", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "resourceErrorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the resource error" } } } }, "/return_line_items": { "get": { "operationId": "GET/return_line_items", "summary": "List all return line items", "description": "List all return line items", "tags": [ "return_line_items" ], "responses": { "200": { "description": "A list of return line item objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/returnLineItemResponseList" } } } } } }, "post": { "operationId": "POST/return_line_items", "summary": "Create a return line item", "description": "Create a return line item", "tags": [ "return_line_items" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/returnLineItemCreate" } } } }, "responses": { "201": { "description": "The created return line item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/returnLineItemResponse" } } } } } } }, "/return_line_items/{returnLineItemId}": { "get": { "operationId": "GET/return_line_items/returnLineItemId", "summary": "Retrieve a return line item", "description": "Retrieve a return line item", "tags": [ "return_line_items" ], "parameters": [ { "name": "returnLineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The return line item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/returnLineItemResponse" } } } } } }, "patch": { "operationId": "PATCH/return_line_items/returnLineItemId", "summary": "Update a return line item", "description": "Update a return line item", "tags": [ "return_line_items" ], "parameters": [ { "name": "returnLineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/returnLineItemUpdate" } } } }, "responses": { "200": { "description": "The updated return line item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/returnLineItemResponse" } } } } } }, "delete": { "operationId": "DELETE/return_line_items/returnLineItemId", "summary": "Delete a return line item", "description": "Delete a return line item", "tags": [ "return_line_items" ], "parameters": [ { "name": "returnLineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/return_line_items/{returnLineItemId}/return": { "get": { "operationId": "GET/returnLineItemId/return", "summary": "Retrieve the return associated to the return line item", "description": "Retrieve the return associated to the return line item", "tags": [ "has_one", "returns" ], "parameters": [ { "name": "returnLineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The return associated to the return line item" } } } }, "/return_line_items/{returnLineItemId}/line_item": { "get": { "operationId": "GET/returnLineItemId/line_item", "summary": "Retrieve the line item associated to the return line item", "description": "Retrieve the line item associated to the return line item", "tags": [ "has_one", "line_items" ], "parameters": [ { "name": "returnLineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The line_item associated to the return line item" } } } }, "/return_line_items/{returnLineItemId}/event_stores": { "get": { "operationId": "GET/returnLineItemId/event_stores", "summary": "Retrieve the event stores associated to the return line item", "description": "Retrieve the event stores associated to the return line item", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "returnLineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the return line item" } } } }, "/returns": { "get": { "operationId": "GET/returns", "summary": "List all returns", "description": "List all returns", "tags": [ "returns" ], "responses": { "200": { "description": "A list of return objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/returnResponseList" } } } } } }, "post": { "operationId": "POST/returns", "summary": "Create a return", "description": "Create a return", "tags": [ "returns" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/returnCreate" } } } }, "responses": { "201": { "description": "The created return object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/returnResponse" } } } } } } }, "/returns/{returnId}": { "get": { "operationId": "GET/returns/returnId", "summary": "Retrieve a return", "description": "Retrieve a return", "tags": [ "returns" ], "parameters": [ { "name": "returnId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The return object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/returnResponse" } } } } } }, "patch": { "operationId": "PATCH/returns/returnId", "summary": "Update a return", "description": "Update a return", "tags": [ "returns" ], "parameters": [ { "name": "returnId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/returnUpdate" } } } }, "responses": { "200": { "description": "The updated return object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/returnResponse" } } } } } }, "delete": { "operationId": "DELETE/returns/returnId", "summary": "Delete a return", "description": "Delete a return", "tags": [ "returns" ], "parameters": [ { "name": "returnId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/returns/{returnId}/order": { "get": { "operationId": "GET/returnId/order", "summary": "Retrieve the order associated to the return", "description": "Retrieve the order associated to the return", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "returnId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order associated to the return" } } } }, "/returns/{returnId}/customer": { "get": { "operationId": "GET/returnId/customer", "summary": "Retrieve the customer associated to the return", "description": "Retrieve the customer associated to the return", "tags": [ "has_one", "customers" ], "parameters": [ { "name": "returnId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer associated to the return" } } } }, "/returns/{returnId}/stock_location": { "get": { "operationId": "GET/returnId/stock_location", "summary": "Retrieve the stock location associated to the return", "description": "Retrieve the stock location associated to the return", "tags": [ "has_one", "stock_locations" ], "parameters": [ { "name": "returnId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_location associated to the return" } } } }, "/returns/{returnId}/origin_address": { "get": { "operationId": "GET/returnId/origin_address", "summary": "Retrieve the origin address associated to the return", "description": "Retrieve the origin address associated to the return", "tags": [ "has_one", "addresses" ], "parameters": [ { "name": "returnId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The origin_address associated to the return" } } } }, "/returns/{returnId}/destination_address": { "get": { "operationId": "GET/returnId/destination_address", "summary": "Retrieve the destination address associated to the return", "description": "Retrieve the destination address associated to the return", "tags": [ "has_one", "addresses" ], "parameters": [ { "name": "returnId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The destination_address associated to the return" } } } }, "/returns/{returnId}/reference_capture": { "get": { "operationId": "GET/returnId/reference_capture", "summary": "Retrieve the reference capture associated to the return", "description": "Retrieve the reference capture associated to the return", "tags": [ "has_one", "captures" ], "parameters": [ { "name": "returnId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The reference_capture associated to the return" } } } }, "/returns/{returnId}/reference_refund": { "get": { "operationId": "GET/returnId/reference_refund", "summary": "Retrieve the reference refund associated to the return", "description": "Retrieve the reference refund associated to the return", "tags": [ "has_one", "refunds" ], "parameters": [ { "name": "returnId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The reference_refund associated to the return" } } } }, "/returns/{returnId}/return_line_items": { "get": { "operationId": "GET/returnId/return_line_items", "summary": "Retrieve the return line items associated to the return", "description": "Retrieve the return line items associated to the return", "tags": [ "has_many", "return_line_items" ], "parameters": [ { "name": "returnId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The return_line_items associated to the return" } } } }, "/returns/{returnId}/attachments": { "get": { "operationId": "GET/returnId/attachments", "summary": "Retrieve the attachments associated to the return", "description": "Retrieve the attachments associated to the return", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "returnId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the return" } } } }, "/returns/{returnId}/resource_errors": { "get": { "operationId": "GET/returnId/resource_errors", "summary": "Retrieve the resource errors associated to the return", "description": "Retrieve the resource errors associated to the return", "tags": [ "has_many", "resource_errors" ], "parameters": [ { "name": "returnId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The resource_errors associated to the return" } } } }, "/returns/{returnId}/events": { "get": { "operationId": "GET/returnId/events", "summary": "Retrieve the events associated to the return", "description": "Retrieve the events associated to the return", "tags": [ "has_many", "events" ], "parameters": [ { "name": "returnId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the return" } } } }, "/returns/{returnId}/tags": { "get": { "operationId": "GET/returnId/tags", "summary": "Retrieve the tags associated to the return", "description": "Retrieve the tags associated to the return", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "returnId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the return" } } } }, "/returns/{returnId}/event_stores": { "get": { "operationId": "GET/returnId/event_stores", "summary": "Retrieve the event stores associated to the return", "description": "Retrieve the event stores associated to the return", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "returnId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the return" } } } }, "/satispay_gateways": { "get": { "operationId": "GET/satispay_gateways", "summary": "List all satispay gateways", "description": "List all satispay gateways", "tags": [ "satispay_gateways" ], "responses": { "200": { "description": "A list of satispay gateway objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/satispayGatewayResponseList" } } } } } }, "post": { "operationId": "POST/satispay_gateways", "summary": "Create a satispay gateway", "description": "Create a satispay gateway", "tags": [ "satispay_gateways" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/satispayGatewayCreate" } } } }, "responses": { "201": { "description": "The created satispay gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/satispayGatewayResponse" } } } } } } }, "/satispay_gateways/{satispayGatewayId}": { "get": { "operationId": "GET/satispay_gateways/satispayGatewayId", "summary": "Retrieve a satispay gateway", "description": "Retrieve a satispay gateway", "tags": [ "satispay_gateways" ], "parameters": [ { "name": "satispayGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The satispay gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/satispayGatewayResponse" } } } } } }, "patch": { "operationId": "PATCH/satispay_gateways/satispayGatewayId", "summary": "Update a satispay gateway", "description": "Update a satispay gateway", "tags": [ "satispay_gateways" ], "parameters": [ { "name": "satispayGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/satispayGatewayUpdate" } } } }, "responses": { "200": { "description": "The updated satispay gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/satispayGatewayResponse" } } } } } }, "delete": { "operationId": "DELETE/satispay_gateways/satispayGatewayId", "summary": "Delete a satispay gateway", "description": "Delete a satispay gateway", "tags": [ "satispay_gateways" ], "parameters": [ { "name": "satispayGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/satispay_gateways/{satispayGatewayId}/payment_methods": { "get": { "operationId": "GET/satispayGatewayId/payment_methods", "summary": "Retrieve the payment methods associated to the satispay gateway", "description": "Retrieve the payment methods associated to the satispay gateway", "tags": [ "has_many", "payment_methods" ], "parameters": [ { "name": "satispayGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_methods associated to the satispay gateway" } } } }, "/satispay_gateways/{satispayGatewayId}/event_stores": { "get": { "operationId": "GET/satispayGatewayId/event_stores", "summary": "Retrieve the event stores associated to the satispay gateway", "description": "Retrieve the event stores associated to the satispay gateway", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "satispayGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the satispay gateway" } } } }, "/satispay_gateways/{satispayGatewayId}/satispay_payments": { "get": { "operationId": "GET/satispayGatewayId/satispay_payments", "summary": "Retrieve the satispay payments associated to the satispay gateway", "description": "Retrieve the satispay payments associated to the satispay gateway", "tags": [ "has_many", "satispay_payments" ], "parameters": [ { "name": "satispayGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The satispay_payments associated to the satispay gateway" } } } }, "/satispay_payments": { "get": { "operationId": "GET/satispay_payments", "summary": "List all satispay payments", "description": "List all satispay payments", "tags": [ "satispay_payments" ], "responses": { "200": { "description": "A list of satispay payment objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/satispayPaymentResponseList" } } } } } }, "post": { "operationId": "POST/satispay_payments", "summary": "Create a satispay payment", "description": "Create a satispay payment", "tags": [ "satispay_payments" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/satispayPaymentCreate" } } } }, "responses": { "201": { "description": "The created satispay payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/satispayPaymentResponse" } } } } } } }, "/satispay_payments/{satispayPaymentId}": { "get": { "operationId": "GET/satispay_payments/satispayPaymentId", "summary": "Retrieve a satispay payment", "description": "Retrieve a satispay payment", "tags": [ "satispay_payments" ], "parameters": [ { "name": "satispayPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The satispay payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/satispayPaymentResponse" } } } } } }, "patch": { "operationId": "PATCH/satispay_payments/satispayPaymentId", "summary": "Update a satispay payment", "description": "Update a satispay payment", "tags": [ "satispay_payments" ], "parameters": [ { "name": "satispayPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/satispayPaymentUpdate" } } } }, "responses": { "200": { "description": "The updated satispay payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/satispayPaymentResponse" } } } } } }, "delete": { "operationId": "DELETE/satispay_payments/satispayPaymentId", "summary": "Delete a satispay payment", "description": "Delete a satispay payment", "tags": [ "satispay_payments" ], "parameters": [ { "name": "satispayPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/satispay_payments/{satispayPaymentId}/order": { "get": { "operationId": "GET/satispayPaymentId/order", "summary": "Retrieve the order associated to the satispay payment", "description": "Retrieve the order associated to the satispay payment", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "satispayPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order associated to the satispay payment" } } } }, "/satispay_payments/{satispayPaymentId}/payment_gateway": { "get": { "operationId": "GET/satispayPaymentId/payment_gateway", "summary": "Retrieve the payment gateway associated to the satispay payment", "description": "Retrieve the payment gateway associated to the satispay payment", "tags": [ "has_one", "payment_gateways" ], "parameters": [ { "name": "satispayPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_gateway associated to the satispay payment" } } } }, "/satispay_payments/{satispayPaymentId}/event_stores": { "get": { "operationId": "GET/satispayPaymentId/event_stores", "summary": "Retrieve the event stores associated to the satispay payment", "description": "Retrieve the event stores associated to the satispay payment", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "satispayPaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the satispay payment" } } } }, "/shipments": { "get": { "operationId": "GET/shipments", "summary": "List all shipments", "description": "List all shipments", "tags": [ "shipments" ], "responses": { "200": { "description": "A list of shipment objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shipmentResponseList" } } } } } }, "post": { "operationId": "POST/shipments", "summary": "Create a shipment", "description": "Create a shipment", "tags": [ "shipments" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shipmentCreate" } } } }, "responses": { "201": { "description": "The created shipment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shipmentResponse" } } } } } } }, "/shipments/{shipmentId}": { "get": { "operationId": "GET/shipments/shipmentId", "summary": "Retrieve a shipment", "description": "Retrieve a shipment", "tags": [ "shipments" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shipmentResponse" } } } } } }, "patch": { "operationId": "PATCH/shipments/shipmentId", "summary": "Update a shipment", "description": "Update a shipment", "tags": [ "shipments" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shipmentUpdate" } } } }, "responses": { "200": { "description": "The updated shipment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shipmentResponse" } } } } } }, "delete": { "operationId": "DELETE/shipments/shipmentId", "summary": "Delete a shipment", "description": "Delete a shipment", "tags": [ "shipments" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/shipments/{shipmentId}/order": { "get": { "operationId": "GET/shipmentId/order", "summary": "Retrieve the order associated to the shipment", "description": "Retrieve the order associated to the shipment", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order associated to the shipment" } } } }, "/shipments/{shipmentId}/shipping_category": { "get": { "operationId": "GET/shipmentId/shipping_category", "summary": "Retrieve the shipping category associated to the shipment", "description": "Retrieve the shipping category associated to the shipment", "tags": [ "has_one", "shipping_categories" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipping_category associated to the shipment" } } } }, "/shipments/{shipmentId}/inventory_stock_location": { "get": { "operationId": "GET/shipmentId/inventory_stock_location", "summary": "Retrieve the inventory stock location associated to the shipment", "description": "Retrieve the inventory stock location associated to the shipment", "tags": [ "has_one", "inventory_stock_locations" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The inventory_stock_location associated to the shipment" } } } }, "/shipments/{shipmentId}/stock_location": { "get": { "operationId": "GET/shipmentId/stock_location", "summary": "Retrieve the stock location associated to the shipment", "description": "Retrieve the stock location associated to the shipment", "tags": [ "has_one", "stock_locations" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_location associated to the shipment" } } } }, "/shipments/{shipmentId}/origin_address": { "get": { "operationId": "GET/shipmentId/origin_address", "summary": "Retrieve the origin address associated to the shipment", "description": "Retrieve the origin address associated to the shipment", "tags": [ "has_one", "addresses" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The origin_address associated to the shipment" } } } }, "/shipments/{shipmentId}/shipping_address": { "get": { "operationId": "GET/shipmentId/shipping_address", "summary": "Retrieve the shipping address associated to the shipment", "description": "Retrieve the shipping address associated to the shipment", "tags": [ "has_one", "addresses" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipping_address associated to the shipment" } } } }, "/shipments/{shipmentId}/shipping_method": { "get": { "operationId": "GET/shipmentId/shipping_method", "summary": "Retrieve the shipping method associated to the shipment", "description": "Retrieve the shipping method associated to the shipment", "tags": [ "has_one", "shipping_methods" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipping_method associated to the shipment" } } } }, "/shipments/{shipmentId}/delivery_lead_time": { "get": { "operationId": "GET/shipmentId/delivery_lead_time", "summary": "Retrieve the delivery lead time associated to the shipment", "description": "Retrieve the delivery lead time associated to the shipment", "tags": [ "has_one", "delivery_lead_times" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The delivery_lead_time associated to the shipment" } } } }, "/shipments/{shipmentId}/pickup": { "get": { "operationId": "GET/shipmentId/pickup", "summary": "Retrieve the pickup associated to the shipment", "description": "Retrieve the pickup associated to the shipment", "tags": [ "has_one", "pickups" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The pickup associated to the shipment" } } } }, "/shipments/{shipmentId}/stock_line_items": { "get": { "operationId": "GET/shipmentId/stock_line_items", "summary": "Retrieve the stock line items associated to the shipment", "description": "Retrieve the stock line items associated to the shipment", "tags": [ "has_many", "stock_line_items" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_line_items associated to the shipment" } } } }, "/shipments/{shipmentId}/stock_transfers": { "get": { "operationId": "GET/shipmentId/stock_transfers", "summary": "Retrieve the stock transfers associated to the shipment", "description": "Retrieve the stock transfers associated to the shipment", "tags": [ "has_many", "stock_transfers" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_transfers associated to the shipment" } } } }, "/shipments/{shipmentId}/line_items": { "get": { "operationId": "GET/shipmentId/line_items", "summary": "Retrieve the line items associated to the shipment", "description": "Retrieve the line items associated to the shipment", "tags": [ "has_many", "line_items" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The line_items associated to the shipment" } } } }, "/shipments/{shipmentId}/available_shipping_methods": { "get": { "operationId": "GET/shipmentId/available_shipping_methods", "summary": "Retrieve the available shipping methods associated to the shipment", "description": "Retrieve the available shipping methods associated to the shipment", "tags": [ "has_many", "shipping_methods" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The available_shipping_methods associated to the shipment" } } } }, "/shipments/{shipmentId}/carrier_accounts": { "get": { "operationId": "GET/shipmentId/carrier_accounts", "summary": "Retrieve the carrier accounts associated to the shipment", "description": "Retrieve the carrier accounts associated to the shipment", "tags": [ "has_many", "carrier_accounts" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The carrier_accounts associated to the shipment" } } } }, "/shipments/{shipmentId}/parcels": { "get": { "operationId": "GET/shipmentId/parcels", "summary": "Retrieve the parcels associated to the shipment", "description": "Retrieve the parcels associated to the shipment", "tags": [ "has_many", "parcels" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The parcels associated to the shipment" } } } }, "/shipments/{shipmentId}/attachments": { "get": { "operationId": "GET/shipmentId/attachments", "summary": "Retrieve the attachments associated to the shipment", "description": "Retrieve the attachments associated to the shipment", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the shipment" } } } }, "/shipments/{shipmentId}/events": { "get": { "operationId": "GET/shipmentId/events", "summary": "Retrieve the events associated to the shipment", "description": "Retrieve the events associated to the shipment", "tags": [ "has_many", "events" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the shipment" } } } }, "/shipments/{shipmentId}/tags": { "get": { "operationId": "GET/shipmentId/tags", "summary": "Retrieve the tags associated to the shipment", "description": "Retrieve the tags associated to the shipment", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the shipment" } } } }, "/shipments/{shipmentId}/event_stores": { "get": { "operationId": "GET/shipmentId/event_stores", "summary": "Retrieve the event stores associated to the shipment", "description": "Retrieve the event stores associated to the shipment", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the shipment" } } } }, "/shipping_categories": { "get": { "operationId": "GET/shipping_categories", "summary": "List all shipping categories", "description": "List all shipping categories", "tags": [ "shipping_categories" ], "responses": { "200": { "description": "A list of shipping category objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingCategoryResponseList" } } } } } }, "post": { "operationId": "POST/shipping_categories", "summary": "Create a shipping category", "description": "Create a shipping category", "tags": [ "shipping_categories" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingCategoryCreate" } } } }, "responses": { "201": { "description": "The created shipping category object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingCategoryResponse" } } } } } } }, "/shipping_categories/{shippingCategoryId}": { "get": { "operationId": "GET/shipping_categories/shippingCategoryId", "summary": "Retrieve a shipping category", "description": "Retrieve a shipping category", "tags": [ "shipping_categories" ], "parameters": [ { "name": "shippingCategoryId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipping category object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingCategoryResponse" } } } } } }, "patch": { "operationId": "PATCH/shipping_categories/shippingCategoryId", "summary": "Update a shipping category", "description": "Update a shipping category", "tags": [ "shipping_categories" ], "parameters": [ { "name": "shippingCategoryId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingCategoryUpdate" } } } }, "responses": { "200": { "description": "The updated shipping category object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingCategoryResponse" } } } } } }, "delete": { "operationId": "DELETE/shipping_categories/shippingCategoryId", "summary": "Delete a shipping category", "description": "Delete a shipping category", "tags": [ "shipping_categories" ], "parameters": [ { "name": "shippingCategoryId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/shipping_categories/{shippingCategoryId}/skus": { "get": { "operationId": "GET/shippingCategoryId/skus", "summary": "Retrieve the skus associated to the shipping category", "description": "Retrieve the skus associated to the shipping category", "tags": [ "has_many", "skus" ], "parameters": [ { "name": "shippingCategoryId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The skus associated to the shipping category" } } } }, "/shipping_categories/{shippingCategoryId}/attachments": { "get": { "operationId": "GET/shippingCategoryId/attachments", "summary": "Retrieve the attachments associated to the shipping category", "description": "Retrieve the attachments associated to the shipping category", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "shippingCategoryId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the shipping category" } } } }, "/shipping_categories/{shippingCategoryId}/event_stores": { "get": { "operationId": "GET/shippingCategoryId/event_stores", "summary": "Retrieve the event stores associated to the shipping category", "description": "Retrieve the event stores associated to the shipping category", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "shippingCategoryId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the shipping category" } } } }, "/shipping_method_tiers": { "get": { "operationId": "GET/shipping_method_tiers", "summary": "List all shipping method tiers", "description": "List all shipping method tiers", "tags": [ "shipping_method_tiers" ], "responses": { "200": { "description": "A list of shipping method tier objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingMethodTierResponseList" } } } } } } }, "/shipping_method_tiers/{shippingMethodTierId}": { "get": { "operationId": "GET/shipping_method_tiers/shippingMethodTierId", "summary": "Retrieve a shipping method tier", "description": "Retrieve a shipping method tier", "tags": [ "shipping_method_tiers" ], "parameters": [ { "name": "shippingMethodTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipping method tier object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingMethodTierResponse" } } } } } } }, "/shipping_method_tiers/{shippingMethodTierId}/shipping_method": { "get": { "operationId": "GET/shippingMethodTierId/shipping_method", "summary": "Retrieve the shipping method associated to the shipping method tier", "description": "Retrieve the shipping method associated to the shipping method tier", "tags": [ "has_one", "shipping_methods" ], "parameters": [ { "name": "shippingMethodTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipping_method associated to the shipping method tier" } } } }, "/shipping_method_tiers/{shippingMethodTierId}/attachments": { "get": { "operationId": "GET/shippingMethodTierId/attachments", "summary": "Retrieve the attachments associated to the shipping method tier", "description": "Retrieve the attachments associated to the shipping method tier", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "shippingMethodTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the shipping method tier" } } } }, "/shipping_method_tiers/{shippingMethodTierId}/event_stores": { "get": { "operationId": "GET/shippingMethodTierId/event_stores", "summary": "Retrieve the event stores associated to the shipping method tier", "description": "Retrieve the event stores associated to the shipping method tier", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "shippingMethodTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the shipping method tier" } } } }, "/shipping_methods": { "get": { "operationId": "GET/shipping_methods", "summary": "List all shipping methods", "description": "List all shipping methods", "tags": [ "shipping_methods" ], "responses": { "200": { "description": "A list of shipping method objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingMethodResponseList" } } } } } }, "post": { "operationId": "POST/shipping_methods", "summary": "Create a shipping method", "description": "Create a shipping method", "tags": [ "shipping_methods" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingMethodCreate" } } } }, "responses": { "201": { "description": "The created shipping method object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingMethodResponse" } } } } } } }, "/shipping_methods/{shippingMethodId}": { "get": { "operationId": "GET/shipping_methods/shippingMethodId", "summary": "Retrieve a shipping method", "description": "Retrieve a shipping method", "tags": [ "shipping_methods" ], "parameters": [ { "name": "shippingMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipping method object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingMethodResponse" } } } } } }, "patch": { "operationId": "PATCH/shipping_methods/shippingMethodId", "summary": "Update a shipping method", "description": "Update a shipping method", "tags": [ "shipping_methods" ], "parameters": [ { "name": "shippingMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingMethodUpdate" } } } }, "responses": { "200": { "description": "The updated shipping method object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingMethodResponse" } } } } } }, "delete": { "operationId": "DELETE/shipping_methods/shippingMethodId", "summary": "Delete a shipping method", "description": "Delete a shipping method", "tags": [ "shipping_methods" ], "parameters": [ { "name": "shippingMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/shipping_methods/{shippingMethodId}/market": { "get": { "operationId": "GET/shippingMethodId/market", "summary": "Retrieve the market associated to the shipping method", "description": "Retrieve the market associated to the shipping method", "tags": [ "has_one", "markets" ], "parameters": [ { "name": "shippingMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The market associated to the shipping method" } } } }, "/shipping_methods/{shippingMethodId}/shipping_zone": { "get": { "operationId": "GET/shippingMethodId/shipping_zone", "summary": "Retrieve the shipping zone associated to the shipping method", "description": "Retrieve the shipping zone associated to the shipping method", "tags": [ "has_one", "shipping_zones" ], "parameters": [ { "name": "shippingMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipping_zone associated to the shipping method" } } } }, "/shipping_methods/{shippingMethodId}/shipping_category": { "get": { "operationId": "GET/shippingMethodId/shipping_category", "summary": "Retrieve the shipping category associated to the shipping method", "description": "Retrieve the shipping category associated to the shipping method", "tags": [ "has_one", "shipping_categories" ], "parameters": [ { "name": "shippingMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipping_category associated to the shipping method" } } } }, "/shipping_methods/{shippingMethodId}/stock_location": { "get": { "operationId": "GET/shippingMethodId/stock_location", "summary": "Retrieve the stock location associated to the shipping method", "description": "Retrieve the stock location associated to the shipping method", "tags": [ "has_one", "stock_locations" ], "parameters": [ { "name": "shippingMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_location associated to the shipping method" } } } }, "/shipping_methods/{shippingMethodId}/delivery_lead_time_for_shipment": { "get": { "operationId": "GET/shippingMethodId/delivery_lead_time_for_shipment", "summary": "Retrieve the delivery lead time for shipment associated to the shipping method", "description": "Retrieve the delivery lead time for shipment associated to the shipping method", "tags": [ "has_one", "delivery_lead_times" ], "parameters": [ { "name": "shippingMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The delivery_lead_time_for_shipment associated to the shipping method" } } } }, "/shipping_methods/{shippingMethodId}/shipping_method_tiers": { "get": { "operationId": "GET/shippingMethodId/shipping_method_tiers", "summary": "Retrieve the shipping method tiers associated to the shipping method", "description": "Retrieve the shipping method tiers associated to the shipping method", "tags": [ "has_many", "shipping_method_tiers" ], "parameters": [ { "name": "shippingMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipping_method_tiers associated to the shipping method" } } } }, "/shipping_methods/{shippingMethodId}/shipping_weight_tiers": { "get": { "operationId": "GET/shippingMethodId/shipping_weight_tiers", "summary": "Retrieve the shipping weight tiers associated to the shipping method", "description": "Retrieve the shipping weight tiers associated to the shipping method", "tags": [ "has_many", "shipping_weight_tiers" ], "parameters": [ { "name": "shippingMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipping_weight_tiers associated to the shipping method" } } } }, "/shipping_methods/{shippingMethodId}/attachments": { "get": { "operationId": "GET/shippingMethodId/attachments", "summary": "Retrieve the attachments associated to the shipping method", "description": "Retrieve the attachments associated to the shipping method", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "shippingMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the shipping method" } } } }, "/shipping_methods/{shippingMethodId}/notifications": { "get": { "operationId": "GET/shippingMethodId/notifications", "summary": "Retrieve the notifications associated to the shipping method", "description": "Retrieve the notifications associated to the shipping method", "tags": [ "has_many", "notifications" ], "parameters": [ { "name": "shippingMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The notifications associated to the shipping method" } } } }, "/shipping_methods/{shippingMethodId}/events": { "get": { "operationId": "GET/shippingMethodId/events", "summary": "Retrieve the events associated to the shipping method", "description": "Retrieve the events associated to the shipping method", "tags": [ "has_many", "events" ], "parameters": [ { "name": "shippingMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the shipping method" } } } }, "/shipping_methods/{shippingMethodId}/tags": { "get": { "operationId": "GET/shippingMethodId/tags", "summary": "Retrieve the tags associated to the shipping method", "description": "Retrieve the tags associated to the shipping method", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "shippingMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the shipping method" } } } }, "/shipping_methods/{shippingMethodId}/event_stores": { "get": { "operationId": "GET/shippingMethodId/event_stores", "summary": "Retrieve the event stores associated to the shipping method", "description": "Retrieve the event stores associated to the shipping method", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "shippingMethodId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the shipping method" } } } }, "/shipping_weight_tiers": { "get": { "operationId": "GET/shipping_weight_tiers", "summary": "List all shipping weight tiers", "description": "List all shipping weight tiers", "tags": [ "shipping_weight_tiers" ], "responses": { "200": { "description": "A list of shipping weight tier objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingWeightTierResponseList" } } } } } }, "post": { "operationId": "POST/shipping_weight_tiers", "summary": "Create a shipping weight tier", "description": "Create a shipping weight tier", "tags": [ "shipping_weight_tiers" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingWeightTierCreate" } } } }, "responses": { "201": { "description": "The created shipping weight tier object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingWeightTierResponse" } } } } } } }, "/shipping_weight_tiers/{shippingWeightTierId}": { "get": { "operationId": "GET/shipping_weight_tiers/shippingWeightTierId", "summary": "Retrieve a shipping weight tier", "description": "Retrieve a shipping weight tier", "tags": [ "shipping_weight_tiers" ], "parameters": [ { "name": "shippingWeightTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipping weight tier object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingWeightTierResponse" } } } } } }, "patch": { "operationId": "PATCH/shipping_weight_tiers/shippingWeightTierId", "summary": "Update a shipping weight tier", "description": "Update a shipping weight tier", "tags": [ "shipping_weight_tiers" ], "parameters": [ { "name": "shippingWeightTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingWeightTierUpdate" } } } }, "responses": { "200": { "description": "The updated shipping weight tier object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingWeightTierResponse" } } } } } }, "delete": { "operationId": "DELETE/shipping_weight_tiers/shippingWeightTierId", "summary": "Delete a shipping weight tier", "description": "Delete a shipping weight tier", "tags": [ "shipping_weight_tiers" ], "parameters": [ { "name": "shippingWeightTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/shipping_weight_tiers/{shippingWeightTierId}/shipping_method": { "get": { "operationId": "GET/shippingWeightTierId/shipping_method", "summary": "Retrieve the shipping method associated to the shipping weight tier", "description": "Retrieve the shipping method associated to the shipping weight tier", "tags": [ "has_one", "shipping_methods" ], "parameters": [ { "name": "shippingWeightTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipping_method associated to the shipping weight tier" } } } }, "/shipping_weight_tiers/{shippingWeightTierId}/attachments": { "get": { "operationId": "GET/shippingWeightTierId/attachments", "summary": "Retrieve the attachments associated to the shipping weight tier", "description": "Retrieve the attachments associated to the shipping weight tier", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "shippingWeightTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the shipping weight tier" } } } }, "/shipping_weight_tiers/{shippingWeightTierId}/event_stores": { "get": { "operationId": "GET/shippingWeightTierId/event_stores", "summary": "Retrieve the event stores associated to the shipping weight tier", "description": "Retrieve the event stores associated to the shipping weight tier", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "shippingWeightTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the shipping weight tier" } } } }, "/shipping_weight_tiers/{shippingWeightTierId}/events": { "get": { "operationId": "GET/shippingWeightTierId/events", "summary": "Retrieve the events associated to the shipping weight tier", "description": "Retrieve the events associated to the shipping weight tier", "tags": [ "has_many", "events" ], "parameters": [ { "name": "shippingWeightTierId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the shipping weight tier" } } } }, "/shipping_zones": { "get": { "operationId": "GET/shipping_zones", "summary": "List all shipping zones", "description": "List all shipping zones", "tags": [ "shipping_zones" ], "responses": { "200": { "description": "A list of shipping zone objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingZoneResponseList" } } } } } }, "post": { "operationId": "POST/shipping_zones", "summary": "Create a shipping zone", "description": "Create a shipping zone", "tags": [ "shipping_zones" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingZoneCreate" } } } }, "responses": { "201": { "description": "The created shipping zone object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingZoneResponse" } } } } } } }, "/shipping_zones/{shippingZoneId}": { "get": { "operationId": "GET/shipping_zones/shippingZoneId", "summary": "Retrieve a shipping zone", "description": "Retrieve a shipping zone", "tags": [ "shipping_zones" ], "parameters": [ { "name": "shippingZoneId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipping zone object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingZoneResponse" } } } } } }, "patch": { "operationId": "PATCH/shipping_zones/shippingZoneId", "summary": "Update a shipping zone", "description": "Update a shipping zone", "tags": [ "shipping_zones" ], "parameters": [ { "name": "shippingZoneId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingZoneUpdate" } } } }, "responses": { "200": { "description": "The updated shipping zone object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/shippingZoneResponse" } } } } } }, "delete": { "operationId": "DELETE/shipping_zones/shippingZoneId", "summary": "Delete a shipping zone", "description": "Delete a shipping zone", "tags": [ "shipping_zones" ], "parameters": [ { "name": "shippingZoneId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/shipping_zones/{shippingZoneId}/attachments": { "get": { "operationId": "GET/shippingZoneId/attachments", "summary": "Retrieve the attachments associated to the shipping zone", "description": "Retrieve the attachments associated to the shipping zone", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "shippingZoneId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the shipping zone" } } } }, "/shipping_zones/{shippingZoneId}/event_stores": { "get": { "operationId": "GET/shippingZoneId/event_stores", "summary": "Retrieve the event stores associated to the shipping zone", "description": "Retrieve the event stores associated to the shipping zone", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "shippingZoneId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the shipping zone" } } } }, "/sku_list_items": { "get": { "operationId": "GET/sku_list_items", "summary": "List all SKU list items", "description": "List all SKU list items", "tags": [ "sku_list_items" ], "responses": { "200": { "description": "A list of SKU list item objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuListItemResponseList" } } } } } }, "post": { "operationId": "POST/sku_list_items", "summary": "Create a SKU list item", "description": "Create a SKU list item", "tags": [ "sku_list_items" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuListItemCreate" } } } }, "responses": { "201": { "description": "The created SKU list item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuListItemResponse" } } } } } } }, "/sku_list_items/{skuListItemId}": { "get": { "operationId": "GET/sku_list_items/skuListItemId", "summary": "Retrieve a SKU list item", "description": "Retrieve a SKU list item", "tags": [ "sku_list_items" ], "parameters": [ { "name": "skuListItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The SKU list item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuListItemResponse" } } } } } }, "patch": { "operationId": "PATCH/sku_list_items/skuListItemId", "summary": "Update a SKU list item", "description": "Update a SKU list item", "tags": [ "sku_list_items" ], "parameters": [ { "name": "skuListItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuListItemUpdate" } } } }, "responses": { "200": { "description": "The updated SKU list item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuListItemResponse" } } } } } }, "delete": { "operationId": "DELETE/sku_list_items/skuListItemId", "summary": "Delete a SKU list item", "description": "Delete a SKU list item", "tags": [ "sku_list_items" ], "parameters": [ { "name": "skuListItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/sku_list_items/{skuListItemId}/sku_list": { "get": { "operationId": "GET/skuListItemId/sku_list", "summary": "Retrieve the sku list associated to the SKU list item", "description": "Retrieve the sku list associated to the SKU list item", "tags": [ "has_one", "sku_lists" ], "parameters": [ { "name": "skuListItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_list associated to the SKU list item" } } } }, "/sku_list_items/{skuListItemId}/sku": { "get": { "operationId": "GET/skuListItemId/sku", "summary": "Retrieve the sku associated to the SKU list item", "description": "Retrieve the sku associated to the SKU list item", "tags": [ "has_one", "skus" ], "parameters": [ { "name": "skuListItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku associated to the SKU list item" } } } }, "/sku_list_items/{skuListItemId}/event_stores": { "get": { "operationId": "GET/skuListItemId/event_stores", "summary": "Retrieve the event stores associated to the SKU list item", "description": "Retrieve the event stores associated to the SKU list item", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "skuListItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the SKU list item" } } } }, "/sku_list_promotion_rules": { "get": { "operationId": "GET/sku_list_promotion_rules", "summary": "List all SKU list promotion rules", "description": "List all SKU list promotion rules", "tags": [ "sku_list_promotion_rules" ], "responses": { "200": { "description": "A list of SKU list promotion rule objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuListPromotionRuleResponseList" } } } } } }, "post": { "operationId": "POST/sku_list_promotion_rules", "summary": "Create a SKU list promotion rule", "description": "Create a SKU list promotion rule", "tags": [ "sku_list_promotion_rules" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuListPromotionRuleCreate" } } } }, "responses": { "201": { "description": "The created SKU list promotion rule object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuListPromotionRuleResponse" } } } } } } }, "/sku_list_promotion_rules/{skuListPromotionRuleId}": { "get": { "operationId": "GET/sku_list_promotion_rules/skuListPromotionRuleId", "summary": "Retrieve a SKU list promotion rule", "description": "Retrieve a SKU list promotion rule", "tags": [ "sku_list_promotion_rules" ], "parameters": [ { "name": "skuListPromotionRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The SKU list promotion rule object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuListPromotionRuleResponse" } } } } } }, "patch": { "operationId": "PATCH/sku_list_promotion_rules/skuListPromotionRuleId", "summary": "Update a SKU list promotion rule", "description": "Update a SKU list promotion rule", "tags": [ "sku_list_promotion_rules" ], "parameters": [ { "name": "skuListPromotionRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuListPromotionRuleUpdate" } } } }, "responses": { "200": { "description": "The updated SKU list promotion rule object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuListPromotionRuleResponse" } } } } } }, "delete": { "operationId": "DELETE/sku_list_promotion_rules/skuListPromotionRuleId", "summary": "Delete a SKU list promotion rule", "description": "Delete a SKU list promotion rule", "tags": [ "sku_list_promotion_rules" ], "parameters": [ { "name": "skuListPromotionRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/sku_list_promotion_rules/{skuListPromotionRuleId}/event_stores": { "get": { "operationId": "GET/skuListPromotionRuleId/event_stores", "summary": "Retrieve the event stores associated to the SKU list promotion rule", "description": "Retrieve the event stores associated to the SKU list promotion rule", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "skuListPromotionRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the SKU list promotion rule" } } } }, "/sku_list_promotion_rules/{skuListPromotionRuleId}/sku_list": { "get": { "operationId": "GET/skuListPromotionRuleId/sku_list", "summary": "Retrieve the sku list associated to the SKU list promotion rule", "description": "Retrieve the sku list associated to the SKU list promotion rule", "tags": [ "has_one", "sku_lists" ], "parameters": [ { "name": "skuListPromotionRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_list associated to the SKU list promotion rule" } } } }, "/sku_list_promotion_rules/{skuListPromotionRuleId}/skus": { "get": { "operationId": "GET/skuListPromotionRuleId/skus", "summary": "Retrieve the skus associated to the SKU list promotion rule", "description": "Retrieve the skus associated to the SKU list promotion rule", "tags": [ "has_many", "skus" ], "parameters": [ { "name": "skuListPromotionRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The skus associated to the SKU list promotion rule" } } } }, "/sku_lists": { "get": { "operationId": "GET/sku_lists", "summary": "List all SKU lists", "description": "List all SKU lists", "tags": [ "sku_lists" ], "responses": { "200": { "description": "A list of SKU list objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuListResponseList" } } } } } }, "post": { "operationId": "POST/sku_lists", "summary": "Create a SKU list", "description": "Create a SKU list", "tags": [ "sku_lists" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuListCreate" } } } }, "responses": { "201": { "description": "The created SKU list object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuListResponse" } } } } } } }, "/sku_lists/{skuListId}": { "get": { "operationId": "GET/sku_lists/skuListId", "summary": "Retrieve a SKU list", "description": "Retrieve a SKU list", "tags": [ "sku_lists" ], "parameters": [ { "name": "skuListId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The SKU list object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuListResponse" } } } } } }, "patch": { "operationId": "PATCH/sku_lists/skuListId", "summary": "Update a SKU list", "description": "Update a SKU list", "tags": [ "sku_lists" ], "parameters": [ { "name": "skuListId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuListUpdate" } } } }, "responses": { "200": { "description": "The updated SKU list object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuListResponse" } } } } } }, "delete": { "operationId": "DELETE/sku_lists/skuListId", "summary": "Delete a SKU list", "description": "Delete a SKU list", "tags": [ "sku_lists" ], "parameters": [ { "name": "skuListId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/sku_lists/{skuListId}/customer": { "get": { "operationId": "GET/skuListId/customer", "summary": "Retrieve the customer associated to the SKU list", "description": "Retrieve the customer associated to the SKU list", "tags": [ "has_one", "customers" ], "parameters": [ { "name": "skuListId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The customer associated to the SKU list" } } } }, "/sku_lists/{skuListId}/skus": { "get": { "operationId": "GET/skuListId/skus", "summary": "Retrieve the skus associated to the SKU list", "description": "Retrieve the skus associated to the SKU list", "tags": [ "has_many", "skus" ], "parameters": [ { "name": "skuListId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The skus associated to the SKU list" } } } }, "/sku_lists/{skuListId}/sku_list_items": { "get": { "operationId": "GET/skuListId/sku_list_items", "summary": "Retrieve the sku list items associated to the SKU list", "description": "Retrieve the sku list items associated to the SKU list", "tags": [ "has_many", "sku_list_items" ], "parameters": [ { "name": "skuListId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_list_items associated to the SKU list" } } } }, "/sku_lists/{skuListId}/bundles": { "get": { "operationId": "GET/skuListId/bundles", "summary": "Retrieve the bundles associated to the SKU list", "description": "Retrieve the bundles associated to the SKU list", "tags": [ "has_many", "bundles" ], "parameters": [ { "name": "skuListId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The bundles associated to the SKU list" } } } }, "/sku_lists/{skuListId}/attachments": { "get": { "operationId": "GET/skuListId/attachments", "summary": "Retrieve the attachments associated to the SKU list", "description": "Retrieve the attachments associated to the SKU list", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "skuListId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the SKU list" } } } }, "/sku_lists/{skuListId}/links": { "get": { "operationId": "GET/skuListId/links", "summary": "Retrieve the links associated to the SKU list", "description": "Retrieve the links associated to the SKU list", "tags": [ "has_many", "links" ], "parameters": [ { "name": "skuListId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The links associated to the SKU list" } } } }, "/sku_lists/{skuListId}/event_stores": { "get": { "operationId": "GET/skuListId/event_stores", "summary": "Retrieve the event stores associated to the SKU list", "description": "Retrieve the event stores associated to the SKU list", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "skuListId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the SKU list" } } } }, "/sku_options": { "get": { "operationId": "GET/sku_options", "summary": "List all SKU options", "description": "List all SKU options", "tags": [ "sku_options" ], "responses": { "200": { "description": "A list of SKU option objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuOptionResponseList" } } } } } }, "post": { "operationId": "POST/sku_options", "summary": "Create a SKU option", "description": "Create a SKU option", "tags": [ "sku_options" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuOptionCreate" } } } }, "responses": { "201": { "description": "The created SKU option object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuOptionResponse" } } } } } } }, "/sku_options/{skuOptionId}": { "get": { "operationId": "GET/sku_options/skuOptionId", "summary": "Retrieve a SKU option", "description": "Retrieve a SKU option", "tags": [ "sku_options" ], "parameters": [ { "name": "skuOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The SKU option object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuOptionResponse" } } } } } }, "patch": { "operationId": "PATCH/sku_options/skuOptionId", "summary": "Update a SKU option", "description": "Update a SKU option", "tags": [ "sku_options" ], "parameters": [ { "name": "skuOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuOptionUpdate" } } } }, "responses": { "200": { "description": "The updated SKU option object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuOptionResponse" } } } } } }, "delete": { "operationId": "DELETE/sku_options/skuOptionId", "summary": "Delete a SKU option", "description": "Delete a SKU option", "tags": [ "sku_options" ], "parameters": [ { "name": "skuOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/sku_options/{skuOptionId}/market": { "get": { "operationId": "GET/skuOptionId/market", "summary": "Retrieve the market associated to the SKU option", "description": "Retrieve the market associated to the SKU option", "tags": [ "has_one", "markets" ], "parameters": [ { "name": "skuOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The market associated to the SKU option" } } } }, "/sku_options/{skuOptionId}/attachments": { "get": { "operationId": "GET/skuOptionId/attachments", "summary": "Retrieve the attachments associated to the SKU option", "description": "Retrieve the attachments associated to the SKU option", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "skuOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the SKU option" } } } }, "/sku_options/{skuOptionId}/events": { "get": { "operationId": "GET/skuOptionId/events", "summary": "Retrieve the events associated to the SKU option", "description": "Retrieve the events associated to the SKU option", "tags": [ "has_many", "events" ], "parameters": [ { "name": "skuOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the SKU option" } } } }, "/sku_options/{skuOptionId}/tags": { "get": { "operationId": "GET/skuOptionId/tags", "summary": "Retrieve the tags associated to the SKU option", "description": "Retrieve the tags associated to the SKU option", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "skuOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the SKU option" } } } }, "/sku_options/{skuOptionId}/event_stores": { "get": { "operationId": "GET/skuOptionId/event_stores", "summary": "Retrieve the event stores associated to the SKU option", "description": "Retrieve the event stores associated to the SKU option", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "skuOptionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the SKU option" } } } }, "/skus": { "get": { "operationId": "GET/skus", "summary": "List all SKUs", "description": "List all SKUs", "tags": [ "skus" ], "responses": { "200": { "description": "A list of SKU objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuResponseList" } } } } } }, "post": { "operationId": "POST/skus", "summary": "Create a SKU", "description": "Create a SKU", "tags": [ "skus" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuCreate" } } } }, "responses": { "201": { "description": "The created SKU object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuResponse" } } } } } } }, "/skus/{skuId}": { "get": { "operationId": "GET/skus/skuId", "summary": "Retrieve a SKU", "description": "Retrieve a SKU", "tags": [ "skus" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The SKU object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuResponse" } } } } } }, "patch": { "operationId": "PATCH/skus/skuId", "summary": "Update a SKU", "description": "Update a SKU", "tags": [ "skus" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuUpdate" } } } }, "responses": { "200": { "description": "The updated SKU object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/skuResponse" } } } } } }, "delete": { "operationId": "DELETE/skus/skuId", "summary": "Delete a SKU", "description": "Delete a SKU", "tags": [ "skus" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/skus/{skuId}/shipping_category": { "get": { "operationId": "GET/skuId/shipping_category", "summary": "Retrieve the shipping category associated to the SKU", "description": "Retrieve the shipping category associated to the SKU", "tags": [ "has_one", "shipping_categories" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipping_category associated to the SKU" } } } }, "/skus/{skuId}/prices": { "get": { "operationId": "GET/skuId/prices", "summary": "Retrieve the prices associated to the SKU", "description": "Retrieve the prices associated to the SKU", "tags": [ "has_many", "prices" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The prices associated to the SKU" } } } }, "/skus/{skuId}/stock_items": { "get": { "operationId": "GET/skuId/stock_items", "summary": "Retrieve the stock items associated to the SKU", "description": "Retrieve the stock items associated to the SKU", "tags": [ "has_many", "stock_items" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_items associated to the SKU" } } } }, "/skus/{skuId}/stock_reservations": { "get": { "operationId": "GET/skuId/stock_reservations", "summary": "Retrieve the stock reservations associated to the SKU", "description": "Retrieve the stock reservations associated to the SKU", "tags": [ "has_many", "stock_reservations" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_reservations associated to the SKU" } } } }, "/skus/{skuId}/delivery_lead_times": { "get": { "operationId": "GET/skuId/delivery_lead_times", "summary": "Retrieve the delivery lead times associated to the SKU", "description": "Retrieve the delivery lead times associated to the SKU", "tags": [ "has_many", "delivery_lead_times" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The delivery_lead_times associated to the SKU" } } } }, "/skus/{skuId}/sku_options": { "get": { "operationId": "GET/skuId/sku_options", "summary": "Retrieve the sku options associated to the SKU", "description": "Retrieve the sku options associated to the SKU", "tags": [ "has_many", "sku_options" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_options associated to the SKU" } } } }, "/skus/{skuId}/sku_list_items": { "get": { "operationId": "GET/skuId/sku_list_items", "summary": "Retrieve the sku list items associated to the SKU", "description": "Retrieve the sku list items associated to the SKU", "tags": [ "has_many", "sku_list_items" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_list_items associated to the SKU" } } } }, "/skus/{skuId}/sku_lists": { "get": { "operationId": "GET/skuId/sku_lists", "summary": "Retrieve the sku lists associated to the SKU", "description": "Retrieve the sku lists associated to the SKU", "tags": [ "has_many", "sku_lists" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku_lists associated to the SKU" } } } }, "/skus/{skuId}/attachments": { "get": { "operationId": "GET/skuId/attachments", "summary": "Retrieve the attachments associated to the SKU", "description": "Retrieve the attachments associated to the SKU", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the SKU" } } } }, "/skus/{skuId}/links": { "get": { "operationId": "GET/skuId/links", "summary": "Retrieve the links associated to the SKU", "description": "Retrieve the links associated to the SKU", "tags": [ "has_many", "links" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The links associated to the SKU" } } } }, "/skus/{skuId}/events": { "get": { "operationId": "GET/skuId/events", "summary": "Retrieve the events associated to the SKU", "description": "Retrieve the events associated to the SKU", "tags": [ "has_many", "events" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the SKU" } } } }, "/skus/{skuId}/tags": { "get": { "operationId": "GET/skuId/tags", "summary": "Retrieve the tags associated to the SKU", "description": "Retrieve the tags associated to the SKU", "tags": [ "has_many", "tags" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tags associated to the SKU" } } } }, "/skus/{skuId}/jwt_customer": { "get": { "operationId": "GET/skuId/jwt_customer", "summary": "Retrieve the jwt customer associated to the SKU", "description": "Retrieve the jwt customer associated to the SKU", "tags": [ "has_one", "customers" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The jwt_customer associated to the SKU" } } } }, "/skus/{skuId}/jwt_markets": { "get": { "operationId": "GET/skuId/jwt_markets", "summary": "Retrieve the jwt markets associated to the SKU", "description": "Retrieve the jwt markets associated to the SKU", "tags": [ "has_many", "markets" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The jwt_markets associated to the SKU" } } } }, "/skus/{skuId}/jwt_stock_locations": { "get": { "operationId": "GET/skuId/jwt_stock_locations", "summary": "Retrieve the jwt stock locations associated to the SKU", "description": "Retrieve the jwt stock locations associated to the SKU", "tags": [ "has_many", "stock_locations" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The jwt_stock_locations associated to the SKU" } } } }, "/skus/{skuId}/event_stores": { "get": { "operationId": "GET/skuId/event_stores", "summary": "Retrieve the event stores associated to the SKU", "description": "Retrieve the event stores associated to the SKU", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "skuId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the SKU" } } } }, "/stock_items": { "get": { "operationId": "GET/stock_items", "summary": "List all stock items", "description": "List all stock items", "tags": [ "stock_items" ], "responses": { "200": { "description": "A list of stock item objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockItemResponseList" } } } } } }, "post": { "operationId": "POST/stock_items", "summary": "Create a stock item", "description": "Create a stock item", "tags": [ "stock_items" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockItemCreate" } } } }, "responses": { "201": { "description": "The created stock item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockItemResponse" } } } } } } }, "/stock_items/{stockItemId}": { "get": { "operationId": "GET/stock_items/stockItemId", "summary": "Retrieve a stock item", "description": "Retrieve a stock item", "tags": [ "stock_items" ], "parameters": [ { "name": "stockItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockItemResponse" } } } } } }, "patch": { "operationId": "PATCH/stock_items/stockItemId", "summary": "Update a stock item", "description": "Update a stock item", "tags": [ "stock_items" ], "parameters": [ { "name": "stockItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockItemUpdate" } } } }, "responses": { "200": { "description": "The updated stock item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockItemResponse" } } } } } }, "delete": { "operationId": "DELETE/stock_items/stockItemId", "summary": "Delete a stock item", "description": "Delete a stock item", "tags": [ "stock_items" ], "parameters": [ { "name": "stockItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/stock_items/{stockItemId}/stock_location": { "get": { "operationId": "GET/stockItemId/stock_location", "summary": "Retrieve the stock location associated to the stock item", "description": "Retrieve the stock location associated to the stock item", "tags": [ "has_one", "stock_locations" ], "parameters": [ { "name": "stockItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_location associated to the stock item" } } } }, "/stock_items/{stockItemId}/sku": { "get": { "operationId": "GET/stockItemId/sku", "summary": "Retrieve the sku associated to the stock item", "description": "Retrieve the sku associated to the stock item", "tags": [ "has_one", "skus" ], "parameters": [ { "name": "stockItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku associated to the stock item" } } } }, "/stock_items/{stockItemId}/reserved_stock": { "get": { "operationId": "GET/stockItemId/reserved_stock", "summary": "Retrieve the reserved stock associated to the stock item", "description": "Retrieve the reserved stock associated to the stock item", "tags": [ "has_one", "reserved_stocks" ], "parameters": [ { "name": "stockItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The reserved_stock associated to the stock item" } } } }, "/stock_items/{stockItemId}/stock_reservations": { "get": { "operationId": "GET/stockItemId/stock_reservations", "summary": "Retrieve the stock reservations associated to the stock item", "description": "Retrieve the stock reservations associated to the stock item", "tags": [ "has_many", "stock_reservations" ], "parameters": [ { "name": "stockItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_reservations associated to the stock item" } } } }, "/stock_items/{stockItemId}/attachments": { "get": { "operationId": "GET/stockItemId/attachments", "summary": "Retrieve the attachments associated to the stock item", "description": "Retrieve the attachments associated to the stock item", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "stockItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the stock item" } } } }, "/stock_items/{stockItemId}/event_stores": { "get": { "operationId": "GET/stockItemId/event_stores", "summary": "Retrieve the event stores associated to the stock item", "description": "Retrieve the event stores associated to the stock item", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "stockItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the stock item" } } } }, "/stock_line_items": { "get": { "operationId": "GET/stock_line_items", "summary": "List all stock line items", "description": "List all stock line items", "tags": [ "stock_line_items" ], "responses": { "200": { "description": "A list of stock line item objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockLineItemResponseList" } } } } } }, "post": { "operationId": "POST/stock_line_items", "summary": "Create a stock line item", "description": "Create a stock line item", "tags": [ "stock_line_items" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockLineItemCreate" } } } }, "responses": { "201": { "description": "The created stock line item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockLineItemResponse" } } } } } } }, "/stock_line_items/{stockLineItemId}": { "get": { "operationId": "GET/stock_line_items/stockLineItemId", "summary": "Retrieve a stock line item", "description": "Retrieve a stock line item", "tags": [ "stock_line_items" ], "parameters": [ { "name": "stockLineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock line item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockLineItemResponse" } } } } } }, "patch": { "operationId": "PATCH/stock_line_items/stockLineItemId", "summary": "Update a stock line item", "description": "Update a stock line item", "tags": [ "stock_line_items" ], "parameters": [ { "name": "stockLineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockLineItemUpdate" } } } }, "responses": { "200": { "description": "The updated stock line item object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockLineItemResponse" } } } } } }, "delete": { "operationId": "DELETE/stock_line_items/stockLineItemId", "summary": "Delete a stock line item", "description": "Delete a stock line item", "tags": [ "stock_line_items" ], "parameters": [ { "name": "stockLineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/stock_line_items/{stockLineItemId}/shipment": { "get": { "operationId": "GET/stockLineItemId/shipment", "summary": "Retrieve the shipment associated to the stock line item", "description": "Retrieve the shipment associated to the stock line item", "tags": [ "has_one", "shipments" ], "parameters": [ { "name": "stockLineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipment associated to the stock line item" } } } }, "/stock_line_items/{stockLineItemId}/line_item": { "get": { "operationId": "GET/stockLineItemId/line_item", "summary": "Retrieve the line item associated to the stock line item", "description": "Retrieve the line item associated to the stock line item", "tags": [ "has_one", "line_items" ], "parameters": [ { "name": "stockLineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The line_item associated to the stock line item" } } } }, "/stock_line_items/{stockLineItemId}/stock_item": { "get": { "operationId": "GET/stockLineItemId/stock_item", "summary": "Retrieve the stock item associated to the stock line item", "description": "Retrieve the stock item associated to the stock line item", "tags": [ "has_one", "stock_items" ], "parameters": [ { "name": "stockLineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_item associated to the stock line item" } } } }, "/stock_line_items/{stockLineItemId}/sku": { "get": { "operationId": "GET/stockLineItemId/sku", "summary": "Retrieve the sku associated to the stock line item", "description": "Retrieve the sku associated to the stock line item", "tags": [ "has_one", "skus" ], "parameters": [ { "name": "stockLineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku associated to the stock line item" } } } }, "/stock_line_items/{stockLineItemId}/stock_reservation": { "get": { "operationId": "GET/stockLineItemId/stock_reservation", "summary": "Retrieve the stock reservation associated to the stock line item", "description": "Retrieve the stock reservation associated to the stock line item", "tags": [ "has_one", "stock_reservations" ], "parameters": [ { "name": "stockLineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_reservation associated to the stock line item" } } } }, "/stock_line_items/{stockLineItemId}/event_stores": { "get": { "operationId": "GET/stockLineItemId/event_stores", "summary": "Retrieve the event stores associated to the stock line item", "description": "Retrieve the event stores associated to the stock line item", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "stockLineItemId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the stock line item" } } } }, "/stock_locations": { "get": { "operationId": "GET/stock_locations", "summary": "List all stock locations", "description": "List all stock locations", "tags": [ "stock_locations" ], "responses": { "200": { "description": "A list of stock location objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockLocationResponseList" } } } } } }, "post": { "operationId": "POST/stock_locations", "summary": "Create a stock location", "description": "Create a stock location", "tags": [ "stock_locations" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockLocationCreate" } } } }, "responses": { "201": { "description": "The created stock location object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockLocationResponse" } } } } } } }, "/stock_locations/{stockLocationId}": { "get": { "operationId": "GET/stock_locations/stockLocationId", "summary": "Retrieve a stock location", "description": "Retrieve a stock location", "tags": [ "stock_locations" ], "parameters": [ { "name": "stockLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock location object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockLocationResponse" } } } } } }, "patch": { "operationId": "PATCH/stock_locations/stockLocationId", "summary": "Update a stock location", "description": "Update a stock location", "tags": [ "stock_locations" ], "parameters": [ { "name": "stockLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockLocationUpdate" } } } }, "responses": { "200": { "description": "The updated stock location object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockLocationResponse" } } } } } }, "delete": { "operationId": "DELETE/stock_locations/stockLocationId", "summary": "Delete a stock location", "description": "Delete a stock location", "tags": [ "stock_locations" ], "parameters": [ { "name": "stockLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/stock_locations/{stockLocationId}/address": { "get": { "operationId": "GET/stockLocationId/address", "summary": "Retrieve the address associated to the stock location", "description": "Retrieve the address associated to the stock location", "tags": [ "has_one", "addresses" ], "parameters": [ { "name": "stockLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The address associated to the stock location" } } } }, "/stock_locations/{stockLocationId}/inventory_stock_locations": { "get": { "operationId": "GET/stockLocationId/inventory_stock_locations", "summary": "Retrieve the inventory stock locations associated to the stock location", "description": "Retrieve the inventory stock locations associated to the stock location", "tags": [ "has_many", "inventory_stock_locations" ], "parameters": [ { "name": "stockLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The inventory_stock_locations associated to the stock location" } } } }, "/stock_locations/{stockLocationId}/inventory_return_locations": { "get": { "operationId": "GET/stockLocationId/inventory_return_locations", "summary": "Retrieve the inventory return locations associated to the stock location", "description": "Retrieve the inventory return locations associated to the stock location", "tags": [ "has_many", "inventory_return_locations" ], "parameters": [ { "name": "stockLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The inventory_return_locations associated to the stock location" } } } }, "/stock_locations/{stockLocationId}/stock_items": { "get": { "operationId": "GET/stockLocationId/stock_items", "summary": "Retrieve the stock items associated to the stock location", "description": "Retrieve the stock items associated to the stock location", "tags": [ "has_many", "stock_items" ], "parameters": [ { "name": "stockLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_items associated to the stock location" } } } }, "/stock_locations/{stockLocationId}/stock_transfers": { "get": { "operationId": "GET/stockLocationId/stock_transfers", "summary": "Retrieve the stock transfers associated to the stock location", "description": "Retrieve the stock transfers associated to the stock location", "tags": [ "has_many", "stock_transfers" ], "parameters": [ { "name": "stockLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_transfers associated to the stock location" } } } }, "/stock_locations/{stockLocationId}/stores": { "get": { "operationId": "GET/stockLocationId/stores", "summary": "Retrieve the stores associated to the stock location", "description": "Retrieve the stores associated to the stock location", "tags": [ "has_many", "stores" ], "parameters": [ { "name": "stockLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stores associated to the stock location" } } } }, "/stock_locations/{stockLocationId}/attachments": { "get": { "operationId": "GET/stockLocationId/attachments", "summary": "Retrieve the attachments associated to the stock location", "description": "Retrieve the attachments associated to the stock location", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "stockLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the stock location" } } } }, "/stock_locations/{stockLocationId}/event_stores": { "get": { "operationId": "GET/stockLocationId/event_stores", "summary": "Retrieve the event stores associated to the stock location", "description": "Retrieve the event stores associated to the stock location", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "stockLocationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the stock location" } } } }, "/stock_reservations": { "get": { "operationId": "GET/stock_reservations", "summary": "List all stock reservations", "description": "List all stock reservations", "tags": [ "stock_reservations" ], "responses": { "200": { "description": "A list of stock reservation objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockReservationResponseList" } } } } } }, "post": { "operationId": "POST/stock_reservations", "summary": "Create a stock reservation", "description": "Create a stock reservation", "tags": [ "stock_reservations" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockReservationCreate" } } } }, "responses": { "201": { "description": "The created stock reservation object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockReservationResponse" } } } } } } }, "/stock_reservations/{stockReservationId}": { "get": { "operationId": "GET/stock_reservations/stockReservationId", "summary": "Retrieve a stock reservation", "description": "Retrieve a stock reservation", "tags": [ "stock_reservations" ], "parameters": [ { "name": "stockReservationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock reservation object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockReservationResponse" } } } } } }, "patch": { "operationId": "PATCH/stock_reservations/stockReservationId", "summary": "Update a stock reservation", "description": "Update a stock reservation", "tags": [ "stock_reservations" ], "parameters": [ { "name": "stockReservationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockReservationUpdate" } } } }, "responses": { "200": { "description": "The updated stock reservation object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockReservationResponse" } } } } } }, "delete": { "operationId": "DELETE/stock_reservations/stockReservationId", "summary": "Delete a stock reservation", "description": "Delete a stock reservation", "tags": [ "stock_reservations" ], "parameters": [ { "name": "stockReservationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/stock_reservations/{stockReservationId}/line_item": { "get": { "operationId": "GET/stockReservationId/line_item", "summary": "Retrieve the line item associated to the stock reservation", "description": "Retrieve the line item associated to the stock reservation", "tags": [ "has_one", "line_items" ], "parameters": [ { "name": "stockReservationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The line_item associated to the stock reservation" } } } }, "/stock_reservations/{stockReservationId}/order": { "get": { "operationId": "GET/stockReservationId/order", "summary": "Retrieve the order associated to the stock reservation", "description": "Retrieve the order associated to the stock reservation", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "stockReservationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order associated to the stock reservation" } } } }, "/stock_reservations/{stockReservationId}/stock_line_item": { "get": { "operationId": "GET/stockReservationId/stock_line_item", "summary": "Retrieve the stock line item associated to the stock reservation", "description": "Retrieve the stock line item associated to the stock reservation", "tags": [ "has_one", "stock_line_items" ], "parameters": [ { "name": "stockReservationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_line_item associated to the stock reservation" } } } }, "/stock_reservations/{stockReservationId}/stock_transfer": { "get": { "operationId": "GET/stockReservationId/stock_transfer", "summary": "Retrieve the stock transfer associated to the stock reservation", "description": "Retrieve the stock transfer associated to the stock reservation", "tags": [ "has_one", "stock_transfers" ], "parameters": [ { "name": "stockReservationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_transfer associated to the stock reservation" } } } }, "/stock_reservations/{stockReservationId}/stock_item": { "get": { "operationId": "GET/stockReservationId/stock_item", "summary": "Retrieve the stock item associated to the stock reservation", "description": "Retrieve the stock item associated to the stock reservation", "tags": [ "has_one", "stock_items" ], "parameters": [ { "name": "stockReservationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_item associated to the stock reservation" } } } }, "/stock_reservations/{stockReservationId}/reserved_stock": { "get": { "operationId": "GET/stockReservationId/reserved_stock", "summary": "Retrieve the reserved stock associated to the stock reservation", "description": "Retrieve the reserved stock associated to the stock reservation", "tags": [ "has_one", "reserved_stocks" ], "parameters": [ { "name": "stockReservationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The reserved_stock associated to the stock reservation" } } } }, "/stock_reservations/{stockReservationId}/sku": { "get": { "operationId": "GET/stockReservationId/sku", "summary": "Retrieve the sku associated to the stock reservation", "description": "Retrieve the sku associated to the stock reservation", "tags": [ "has_one", "skus" ], "parameters": [ { "name": "stockReservationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku associated to the stock reservation" } } } }, "/stock_reservations/{stockReservationId}/event_stores": { "get": { "operationId": "GET/stockReservationId/event_stores", "summary": "Retrieve the event stores associated to the stock reservation", "description": "Retrieve the event stores associated to the stock reservation", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "stockReservationId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the stock reservation" } } } }, "/stock_transfers": { "get": { "operationId": "GET/stock_transfers", "summary": "List all stock transfers", "description": "List all stock transfers", "tags": [ "stock_transfers" ], "responses": { "200": { "description": "A list of stock transfer objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockTransferResponseList" } } } } } }, "post": { "operationId": "POST/stock_transfers", "summary": "Create a stock transfer", "description": "Create a stock transfer", "tags": [ "stock_transfers" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockTransferCreate" } } } }, "responses": { "201": { "description": "The created stock transfer object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockTransferResponse" } } } } } } }, "/stock_transfers/{stockTransferId}": { "get": { "operationId": "GET/stock_transfers/stockTransferId", "summary": "Retrieve a stock transfer", "description": "Retrieve a stock transfer", "tags": [ "stock_transfers" ], "parameters": [ { "name": "stockTransferId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock transfer object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockTransferResponse" } } } } } }, "patch": { "operationId": "PATCH/stock_transfers/stockTransferId", "summary": "Update a stock transfer", "description": "Update a stock transfer", "tags": [ "stock_transfers" ], "parameters": [ { "name": "stockTransferId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockTransferUpdate" } } } }, "responses": { "200": { "description": "The updated stock transfer object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stockTransferResponse" } } } } } }, "delete": { "operationId": "DELETE/stock_transfers/stockTransferId", "summary": "Delete a stock transfer", "description": "Delete a stock transfer", "tags": [ "stock_transfers" ], "parameters": [ { "name": "stockTransferId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/stock_transfers/{stockTransferId}/sku": { "get": { "operationId": "GET/stockTransferId/sku", "summary": "Retrieve the sku associated to the stock transfer", "description": "Retrieve the sku associated to the stock transfer", "tags": [ "has_one", "skus" ], "parameters": [ { "name": "stockTransferId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku associated to the stock transfer" } } } }, "/stock_transfers/{stockTransferId}/origin_stock_location": { "get": { "operationId": "GET/stockTransferId/origin_stock_location", "summary": "Retrieve the origin stock location associated to the stock transfer", "description": "Retrieve the origin stock location associated to the stock transfer", "tags": [ "has_one", "stock_locations" ], "parameters": [ { "name": "stockTransferId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The origin_stock_location associated to the stock transfer" } } } }, "/stock_transfers/{stockTransferId}/destination_stock_location": { "get": { "operationId": "GET/stockTransferId/destination_stock_location", "summary": "Retrieve the destination stock location associated to the stock transfer", "description": "Retrieve the destination stock location associated to the stock transfer", "tags": [ "has_one", "stock_locations" ], "parameters": [ { "name": "stockTransferId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The destination_stock_location associated to the stock transfer" } } } }, "/stock_transfers/{stockTransferId}/shipment": { "get": { "operationId": "GET/stockTransferId/shipment", "summary": "Retrieve the shipment associated to the stock transfer", "description": "Retrieve the shipment associated to the stock transfer", "tags": [ "has_one", "shipments" ], "parameters": [ { "name": "stockTransferId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The shipment associated to the stock transfer" } } } }, "/stock_transfers/{stockTransferId}/line_item": { "get": { "operationId": "GET/stockTransferId/line_item", "summary": "Retrieve the line item associated to the stock transfer", "description": "Retrieve the line item associated to the stock transfer", "tags": [ "has_one", "line_items" ], "parameters": [ { "name": "stockTransferId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The line_item associated to the stock transfer" } } } }, "/stock_transfers/{stockTransferId}/stock_reservation": { "get": { "operationId": "GET/stockTransferId/stock_reservation", "summary": "Retrieve the stock reservation associated to the stock transfer", "description": "Retrieve the stock reservation associated to the stock transfer", "tags": [ "has_one", "stock_reservations" ], "parameters": [ { "name": "stockTransferId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_reservation associated to the stock transfer" } } } }, "/stock_transfers/{stockTransferId}/attachments": { "get": { "operationId": "GET/stockTransferId/attachments", "summary": "Retrieve the attachments associated to the stock transfer", "description": "Retrieve the attachments associated to the stock transfer", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "stockTransferId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the stock transfer" } } } }, "/stock_transfers/{stockTransferId}/events": { "get": { "operationId": "GET/stockTransferId/events", "summary": "Retrieve the events associated to the stock transfer", "description": "Retrieve the events associated to the stock transfer", "tags": [ "has_many", "events" ], "parameters": [ { "name": "stockTransferId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the stock transfer" } } } }, "/stock_transfers/{stockTransferId}/event_stores": { "get": { "operationId": "GET/stockTransferId/event_stores", "summary": "Retrieve the event stores associated to the stock transfer", "description": "Retrieve the event stores associated to the stock transfer", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "stockTransferId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the stock transfer" } } } }, "/stores": { "get": { "operationId": "GET/stores", "summary": "List all stores", "description": "List all stores", "tags": [ "stores" ], "responses": { "200": { "description": "A list of store objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/storeResponseList" } } } } } }, "post": { "operationId": "POST/stores", "summary": "Create a store", "description": "Create a store", "tags": [ "stores" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/storeCreate" } } } }, "responses": { "201": { "description": "The created store object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/storeResponse" } } } } } } }, "/stores/{storeId}": { "get": { "operationId": "GET/stores/storeId", "summary": "Retrieve a store", "description": "Retrieve a store", "tags": [ "stores" ], "parameters": [ { "name": "storeId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The store object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/storeResponse" } } } } } }, "patch": { "operationId": "PATCH/stores/storeId", "summary": "Update a store", "description": "Update a store", "tags": [ "stores" ], "parameters": [ { "name": "storeId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/storeUpdate" } } } }, "responses": { "200": { "description": "The updated store object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/storeResponse" } } } } } }, "delete": { "operationId": "DELETE/stores/storeId", "summary": "Delete a store", "description": "Delete a store", "tags": [ "stores" ], "parameters": [ { "name": "storeId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/stores/{storeId}/market": { "get": { "operationId": "GET/storeId/market", "summary": "Retrieve the market associated to the store", "description": "Retrieve the market associated to the store", "tags": [ "has_one", "markets" ], "parameters": [ { "name": "storeId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The market associated to the store" } } } }, "/stores/{storeId}/merchant": { "get": { "operationId": "GET/storeId/merchant", "summary": "Retrieve the merchant associated to the store", "description": "Retrieve the merchant associated to the store", "tags": [ "has_one", "merchants" ], "parameters": [ { "name": "storeId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The merchant associated to the store" } } } }, "/stores/{storeId}/stock_location": { "get": { "operationId": "GET/storeId/stock_location", "summary": "Retrieve the stock location associated to the store", "description": "Retrieve the stock location associated to the store", "tags": [ "has_one", "stock_locations" ], "parameters": [ { "name": "storeId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stock_location associated to the store" } } } }, "/stores/{storeId}/orders": { "get": { "operationId": "GET/storeId/orders", "summary": "Retrieve the orders associated to the store", "description": "Retrieve the orders associated to the store", "tags": [ "has_many", "orders" ], "parameters": [ { "name": "storeId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The orders associated to the store" } } } }, "/stores/{storeId}/payment_methods": { "get": { "operationId": "GET/storeId/payment_methods", "summary": "Retrieve the payment methods associated to the store", "description": "Retrieve the payment methods associated to the store", "tags": [ "has_many", "payment_methods" ], "parameters": [ { "name": "storeId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_methods associated to the store" } } } }, "/stores/{storeId}/events": { "get": { "operationId": "GET/storeId/events", "summary": "Retrieve the events associated to the store", "description": "Retrieve the events associated to the store", "tags": [ "has_many", "events" ], "parameters": [ { "name": "storeId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the store" } } } }, "/stores/{storeId}/event_stores": { "get": { "operationId": "GET/storeId/event_stores", "summary": "Retrieve the event stores associated to the store", "description": "Retrieve the event stores associated to the store", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "storeId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the store" } } } }, "/stripe_gateways": { "get": { "operationId": "GET/stripe_gateways", "summary": "List all stripe gateways", "description": "List all stripe gateways", "tags": [ "stripe_gateways" ], "responses": { "200": { "description": "A list of stripe gateway objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stripeGatewayResponseList" } } } } } }, "post": { "operationId": "POST/stripe_gateways", "summary": "Create a stripe gateway", "description": "Create a stripe gateway", "tags": [ "stripe_gateways" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stripeGatewayCreate" } } } }, "responses": { "201": { "description": "The created stripe gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stripeGatewayResponse" } } } } } } }, "/stripe_gateways/{stripeGatewayId}": { "get": { "operationId": "GET/stripe_gateways/stripeGatewayId", "summary": "Retrieve a stripe gateway", "description": "Retrieve a stripe gateway", "tags": [ "stripe_gateways" ], "parameters": [ { "name": "stripeGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stripe gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stripeGatewayResponse" } } } } } }, "patch": { "operationId": "PATCH/stripe_gateways/stripeGatewayId", "summary": "Update a stripe gateway", "description": "Update a stripe gateway", "tags": [ "stripe_gateways" ], "parameters": [ { "name": "stripeGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stripeGatewayUpdate" } } } }, "responses": { "200": { "description": "The updated stripe gateway object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stripeGatewayResponse" } } } } } }, "delete": { "operationId": "DELETE/stripe_gateways/stripeGatewayId", "summary": "Delete a stripe gateway", "description": "Delete a stripe gateway", "tags": [ "stripe_gateways" ], "parameters": [ { "name": "stripeGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/stripe_gateways/{stripeGatewayId}/payment_methods": { "get": { "operationId": "GET/stripeGatewayId/payment_methods", "summary": "Retrieve the payment methods associated to the stripe gateway", "description": "Retrieve the payment methods associated to the stripe gateway", "tags": [ "has_many", "payment_methods" ], "parameters": [ { "name": "stripeGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_methods associated to the stripe gateway" } } } }, "/stripe_gateways/{stripeGatewayId}/event_stores": { "get": { "operationId": "GET/stripeGatewayId/event_stores", "summary": "Retrieve the event stores associated to the stripe gateway", "description": "Retrieve the event stores associated to the stripe gateway", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "stripeGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the stripe gateway" } } } }, "/stripe_gateways/{stripeGatewayId}/stripe_payments": { "get": { "operationId": "GET/stripeGatewayId/stripe_payments", "summary": "Retrieve the stripe payments associated to the stripe gateway", "description": "Retrieve the stripe payments associated to the stripe gateway", "tags": [ "has_many", "stripe_payments" ], "parameters": [ { "name": "stripeGatewayId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stripe_payments associated to the stripe gateway" } } } }, "/stripe_payments": { "get": { "operationId": "GET/stripe_payments", "summary": "List all stripe payments", "description": "List all stripe payments", "tags": [ "stripe_payments" ], "responses": { "200": { "description": "A list of stripe payment objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stripePaymentResponseList" } } } } } }, "post": { "operationId": "POST/stripe_payments", "summary": "Create a stripe payment", "description": "Create a stripe payment", "tags": [ "stripe_payments" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stripePaymentCreate" } } } }, "responses": { "201": { "description": "The created stripe payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stripePaymentResponse" } } } } } } }, "/stripe_payments/{stripePaymentId}": { "get": { "operationId": "GET/stripe_payments/stripePaymentId", "summary": "Retrieve a stripe payment", "description": "Retrieve a stripe payment", "tags": [ "stripe_payments" ], "parameters": [ { "name": "stripePaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stripe payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stripePaymentResponse" } } } } } }, "patch": { "operationId": "PATCH/stripe_payments/stripePaymentId", "summary": "Update a stripe payment", "description": "Update a stripe payment", "tags": [ "stripe_payments" ], "parameters": [ { "name": "stripePaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stripePaymentUpdate" } } } }, "responses": { "200": { "description": "The updated stripe payment object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stripePaymentResponse" } } } } } }, "delete": { "operationId": "DELETE/stripe_payments/stripePaymentId", "summary": "Delete a stripe payment", "description": "Delete a stripe payment", "tags": [ "stripe_payments" ], "parameters": [ { "name": "stripePaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/stripe_payments/{stripePaymentId}/order": { "get": { "operationId": "GET/stripePaymentId/order", "summary": "Retrieve the order associated to the stripe payment", "description": "Retrieve the order associated to the stripe payment", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "stripePaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order associated to the stripe payment" } } } }, "/stripe_payments/{stripePaymentId}/payment_gateway": { "get": { "operationId": "GET/stripePaymentId/payment_gateway", "summary": "Retrieve the payment gateway associated to the stripe payment", "description": "Retrieve the payment gateway associated to the stripe payment", "tags": [ "has_one", "payment_gateways" ], "parameters": [ { "name": "stripePaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The payment_gateway associated to the stripe payment" } } } }, "/stripe_payments/{stripePaymentId}/event_stores": { "get": { "operationId": "GET/stripePaymentId/event_stores", "summary": "Retrieve the event stores associated to the stripe payment", "description": "Retrieve the event stores associated to the stripe payment", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "stripePaymentId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the stripe payment" } } } }, "/stripe_tax_accounts": { "get": { "operationId": "GET/stripe_tax_accounts", "summary": "List all stripe tax accounts", "description": "List all stripe tax accounts", "tags": [ "stripe_tax_accounts" ], "responses": { "200": { "description": "A list of stripe tax account objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stripeTaxAccountResponseList" } } } } } }, "post": { "operationId": "POST/stripe_tax_accounts", "summary": "Create a stripe tax account", "description": "Create a stripe tax account", "tags": [ "stripe_tax_accounts" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stripeTaxAccountCreate" } } } }, "responses": { "201": { "description": "The created stripe tax account object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stripeTaxAccountResponse" } } } } } } }, "/stripe_tax_accounts/{stripeTaxAccountId}": { "get": { "operationId": "GET/stripe_tax_accounts/stripeTaxAccountId", "summary": "Retrieve a stripe tax account", "description": "Retrieve a stripe tax account", "tags": [ "stripe_tax_accounts" ], "parameters": [ { "name": "stripeTaxAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The stripe tax account object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stripeTaxAccountResponse" } } } } } }, "patch": { "operationId": "PATCH/stripe_tax_accounts/stripeTaxAccountId", "summary": "Update a stripe tax account", "description": "Update a stripe tax account", "tags": [ "stripe_tax_accounts" ], "parameters": [ { "name": "stripeTaxAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stripeTaxAccountUpdate" } } } }, "responses": { "200": { "description": "The updated stripe tax account object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/stripeTaxAccountResponse" } } } } } }, "delete": { "operationId": "DELETE/stripe_tax_accounts/stripeTaxAccountId", "summary": "Delete a stripe tax account", "description": "Delete a stripe tax account", "tags": [ "stripe_tax_accounts" ], "parameters": [ { "name": "stripeTaxAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/stripe_tax_accounts/{stripeTaxAccountId}/markets": { "get": { "operationId": "GET/stripeTaxAccountId/markets", "summary": "Retrieve the markets associated to the stripe tax account", "description": "Retrieve the markets associated to the stripe tax account", "tags": [ "has_many", "markets" ], "parameters": [ { "name": "stripeTaxAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The markets associated to the stripe tax account" } } } }, "/stripe_tax_accounts/{stripeTaxAccountId}/attachments": { "get": { "operationId": "GET/stripeTaxAccountId/attachments", "summary": "Retrieve the attachments associated to the stripe tax account", "description": "Retrieve the attachments associated to the stripe tax account", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "stripeTaxAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the stripe tax account" } } } }, "/stripe_tax_accounts/{stripeTaxAccountId}/events": { "get": { "operationId": "GET/stripeTaxAccountId/events", "summary": "Retrieve the events associated to the stripe tax account", "description": "Retrieve the events associated to the stripe tax account", "tags": [ "has_many", "events" ], "parameters": [ { "name": "stripeTaxAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the stripe tax account" } } } }, "/stripe_tax_accounts/{stripeTaxAccountId}/event_stores": { "get": { "operationId": "GET/stripeTaxAccountId/event_stores", "summary": "Retrieve the event stores associated to the stripe tax account", "description": "Retrieve the event stores associated to the stripe tax account", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "stripeTaxAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the stripe tax account" } } } }, "/stripe_tax_accounts/{stripeTaxAccountId}/tax_categories": { "get": { "operationId": "GET/stripeTaxAccountId/tax_categories", "summary": "Retrieve the tax categories associated to the stripe tax account", "description": "Retrieve the tax categories associated to the stripe tax account", "tags": [ "has_many", "tax_categories" ], "parameters": [ { "name": "stripeTaxAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tax_categories associated to the stripe tax account" } } } }, "/subscription_models": { "get": { "operationId": "GET/subscription_models", "summary": "List all subscription models", "description": "List all subscription models", "tags": [ "subscription_models" ], "responses": { "200": { "description": "A list of subscription model objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/subscriptionModelResponseList" } } } } } }, "post": { "operationId": "POST/subscription_models", "summary": "Create a subscription model", "description": "Create a subscription model", "tags": [ "subscription_models" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/subscriptionModelCreate" } } } }, "responses": { "201": { "description": "The created subscription model object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/subscriptionModelResponse" } } } } } } }, "/subscription_models/{subscriptionModelId}": { "get": { "operationId": "GET/subscription_models/subscriptionModelId", "summary": "Retrieve a subscription model", "description": "Retrieve a subscription model", "tags": [ "subscription_models" ], "parameters": [ { "name": "subscriptionModelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The subscription model object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/subscriptionModelResponse" } } } } } }, "patch": { "operationId": "PATCH/subscription_models/subscriptionModelId", "summary": "Update a subscription model", "description": "Update a subscription model", "tags": [ "subscription_models" ], "parameters": [ { "name": "subscriptionModelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/subscriptionModelUpdate" } } } }, "responses": { "200": { "description": "The updated subscription model object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/subscriptionModelResponse" } } } } } }, "delete": { "operationId": "DELETE/subscription_models/subscriptionModelId", "summary": "Delete a subscription model", "description": "Delete a subscription model", "tags": [ "subscription_models" ], "parameters": [ { "name": "subscriptionModelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/subscription_models/{subscriptionModelId}/markets": { "get": { "operationId": "GET/subscriptionModelId/markets", "summary": "Retrieve the markets associated to the subscription model", "description": "Retrieve the markets associated to the subscription model", "tags": [ "has_many", "markets" ], "parameters": [ { "name": "subscriptionModelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The markets associated to the subscription model" } } } }, "/subscription_models/{subscriptionModelId}/order_subscriptions": { "get": { "operationId": "GET/subscriptionModelId/order_subscriptions", "summary": "Retrieve the order subscriptions associated to the subscription model", "description": "Retrieve the order subscriptions associated to the subscription model", "tags": [ "has_many", "order_subscriptions" ], "parameters": [ { "name": "subscriptionModelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order_subscriptions associated to the subscription model" } } } }, "/subscription_models/{subscriptionModelId}/attachments": { "get": { "operationId": "GET/subscriptionModelId/attachments", "summary": "Retrieve the attachments associated to the subscription model", "description": "Retrieve the attachments associated to the subscription model", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "subscriptionModelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the subscription model" } } } }, "/subscription_models/{subscriptionModelId}/event_stores": { "get": { "operationId": "GET/subscriptionModelId/event_stores", "summary": "Retrieve the event stores associated to the subscription model", "description": "Retrieve the event stores associated to the subscription model", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "subscriptionModelId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the subscription model" } } } }, "/tags": { "get": { "operationId": "GET/tags", "summary": "List all tags", "description": "List all tags", "tags": [ "tags" ], "responses": { "200": { "description": "A list of tag objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/tagResponseList" } } } } } }, "post": { "operationId": "POST/tags", "summary": "Create a tag", "description": "Create a tag", "tags": [ "tags" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/tagCreate" } } } }, "responses": { "201": { "description": "The created tag object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/tagResponse" } } } } } } }, "/tags/{tagId}": { "get": { "operationId": "GET/tags/tagId", "summary": "Retrieve a tag", "description": "Retrieve a tag", "tags": [ "tags" ], "parameters": [ { "name": "tagId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tag object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/tagResponse" } } } } } }, "patch": { "operationId": "PATCH/tags/tagId", "summary": "Update a tag", "description": "Update a tag", "tags": [ "tags" ], "parameters": [ { "name": "tagId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/tagUpdate" } } } }, "responses": { "200": { "description": "The updated tag object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/tagResponse" } } } } } }, "delete": { "operationId": "DELETE/tags/tagId", "summary": "Delete a tag", "description": "Delete a tag", "tags": [ "tags" ], "parameters": [ { "name": "tagId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/tags/{tagId}/event_stores": { "get": { "operationId": "GET/tagId/event_stores", "summary": "Retrieve the event stores associated to the tag", "description": "Retrieve the event stores associated to the tag", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "tagId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the tag" } } } }, "/talon_one_accounts": { "get": { "operationId": "GET/talon_one_accounts", "summary": "List all talon one accounts", "description": "List all talon one accounts", "tags": [ "talon_one_accounts" ], "responses": { "200": { "description": "A list of talon one account objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/talonOneAccountResponseList" } } } } } }, "post": { "operationId": "POST/talon_one_accounts", "summary": "Create a talon one account", "description": "Create a talon one account", "tags": [ "talon_one_accounts" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/talonOneAccountCreate" } } } }, "responses": { "201": { "description": "The created talon one account object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/talonOneAccountResponse" } } } } } } }, "/talon_one_accounts/{talonOneAccountId}": { "get": { "operationId": "GET/talon_one_accounts/talonOneAccountId", "summary": "Retrieve a talon one account", "description": "Retrieve a talon one account", "tags": [ "talon_one_accounts" ], "parameters": [ { "name": "talonOneAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The talon one account object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/talonOneAccountResponse" } } } } } }, "patch": { "operationId": "PATCH/talon_one_accounts/talonOneAccountId", "summary": "Update a talon one account", "description": "Update a talon one account", "tags": [ "talon_one_accounts" ], "parameters": [ { "name": "talonOneAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/talonOneAccountUpdate" } } } }, "responses": { "200": { "description": "The updated talon one account object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/talonOneAccountResponse" } } } } } }, "delete": { "operationId": "DELETE/talon_one_accounts/talonOneAccountId", "summary": "Delete a talon one account", "description": "Delete a talon one account", "tags": [ "talon_one_accounts" ], "parameters": [ { "name": "talonOneAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/talon_one_accounts/{talonOneAccountId}/markets": { "get": { "operationId": "GET/talonOneAccountId/markets", "summary": "Retrieve the markets associated to the talon one account", "description": "Retrieve the markets associated to the talon one account", "tags": [ "has_many", "markets" ], "parameters": [ { "name": "talonOneAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The markets associated to the talon one account" } } } }, "/talon_one_accounts/{talonOneAccountId}/discount_engine_items": { "get": { "operationId": "GET/talonOneAccountId/discount_engine_items", "summary": "Retrieve the discount engine items associated to the talon one account", "description": "Retrieve the discount engine items associated to the talon one account", "tags": [ "has_many", "discount_engine_items" ], "parameters": [ { "name": "talonOneAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The discount_engine_items associated to the talon one account" } } } }, "/talon_one_accounts/{talonOneAccountId}/attachments": { "get": { "operationId": "GET/talonOneAccountId/attachments", "summary": "Retrieve the attachments associated to the talon one account", "description": "Retrieve the attachments associated to the talon one account", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "talonOneAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the talon one account" } } } }, "/talon_one_accounts/{talonOneAccountId}/event_stores": { "get": { "operationId": "GET/talonOneAccountId/event_stores", "summary": "Retrieve the event stores associated to the talon one account", "description": "Retrieve the event stores associated to the talon one account", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "talonOneAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the talon one account" } } } }, "/tax_calculators": { "get": { "operationId": "GET/tax_calculators", "summary": "List all tax calculators", "description": "List all tax calculators", "tags": [ "tax_calculators" ], "responses": { "200": { "description": "A list of tax calculator objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/taxCalculatorResponseList" } } } } } } }, "/tax_calculators/{taxCalculatorId}": { "get": { "operationId": "GET/tax_calculators/taxCalculatorId", "summary": "Retrieve a tax calculator", "description": "Retrieve a tax calculator", "tags": [ "tax_calculators" ], "parameters": [ { "name": "taxCalculatorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tax calculator object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/taxCalculatorResponse" } } } } } } }, "/tax_calculators/{taxCalculatorId}/markets": { "get": { "operationId": "GET/taxCalculatorId/markets", "summary": "Retrieve the markets associated to the tax calculator", "description": "Retrieve the markets associated to the tax calculator", "tags": [ "has_many", "markets" ], "parameters": [ { "name": "taxCalculatorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The markets associated to the tax calculator" } } } }, "/tax_calculators/{taxCalculatorId}/attachments": { "get": { "operationId": "GET/taxCalculatorId/attachments", "summary": "Retrieve the attachments associated to the tax calculator", "description": "Retrieve the attachments associated to the tax calculator", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "taxCalculatorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the tax calculator" } } } }, "/tax_calculators/{taxCalculatorId}/events": { "get": { "operationId": "GET/taxCalculatorId/events", "summary": "Retrieve the events associated to the tax calculator", "description": "Retrieve the events associated to the tax calculator", "tags": [ "has_many", "events" ], "parameters": [ { "name": "taxCalculatorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the tax calculator" } } } }, "/tax_calculators/{taxCalculatorId}/event_stores": { "get": { "operationId": "GET/taxCalculatorId/event_stores", "summary": "Retrieve the event stores associated to the tax calculator", "description": "Retrieve the event stores associated to the tax calculator", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "taxCalculatorId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the tax calculator" } } } }, "/tax_categories": { "get": { "operationId": "GET/tax_categories", "summary": "List all tax categories", "description": "List all tax categories", "tags": [ "tax_categories" ], "responses": { "200": { "description": "A list of tax category objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/taxCategoryResponseList" } } } } } }, "post": { "operationId": "POST/tax_categories", "summary": "Create a tax category", "description": "Create a tax category", "tags": [ "tax_categories" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/taxCategoryCreate" } } } }, "responses": { "201": { "description": "The created tax category object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/taxCategoryResponse" } } } } } } }, "/tax_categories/{taxCategoryId}": { "get": { "operationId": "GET/tax_categories/taxCategoryId", "summary": "Retrieve a tax category", "description": "Retrieve a tax category", "tags": [ "tax_categories" ], "parameters": [ { "name": "taxCategoryId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tax category object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/taxCategoryResponse" } } } } } }, "patch": { "operationId": "PATCH/tax_categories/taxCategoryId", "summary": "Update a tax category", "description": "Update a tax category", "tags": [ "tax_categories" ], "parameters": [ { "name": "taxCategoryId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/taxCategoryUpdate" } } } }, "responses": { "200": { "description": "The updated tax category object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/taxCategoryResponse" } } } } } }, "delete": { "operationId": "DELETE/tax_categories/taxCategoryId", "summary": "Delete a tax category", "description": "Delete a tax category", "tags": [ "tax_categories" ], "parameters": [ { "name": "taxCategoryId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/tax_categories/{taxCategoryId}/sku": { "get": { "operationId": "GET/taxCategoryId/sku", "summary": "Retrieve the sku associated to the tax category", "description": "Retrieve the sku associated to the tax category", "tags": [ "has_one", "skus" ], "parameters": [ { "name": "taxCategoryId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The sku associated to the tax category" } } } }, "/tax_categories/{taxCategoryId}/attachments": { "get": { "operationId": "GET/taxCategoryId/attachments", "summary": "Retrieve the attachments associated to the tax category", "description": "Retrieve the attachments associated to the tax category", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "taxCategoryId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the tax category" } } } }, "/tax_categories/{taxCategoryId}/event_stores": { "get": { "operationId": "GET/taxCategoryId/event_stores", "summary": "Retrieve the event stores associated to the tax category", "description": "Retrieve the event stores associated to the tax category", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "taxCategoryId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the tax category" } } } }, "/tax_rules": { "get": { "operationId": "GET/tax_rules", "summary": "List all tax rules", "description": "List all tax rules", "tags": [ "tax_rules" ], "responses": { "200": { "description": "A list of tax rule objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/taxRuleResponseList" } } } } } }, "post": { "operationId": "POST/tax_rules", "summary": "Create a tax rule", "description": "Create a tax rule", "tags": [ "tax_rules" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/taxRuleCreate" } } } }, "responses": { "201": { "description": "The created tax rule object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/taxRuleResponse" } } } } } } }, "/tax_rules/{taxRuleId}": { "get": { "operationId": "GET/tax_rules/taxRuleId", "summary": "Retrieve a tax rule", "description": "Retrieve a tax rule", "tags": [ "tax_rules" ], "parameters": [ { "name": "taxRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tax rule object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/taxRuleResponse" } } } } } }, "patch": { "operationId": "PATCH/tax_rules/taxRuleId", "summary": "Update a tax rule", "description": "Update a tax rule", "tags": [ "tax_rules" ], "parameters": [ { "name": "taxRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/taxRuleUpdate" } } } }, "responses": { "200": { "description": "The updated tax rule object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/taxRuleResponse" } } } } } }, "delete": { "operationId": "DELETE/tax_rules/taxRuleId", "summary": "Delete a tax rule", "description": "Delete a tax rule", "tags": [ "tax_rules" ], "parameters": [ { "name": "taxRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/tax_rules/{taxRuleId}/manual_tax_calculator": { "get": { "operationId": "GET/taxRuleId/manual_tax_calculator", "summary": "Retrieve the manual tax calculator associated to the tax rule", "description": "Retrieve the manual tax calculator associated to the tax rule", "tags": [ "has_one", "manual_tax_calculators" ], "parameters": [ { "name": "taxRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The manual_tax_calculator associated to the tax rule" } } } }, "/tax_rules/{taxRuleId}/event_stores": { "get": { "operationId": "GET/taxRuleId/event_stores", "summary": "Retrieve the event stores associated to the tax rule", "description": "Retrieve the event stores associated to the tax rule", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "taxRuleId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the tax rule" } } } }, "/taxjar_accounts": { "get": { "operationId": "GET/taxjar_accounts", "summary": "List all taxjar accounts", "description": "List all taxjar accounts", "tags": [ "taxjar_accounts" ], "responses": { "200": { "description": "A list of taxjar account objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/taxjarAccountResponseList" } } } } } }, "post": { "operationId": "POST/taxjar_accounts", "summary": "Create a taxjar account", "description": "Create a taxjar account", "tags": [ "taxjar_accounts" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/taxjarAccountCreate" } } } }, "responses": { "201": { "description": "The created taxjar account object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/taxjarAccountResponse" } } } } } } }, "/taxjar_accounts/{taxjarAccountId}": { "get": { "operationId": "GET/taxjar_accounts/taxjarAccountId", "summary": "Retrieve a taxjar account", "description": "Retrieve a taxjar account", "tags": [ "taxjar_accounts" ], "parameters": [ { "name": "taxjarAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The taxjar account object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/taxjarAccountResponse" } } } } } }, "patch": { "operationId": "PATCH/taxjar_accounts/taxjarAccountId", "summary": "Update a taxjar account", "description": "Update a taxjar account", "tags": [ "taxjar_accounts" ], "parameters": [ { "name": "taxjarAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/taxjarAccountUpdate" } } } }, "responses": { "200": { "description": "The updated taxjar account object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/taxjarAccountResponse" } } } } } }, "delete": { "operationId": "DELETE/taxjar_accounts/taxjarAccountId", "summary": "Delete a taxjar account", "description": "Delete a taxjar account", "tags": [ "taxjar_accounts" ], "parameters": [ { "name": "taxjarAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/taxjar_accounts/{taxjarAccountId}/markets": { "get": { "operationId": "GET/taxjarAccountId/markets", "summary": "Retrieve the markets associated to the taxjar account", "description": "Retrieve the markets associated to the taxjar account", "tags": [ "has_many", "markets" ], "parameters": [ { "name": "taxjarAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The markets associated to the taxjar account" } } } }, "/taxjar_accounts/{taxjarAccountId}/attachments": { "get": { "operationId": "GET/taxjarAccountId/attachments", "summary": "Retrieve the attachments associated to the taxjar account", "description": "Retrieve the attachments associated to the taxjar account", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "taxjarAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the taxjar account" } } } }, "/taxjar_accounts/{taxjarAccountId}/events": { "get": { "operationId": "GET/taxjarAccountId/events", "summary": "Retrieve the events associated to the taxjar account", "description": "Retrieve the events associated to the taxjar account", "tags": [ "has_many", "events" ], "parameters": [ { "name": "taxjarAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the taxjar account" } } } }, "/taxjar_accounts/{taxjarAccountId}/event_stores": { "get": { "operationId": "GET/taxjarAccountId/event_stores", "summary": "Retrieve the event stores associated to the taxjar account", "description": "Retrieve the event stores associated to the taxjar account", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "taxjarAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the taxjar account" } } } }, "/taxjar_accounts/{taxjarAccountId}/tax_categories": { "get": { "operationId": "GET/taxjarAccountId/tax_categories", "summary": "Retrieve the tax categories associated to the taxjar account", "description": "Retrieve the tax categories associated to the taxjar account", "tags": [ "has_many", "tax_categories" ], "parameters": [ { "name": "taxjarAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The tax_categories associated to the taxjar account" } } } }, "/transactions": { "get": { "operationId": "GET/transactions", "summary": "List all transactions", "description": "List all transactions", "tags": [ "transactions" ], "responses": { "200": { "description": "A list of transaction objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/transactionResponseList" } } } } } } }, "/transactions/{transactionId}": { "get": { "operationId": "GET/transactions/transactionId", "summary": "Retrieve a transaction", "description": "Retrieve a transaction", "tags": [ "transactions" ], "parameters": [ { "name": "transactionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The transaction object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/transactionResponse" } } } } } } }, "/transactions/{transactionId}/order": { "get": { "operationId": "GET/transactionId/order", "summary": "Retrieve the order associated to the transaction", "description": "Retrieve the order associated to the transaction", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "transactionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order associated to the transaction" } } } }, "/transactions/{transactionId}/attachments": { "get": { "operationId": "GET/transactionId/attachments", "summary": "Retrieve the attachments associated to the transaction", "description": "Retrieve the attachments associated to the transaction", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "transactionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the transaction" } } } }, "/transactions/{transactionId}/events": { "get": { "operationId": "GET/transactionId/events", "summary": "Retrieve the events associated to the transaction", "description": "Retrieve the events associated to the transaction", "tags": [ "has_many", "events" ], "parameters": [ { "name": "transactionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the transaction" } } } }, "/transactions/{transactionId}/event_stores": { "get": { "operationId": "GET/transactionId/event_stores", "summary": "Retrieve the event stores associated to the transaction", "description": "Retrieve the event stores associated to the transaction", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "transactionId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the transaction" } } } }, "/vertex_accounts": { "get": { "operationId": "GET/vertex_accounts", "summary": "List all vertex accounts", "description": "List all vertex accounts", "tags": [ "vertex_accounts" ], "responses": { "200": { "description": "A list of vertex account objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/vertexAccountResponseList" } } } } } }, "post": { "operationId": "POST/vertex_accounts", "summary": "Create a vertex account", "description": "Create a vertex account", "tags": [ "vertex_accounts" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/vertexAccountCreate" } } } }, "responses": { "201": { "description": "The created vertex account object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/vertexAccountResponse" } } } } } } }, "/vertex_accounts/{vertexAccountId}": { "get": { "operationId": "GET/vertex_accounts/vertexAccountId", "summary": "Retrieve a vertex account", "description": "Retrieve a vertex account", "tags": [ "vertex_accounts" ], "parameters": [ { "name": "vertexAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The vertex account object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/vertexAccountResponse" } } } } } }, "patch": { "operationId": "PATCH/vertex_accounts/vertexAccountId", "summary": "Update a vertex account", "description": "Update a vertex account", "tags": [ "vertex_accounts" ], "parameters": [ { "name": "vertexAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/vertexAccountUpdate" } } } }, "responses": { "200": { "description": "The updated vertex account object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/vertexAccountResponse" } } } } } }, "delete": { "operationId": "DELETE/vertex_accounts/vertexAccountId", "summary": "Delete a vertex account", "description": "Delete a vertex account", "tags": [ "vertex_accounts" ], "parameters": [ { "name": "vertexAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/vertex_accounts/{vertexAccountId}/markets": { "get": { "operationId": "GET/vertexAccountId/markets", "summary": "Retrieve the markets associated to the vertex account", "description": "Retrieve the markets associated to the vertex account", "tags": [ "has_many", "markets" ], "parameters": [ { "name": "vertexAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The markets associated to the vertex account" } } } }, "/vertex_accounts/{vertexAccountId}/attachments": { "get": { "operationId": "GET/vertexAccountId/attachments", "summary": "Retrieve the attachments associated to the vertex account", "description": "Retrieve the attachments associated to the vertex account", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "vertexAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the vertex account" } } } }, "/vertex_accounts/{vertexAccountId}/events": { "get": { "operationId": "GET/vertexAccountId/events", "summary": "Retrieve the events associated to the vertex account", "description": "Retrieve the events associated to the vertex account", "tags": [ "has_many", "events" ], "parameters": [ { "name": "vertexAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the vertex account" } } } }, "/vertex_accounts/{vertexAccountId}/event_stores": { "get": { "operationId": "GET/vertexAccountId/event_stores", "summary": "Retrieve the event stores associated to the vertex account", "description": "Retrieve the event stores associated to the vertex account", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "vertexAccountId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the vertex account" } } } }, "/voids": { "get": { "operationId": "GET/voids", "summary": "List all voids", "description": "List all voids", "tags": [ "voids" ], "responses": { "200": { "description": "A list of void objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/voidResponseList" } } } } } } }, "/voids/{voidId}": { "get": { "operationId": "GET/voids/voidId", "summary": "Retrieve a void", "description": "Retrieve a void", "tags": [ "voids" ], "parameters": [ { "name": "voidId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The void object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/voidResponse" } } } } } }, "patch": { "operationId": "PATCH/voids/voidId", "summary": "Update a void", "description": "Update a void", "tags": [ "voids" ], "parameters": [ { "name": "voidId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/voidUpdate" } } } }, "responses": { "200": { "description": "The updated void object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/voidResponse" } } } } } } }, "/voids/{voidId}/order": { "get": { "operationId": "GET/voidId/order", "summary": "Retrieve the order associated to the void", "description": "Retrieve the order associated to the void", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "voidId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order associated to the void" } } } }, "/voids/{voidId}/attachments": { "get": { "operationId": "GET/voidId/attachments", "summary": "Retrieve the attachments associated to the void", "description": "Retrieve the attachments associated to the void", "tags": [ "has_many", "attachments" ], "parameters": [ { "name": "voidId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The attachments associated to the void" } } } }, "/voids/{voidId}/events": { "get": { "operationId": "GET/voidId/events", "summary": "Retrieve the events associated to the void", "description": "Retrieve the events associated to the void", "tags": [ "has_many", "events" ], "parameters": [ { "name": "voidId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The events associated to the void" } } } }, "/voids/{voidId}/event_stores": { "get": { "operationId": "GET/voidId/event_stores", "summary": "Retrieve the event stores associated to the void", "description": "Retrieve the event stores associated to the void", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "voidId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the void" } } } }, "/voids/{voidId}/reference_authorization": { "get": { "operationId": "GET/voidId/reference_authorization", "summary": "Retrieve the reference authorization associated to the void", "description": "Retrieve the reference authorization associated to the void", "tags": [ "has_one", "authorizations" ], "parameters": [ { "name": "voidId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The reference_authorization associated to the void" } } } }, "/webhooks": { "get": { "operationId": "GET/webhooks", "summary": "List all webhooks", "description": "List all webhooks", "tags": [ "webhooks" ], "responses": { "200": { "description": "A list of webhook objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/webhookResponseList" } } } } } }, "post": { "operationId": "POST/webhooks", "summary": "Create a webhook", "description": "Create a webhook", "tags": [ "webhooks" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/webhookCreate" } } } }, "responses": { "201": { "description": "The created webhook object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/webhookResponse" } } } } } } }, "/webhooks/{webhookId}": { "get": { "operationId": "GET/webhooks/webhookId", "summary": "Retrieve a webhook", "description": "Retrieve a webhook", "tags": [ "webhooks" ], "parameters": [ { "name": "webhookId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The webhook object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/webhookResponse" } } } } } }, "patch": { "operationId": "PATCH/webhooks/webhookId", "summary": "Update a webhook", "description": "Update a webhook", "tags": [ "webhooks" ], "parameters": [ { "name": "webhookId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/webhookUpdate" } } } }, "responses": { "200": { "description": "The updated webhook object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/webhookResponse" } } } } } }, "delete": { "operationId": "DELETE/webhooks/webhookId", "summary": "Delete a webhook", "description": "Delete a webhook", "tags": [ "webhooks" ], "parameters": [ { "name": "webhookId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/webhooks/{webhookId}/last_event_callbacks": { "get": { "operationId": "GET/webhookId/last_event_callbacks", "summary": "Retrieve the last event callbacks associated to the webhook", "description": "Retrieve the last event callbacks associated to the webhook", "tags": [ "has_many", "event_callbacks" ], "parameters": [ { "name": "webhookId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The last_event_callbacks associated to the webhook" } } } }, "/webhooks/{webhookId}/event_stores": { "get": { "operationId": "GET/webhookId/event_stores", "summary": "Retrieve the event stores associated to the webhook", "description": "Retrieve the event stores associated to the webhook", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "webhookId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the webhook" } } } }, "/wire_transfers": { "get": { "operationId": "GET/wire_transfers", "summary": "List all wire transfers", "description": "List all wire transfers", "tags": [ "wire_transfers" ], "responses": { "200": { "description": "A list of wire transfer objects", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/wireTransferResponseList" } } } } } }, "post": { "operationId": "POST/wire_transfers", "summary": "Create a wire transfer", "description": "Create a wire transfer", "tags": [ "wire_transfers" ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/wireTransferCreate" } } } }, "responses": { "201": { "description": "The created wire transfer object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/wireTransferResponse" } } } } } } }, "/wire_transfers/{wireTransferId}": { "get": { "operationId": "GET/wire_transfers/wireTransferId", "summary": "Retrieve a wire transfer", "description": "Retrieve a wire transfer", "tags": [ "wire_transfers" ], "parameters": [ { "name": "wireTransferId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The wire transfer object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/wireTransferResponse" } } } } } }, "patch": { "operationId": "PATCH/wire_transfers/wireTransferId", "summary": "Update a wire transfer", "description": "Update a wire transfer", "tags": [ "wire_transfers" ], "parameters": [ { "name": "wireTransferId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "requestBody": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/wireTransferUpdate" } } } }, "responses": { "200": { "description": "The updated wire transfer object", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/wireTransferResponse" } } } } } }, "delete": { "operationId": "DELETE/wire_transfers/wireTransferId", "summary": "Delete a wire transfer", "description": "Delete a wire transfer", "tags": [ "wire_transfers" ], "parameters": [ { "name": "wireTransferId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "204": { "description": "No content" } } } }, "/wire_transfers/{wireTransferId}/order": { "get": { "operationId": "GET/wireTransferId/order", "summary": "Retrieve the order associated to the wire transfer", "description": "Retrieve the order associated to the wire transfer", "tags": [ "has_one", "orders" ], "parameters": [ { "name": "wireTransferId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The order associated to the wire transfer" } } } }, "/wire_transfers/{wireTransferId}/event_stores": { "get": { "operationId": "GET/wireTransferId/event_stores", "summary": "Retrieve the event stores associated to the wire transfer", "description": "Retrieve the event stores associated to the wire transfer", "tags": [ "has_many", "event_stores" ], "parameters": [ { "name": "wireTransferId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The resource's id" } ], "responses": { "200": { "description": "The event_stores associated to the wire transfer" } } } } }, "components": { "schemas": { "address": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "attributes": { "type": "object", "properties": { "business": { "type": "boolean", "description": "Indicates if it's a business or a personal address.", "example": false, "nullable": true }, "first_name": { "type": "string", "description": "Address first name (personal).", "example": "John", "nullable": true }, "last_name": { "type": "string", "description": "Address last name (personal).", "example": "Smith", "nullable": true }, "company": { "type": "string", "description": "Address company name (business).", "example": "The Red Brand Inc.", "nullable": true }, "full_name": { "type": "string", "description": "Company name (business) of first name and last name (personal).", "example": "John Smith", "nullable": true }, "line_1": { "type": "string", "description": "Address line 1, i.e. Street address, PO Box.", "example": "2883 Geraldine Lane", "nullable": false }, "line_2": { "type": "string", "description": "Address line 2, i.e. Apartment, Suite, Building.", "example": "Apt.23", "nullable": true }, "city": { "type": "string", "description": "Address city.", "example": "New York", "nullable": false }, "zip_code": { "type": "string", "description": "ZIP or postal code.", "example": "10013", "nullable": true }, "state_code": { "type": "string", "description": "State, province or region code.", "example": "NY", "nullable": true }, "country_code": { "type": "string", "description": "The international 2-letter country code as defined by the ISO 3166-1 standard.", "example": "US", "nullable": false }, "phone": { "type": "string", "description": "Phone number (including extension).", "example": "(212) 646-338-1228", "nullable": false }, "full_address": { "type": "string", "description": "Compact description of the address location, without the full name.", "example": "2883 Geraldine Lane Apt.23, 10013 New York NY (US) (212) 646-338-1228", "nullable": true }, "name": { "type": "string", "description": "Compact description of the address location, including the full name.", "example": "John Smith, 2883 Geraldine Lane Apt.23, 10013 New York NY (US) (212) 646-338-1228", "nullable": true }, "email": { "type": "string", "description": "Email address.", "example": "john@example.com", "nullable": true }, "notes": { "type": "string", "description": "A free notes attached to the address. When used as a shipping address, this can be useful to let the customers add specific delivery instructions.", "example": "Please ring the bell twice", "nullable": true }, "lat": { "type": "number", "description": "The address geocoded latitude. This is automatically generated when creating a shipping/billing address for an order and a valid geocoder is attached to the order's market.", "example": 40.6971494, "nullable": true }, "lng": { "type": "number", "description": "The address geocoded longitude. This is automatically generated when creating a shipping/billing address for an order and a valid geocoder is attached to the order's market.", "example": -74.2598672, "nullable": true }, "is_localized": { "type": "boolean", "description": "Indicates if the latitude and logitude are present, either geocoded or manually updated.", "example": true, "nullable": true }, "is_geocoded": { "type": "boolean", "description": "Indicates if the address has been successfully geocoded.", "example": true, "nullable": true }, "provider_name": { "type": "string", "description": "The geocoder provider name (either Google or Bing).", "example": "google", "nullable": true }, "map_url": { "type": "string", "description": "The map url of the geocoded address (if geocoded).", "example": "https://www.google.com/maps/search/?api=1&query=40.6971494,-74.2598672", "nullable": true }, "static_map_url": { "type": "string", "description": "The static map image url of the geocoded address (if geocoded).", "example": "https://maps.googleapis.com/maps/api/staticmap?center=40.6971494,-74.2598672&size=640x320&zoom=15", "nullable": true }, "billing_info": { "type": "string", "description": "Customer's billing information (i.e. VAT number, codice fiscale).", "example": "VAT ID IT02382940977", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "geocoder": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "geocoders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "addressCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "attributes": { "type": "object", "properties": { "business": { "type": "boolean", "description": "Indicates if it's a business or a personal address.", "example": false }, "first_name": { "type": "string", "description": "Address first name (personal).", "example": "John" }, "last_name": { "type": "string", "description": "Address last name (personal).", "example": "Smith" }, "company": { "type": "string", "description": "Address company name (business).", "example": "The Red Brand Inc." }, "line_1": { "type": "string", "description": "Address line 1, i.e. Street address, PO Box.", "example": "2883 Geraldine Lane" }, "line_2": { "type": "string", "description": "Address line 2, i.e. Apartment, Suite, Building.", "example": "Apt.23" }, "city": { "type": "string", "description": "Address city.", "example": "New York" }, "zip_code": { "type": "string", "description": "ZIP or postal code.", "example": "10013" }, "state_code": { "type": "string", "description": "State, province or region code.", "example": "NY" }, "country_code": { "type": "string", "description": "The international 2-letter country code as defined by the ISO 3166-1 standard.", "example": "US" }, "phone": { "type": "string", "description": "Phone number (including extension).", "example": "(212) 646-338-1228" }, "email": { "type": "string", "description": "Email address.", "example": "john@example.com" }, "notes": { "type": "string", "description": "A free notes attached to the address. When used as a shipping address, this can be useful to let the customers add specific delivery instructions.", "example": "Please ring the bell twice" }, "lat": { "type": "number", "description": "The address geocoded latitude. This is automatically generated when creating a shipping/billing address for an order and a valid geocoder is attached to the order's market.", "example": 40.6971494 }, "lng": { "type": "number", "description": "The address geocoded longitude. This is automatically generated when creating a shipping/billing address for an order and a valid geocoder is attached to the order's market.", "example": -74.2598672 }, "billing_info": { "type": "string", "description": "Customer's billing information (i.e. VAT number, codice fiscale).", "example": "VAT ID IT02382940977" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "line_1", "city", "country_code", "phone" ] }, "relationships": { "type": "object", "properties": { "geocoder": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "geocoders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "addressUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "business": { "type": "boolean", "description": "Indicates if it's a business or a personal address.", "example": false, "nullable": false }, "first_name": { "type": "string", "description": "Address first name (personal).", "example": "John", "nullable": true }, "last_name": { "type": "string", "description": "Address last name (personal).", "example": "Smith", "nullable": true }, "company": { "type": "string", "description": "Address company name (business).", "example": "The Red Brand Inc.", "nullable": true }, "line_1": { "type": "string", "description": "Address line 1, i.e. Street address, PO Box.", "example": "2883 Geraldine Lane", "nullable": false }, "line_2": { "type": "string", "description": "Address line 2, i.e. Apartment, Suite, Building.", "example": "Apt.23", "nullable": true }, "city": { "type": "string", "description": "Address city.", "example": "New York", "nullable": false }, "zip_code": { "type": "string", "description": "ZIP or postal code.", "example": "10013", "nullable": true }, "state_code": { "type": "string", "description": "State, province or region code.", "example": "NY", "nullable": true }, "country_code": { "type": "string", "description": "The international 2-letter country code as defined by the ISO 3166-1 standard.", "example": "US", "nullable": false }, "phone": { "type": "string", "description": "Phone number (including extension).", "example": "(212) 646-338-1228", "nullable": false }, "email": { "type": "string", "description": "Email address.", "example": "john@example.com", "nullable": true }, "notes": { "type": "string", "description": "A free notes attached to the address. When used as a shipping address, this can be useful to let the customers add specific delivery instructions.", "example": "Please ring the bell twice", "nullable": true }, "lat": { "type": "number", "description": "The address geocoded latitude. This is automatically generated when creating a shipping/billing address for an order and a valid geocoder is attached to the order's market.", "example": 40.6971494, "nullable": true }, "lng": { "type": "number", "description": "The address geocoded longitude. This is automatically generated when creating a shipping/billing address for an order and a valid geocoder is attached to the order's market.", "example": -74.2598672, "nullable": true }, "billing_info": { "type": "string", "description": "Customer's billing information (i.e. VAT number, codice fiscale).", "example": "VAT ID IT02382940977", "nullable": true }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "geocoder": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "geocoders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "addressResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/address/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "geocoder": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "geocoder" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "addressResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/addressResponse/properties/data" } } } }, "adjustment": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adjustments" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The adjustment name.", "example": "Additional service", "nullable": false }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": false }, "amount_cents": { "type": "integer", "description": "The adjustment amount, in cents.", "example": 1500, "nullable": false }, "amount_float": { "type": "number", "description": "The adjustment amount, float.", "example": 15.0, "nullable": false }, "formatted_amount": { "type": "string", "description": "The adjustment amount, formatted.", "example": "€15,00", "nullable": false }, "distribute_discount": { "type": "boolean", "description": "Indicates if negative adjustment amount is distributed for tax calculation.", "example": true, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "adjustmentCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adjustments" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The adjustment name.", "example": "Additional service" }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR" }, "amount_cents": { "type": "integer", "description": "The adjustment amount, in cents.", "example": 1500 }, "distribute_discount": { "type": "boolean", "description": "Indicates if negative adjustment amount is distributed for tax calculation.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name", "currency_code", "amount_cents" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "adjustmentUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adjustments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The adjustment name.", "example": "Additional service", "nullable": false }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": false }, "amount_cents": { "type": "integer", "description": "The adjustment amount, in cents.", "example": 1500, "nullable": false }, "distribute_discount": { "type": "boolean", "description": "Indicates if negative adjustment amount is distributed for tax calculation.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "adjustmentResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "adjustments" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/adjustment/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "adjustmentResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/adjustmentResponse/properties/data" } } } }, "adyenGateway": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_gateways" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway", "nullable": false }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true, "nullable": true }, "credential_keys": { "type": "object", "description": "The payment gateway's API credential keys last digits.", "example": { "api_key": "********BW989" }, "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "live_url_prefix": { "type": "string", "description": "The prefix of the endpoint used for live transactions.", "example": "1797a841fbb37ca7-AdyenDemo", "nullable": false }, "api_version": { "type": "integer", "description": "The checkout API version, supported range is from 66 to 71, default is 71.", "example": 71, "nullable": true }, "async_api": { "type": "boolean", "description": "Indicates if the gateway will leverage on the Adyen notification webhooks, using latest API version.", "example": true, "nullable": true }, "partial_payments": { "type": "boolean", "description": "Send this attribute if you want to enable partial payments for the order.", "example": false, "nullable": true }, "order_expiration_mins": { "type": "integer", "description": "The minutes after which the order created for partial payments automatically expires.", "example": 30, "nullable": true }, "native_customer_payment_sources": { "type": "boolean", "description": "Indicates if the gateway will use the native customer payment sources.", "example": true, "nullable": true }, "webhook_endpoint_secret": { "type": "string", "description": "The gateway webhook endpoint secret, generated by Adyen customer area.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "webhook_endpoint_url": { "type": "string", "description": "The gateway webhook URL, generated automatically.", "example": "https://core.commercelayer.co/webhook_callbacks/adyen_gateways/xxxxx", "nullable": true } } }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "adyen_payments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "adyenGatewayCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_gateways" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway" }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "_check": { "type": "boolean", "description": "Send this attribute if you want to check the credentials against the payment gateway's APIs.", "example": true }, "merchant_account": { "type": "string", "description": "The gateway merchant account.", "example": "xxxx-yyyy-zzzz" }, "api_key": { "type": "string", "description": "The gateway API key.", "example": "xxxx-yyyy-zzzz" }, "public_key": { "type": "string", "description": "The public key linked to your API credential.", "example": "xxxx-yyyy-zzzz" }, "live_url_prefix": { "type": "string", "description": "The prefix of the endpoint used for live transactions.", "example": "1797a841fbb37ca7-AdyenDemo" }, "api_version": { "type": "integer", "description": "The checkout API version, supported range is from 66 to 71, default is 71.", "example": 71 }, "async_api": { "type": "boolean", "description": "Indicates if the gateway will leverage on the Adyen notification webhooks, using latest API version.", "example": true }, "partial_payments": { "type": "boolean", "description": "Send this attribute if you want to enable partial payments for the order.", "example": false }, "order_expiration_mins": { "type": "integer", "description": "The minutes after which the order created for partial payments automatically expires.", "example": 30 }, "native_customer_payment_sources": { "type": "boolean", "description": "Indicates if the gateway will use the native customer payment sources.", "example": true }, "webhook_endpoint_secret": { "type": "string", "description": "The gateway webhook endpoint secret, generated by Adyen customer area.", "example": "xxxx-yyyy-zzzz" } }, "required": [ "name", "merchant_account", "api_key", "live_url_prefix" ] }, "relationships": { "type": "object", "properties": { "adyen_payments": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "adyenGatewayUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway", "nullable": false }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true, "nullable": false }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "_check": { "type": "boolean", "description": "Send this attribute if you want to check the credentials against the payment gateway's APIs.", "example": true, "nullable": false }, "merchant_account": { "type": "string", "description": "The gateway merchant account.", "example": "xxxx-yyyy-zzzz" }, "api_key": { "type": "string", "description": "The gateway API key.", "example": "xxxx-yyyy-zzzz" }, "public_key": { "type": "string", "description": "The public key linked to your API credential.", "example": "xxxx-yyyy-zzzz" }, "live_url_prefix": { "type": "string", "description": "The prefix of the endpoint used for live transactions.", "example": "1797a841fbb37ca7-AdyenDemo", "nullable": false }, "api_version": { "type": "integer", "description": "The checkout API version, supported range is from 66 to 71, default is 71.", "example": 71, "nullable": true }, "async_api": { "type": "boolean", "description": "Indicates if the gateway will leverage on the Adyen notification webhooks, using latest API version.", "example": true, "nullable": false }, "partial_payments": { "type": "boolean", "description": "Send this attribute if you want to enable partial payments for the order.", "example": false, "nullable": false }, "order_expiration_mins": { "type": "integer", "description": "The minutes after which the order created for partial payments automatically expires.", "example": 30, "nullable": true }, "native_customer_payment_sources": { "type": "boolean", "description": "Indicates if the gateway will use the native customer payment sources.", "example": true, "nullable": false }, "webhook_endpoint_secret": { "type": "string", "description": "The gateway webhook endpoint secret, generated by Adyen customer area.", "example": "xxxx-yyyy-zzzz", "nullable": true } } }, "relationships": { "type": "object", "properties": { "adyen_payments": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "adyenGatewayResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_gateways" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/adyenGateway/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "adyen_payments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_payments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "adyenGatewayResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/adyenGatewayResponse/properties/data" } } } }, "adyenPayment": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_payments" ] }, "attributes": { "type": "object", "properties": { "public_key": { "type": "string", "description": "The public key linked to your API credential.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "payment_methods": { "type": "object", "description": "The merchant available payment methods for the assoiated order (i.e. country and amount). Required by the Adyen JS SDK.", "example": { "foo": "bar" }, "nullable": false }, "payment_request_data": { "type": "object", "description": "The Adyen payment request data, collected by client.", "example": { "foo": "bar" }, "nullable": true }, "payment_request_details": { "type": "object", "description": "The Adyen additional details request data, collected by client.", "example": { "foo": "bar" }, "nullable": true }, "payment_response": { "type": "object", "description": "The Adyen payment response, used by client (includes 'resultCode' and 'action').", "example": { "foo": "bar" }, "nullable": true }, "mismatched_amounts": { "type": "boolean", "description": "Indicates if the order current amount differs form the one of the associated authorization.", "example": false, "nullable": true }, "balance": { "type": "integer", "description": "The balance remaining on a shopper's gift card, must be computed by using its related trigger attribute.", "example": 1000, "nullable": true }, "expires_at": { "type": "string", "description": "The expiration date/time of this Adyen payment (valid for partial payments only).", "example": "2018-01-02T12:00:00.000Z", "nullable": true }, "payment_instrument": { "type": "object", "description": "Information about the payment instrument used in the transaction.", "example": { "issuer": "cl bank", "card_type": "visa" }, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_gateway": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "adyenPaymentCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_payments" ] }, "attributes": { "type": "object", "properties": { "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } } }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "order" ] } } } } }, "adyenPaymentUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "payment_request_data": { "type": "object", "description": "The Adyen payment request data, collected by client.", "example": { "foo": "bar" }, "nullable": true }, "payment_request_details": { "type": "object", "description": "The Adyen additional details request data, collected by client.", "example": { "foo": "bar" }, "nullable": true }, "_authorize": { "type": "boolean", "description": "Send this attribute if you want to authorize the payment.", "example": true, "nullable": false }, "_details": { "type": "boolean", "description": "Send this attribute if you want to send additional details the payment request.", "example": true, "nullable": false }, "_balance": { "type": "boolean", "description": "Send this attribute if you want retrieve the balance remaining on a shopper's gift card.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "adyenPaymentResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_payments" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/adyenPayment/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_gateway": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateway" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "adyenPaymentResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/adyenPaymentResponse/properties/data" } } } }, "application": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "application" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The application's internal name.", "example": "My app", "nullable": true }, "kind": { "type": "string", "description": "The application's kind. One of 'sales_channel', 'integration', or 'webapp'.", "example": "sales-channel", "nullable": true, "enum": [ "dashboard", "user", "contentful", "bundles", "customers", "datocms", "exports", "external", "generic", "gift_cards", "imports", "integration", "inventory", "metrics", "orders", "price_lists", "promotions", "resources", "returns", "sales_channel", "sanity", "shipments", "skus", "sku_lists", "stock_transfers", "subscriptions", "tags", "webapp", "webhooks", "zapier" ] }, "public_access": { "type": "boolean", "description": "Indicates if the application has public access.", "example": true, "nullable": true }, "redirect_uri": { "type": "string", "description": "The application's redirect URI.", "example": "https://bluebrand.com/img/logo.svg", "nullable": true }, "scopes": { "type": "string", "description": "The application's scopes.", "example": "market:all market:9 market:122 market:6 stock_location:6 stock_location:33", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "applicationResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "application" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/application/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { } } } } } }, "applicationResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/applicationResponse/properties/data" } } } }, "attachment": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The internal name of the attachment.", "example": "DDT transport document", "nullable": false }, "description": { "type": "string", "description": "An internal description of the attachment.", "example": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", "nullable": true }, "url": { "type": "string", "description": "The attachment URL.", "example": "https://s3.yourdomain.com/attachment.pdf", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "attachable": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "geocoders", "price_lists", "payment_methods", "markets", "customer_groups", "promotions", "orders", "transactions", "tax_calculators", "tax_categories", "skus", "shipping_categories", "bundles", "sku_lists", "stock_items", "stock_locations", "returns", "carrier_accounts", "coupon_recipients", "customers", "delivery_lead_times", "shipping_methods", "shipments", "discount_engines", "parcels", "gift_card_recipients", "gift_cards", "inventory_models", "stock_transfers", "sku_options", "merchants", "subscription_models", "payment_options", "packages", "prices", "price_tiers", "shipping_method_tiers", "shipping_zones" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/geocoder" }, { "$ref": "#/components/schemas/priceList" }, { "$ref": "#/components/schemas/paymentMethod" }, { "$ref": "#/components/schemas/market" }, { "$ref": "#/components/schemas/customerGroup" }, { "$ref": "#/components/schemas/promotion" }, { "$ref": "#/components/schemas/order" }, { "$ref": "#/components/schemas/transaction" }, { "$ref": "#/components/schemas/taxCalculator" }, { "$ref": "#/components/schemas/taxCategory" }, { "$ref": "#/components/schemas/sku" }, { "$ref": "#/components/schemas/shippingCategory" }, { "$ref": "#/components/schemas/bundle" }, { "$ref": "#/components/schemas/skuList" }, { "$ref": "#/components/schemas/stockItem" }, { "$ref": "#/components/schemas/stockLocation" }, { "$ref": "#/components/schemas/return" }, { "$ref": "#/components/schemas/carrierAccount" }, { "$ref": "#/components/schemas/couponRecipient" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deliveryLeadTime" }, { "$ref": "#/components/schemas/shippingMethod" }, { "$ref": "#/components/schemas/shipment" }, { "$ref": "#/components/schemas/discountEngine" }, { "$ref": "#/components/schemas/parcel" }, { "$ref": "#/components/schemas/giftCardRecipient" }, { "$ref": "#/components/schemas/giftCard" }, { "$ref": "#/components/schemas/inventoryModel" }, { "$ref": "#/components/schemas/stockTransfer" }, { "$ref": "#/components/schemas/skuOption" }, { "$ref": "#/components/schemas/merchant" }, { "$ref": "#/components/schemas/subscriptionModel" }, { "$ref": "#/components/schemas/paymentOption" }, { "$ref": "#/components/schemas/package" }, { "$ref": "#/components/schemas/price" }, { "$ref": "#/components/schemas/priceTier" }, { "$ref": "#/components/schemas/shippingMethodTier" }, { "$ref": "#/components/schemas/shippingZone" } ] }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "attachmentCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The internal name of the attachment.", "example": "DDT transport document" }, "description": { "type": "string", "description": "An internal description of the attachment.", "example": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." }, "url": { "type": "string", "description": "The attachment URL.", "example": "https://s3.yourdomain.com/attachment.pdf" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { "attachable": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "geocoders", "price_lists", "payment_methods", "markets", "customer_groups", "promotions", "orders", "transactions", "tax_calculators", "tax_categories", "skus", "shipping_categories", "bundles", "sku_lists", "stock_items", "stock_locations", "returns", "carrier_accounts", "coupon_recipients", "customers", "delivery_lead_times", "shipping_methods", "shipments", "discount_engines", "parcels", "gift_card_recipients", "gift_cards", "inventory_models", "stock_transfers", "sku_options", "merchants", "subscription_models", "payment_options", "packages", "prices", "price_tiers", "shipping_method_tiers", "shipping_zones" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/geocoder" }, { "$ref": "#/components/schemas/priceList" }, { "$ref": "#/components/schemas/paymentMethod" }, { "$ref": "#/components/schemas/market" }, { "$ref": "#/components/schemas/customerGroup" }, { "$ref": "#/components/schemas/promotion" }, { "$ref": "#/components/schemas/order" }, { "$ref": "#/components/schemas/transaction" }, { "$ref": "#/components/schemas/taxCalculator" }, { "$ref": "#/components/schemas/taxCategory" }, { "$ref": "#/components/schemas/sku" }, { "$ref": "#/components/schemas/shippingCategory" }, { "$ref": "#/components/schemas/bundle" }, { "$ref": "#/components/schemas/skuList" }, { "$ref": "#/components/schemas/stockItem" }, { "$ref": "#/components/schemas/stockLocation" }, { "$ref": "#/components/schemas/return" }, { "$ref": "#/components/schemas/carrierAccount" }, { "$ref": "#/components/schemas/couponRecipient" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deliveryLeadTime" }, { "$ref": "#/components/schemas/shippingMethod" }, { "$ref": "#/components/schemas/shipment" }, { "$ref": "#/components/schemas/discountEngine" }, { "$ref": "#/components/schemas/parcel" }, { "$ref": "#/components/schemas/giftCardRecipient" }, { "$ref": "#/components/schemas/giftCard" }, { "$ref": "#/components/schemas/inventoryModel" }, { "$ref": "#/components/schemas/stockTransfer" }, { "$ref": "#/components/schemas/skuOption" }, { "$ref": "#/components/schemas/merchant" }, { "$ref": "#/components/schemas/subscriptionModel" }, { "$ref": "#/components/schemas/paymentOption" }, { "$ref": "#/components/schemas/package" }, { "$ref": "#/components/schemas/price" }, { "$ref": "#/components/schemas/priceTier" }, { "$ref": "#/components/schemas/shippingMethodTier" }, { "$ref": "#/components/schemas/shippingZone" } ] } }, "required": [ "attachable" ] } } } } }, "attachmentUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The internal name of the attachment.", "example": "DDT transport document", "nullable": false }, "description": { "type": "string", "description": "An internal description of the attachment.", "example": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", "nullable": true }, "url": { "type": "string", "description": "The attachment URL.", "example": "https://s3.yourdomain.com/attachment.pdf", "nullable": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "attachable": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "geocoders", "price_lists", "payment_methods", "markets", "customer_groups", "promotions", "orders", "transactions", "tax_calculators", "tax_categories", "skus", "shipping_categories", "bundles", "sku_lists", "stock_items", "stock_locations", "returns", "carrier_accounts", "coupon_recipients", "customers", "delivery_lead_times", "shipping_methods", "shipments", "discount_engines", "parcels", "gift_card_recipients", "gift_cards", "inventory_models", "stock_transfers", "sku_options", "merchants", "subscription_models", "payment_options", "packages", "prices", "price_tiers", "shipping_method_tiers", "shipping_zones" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/geocoder" }, { "$ref": "#/components/schemas/priceList" }, { "$ref": "#/components/schemas/paymentMethod" }, { "$ref": "#/components/schemas/market" }, { "$ref": "#/components/schemas/customerGroup" }, { "$ref": "#/components/schemas/promotion" }, { "$ref": "#/components/schemas/order" }, { "$ref": "#/components/schemas/transaction" }, { "$ref": "#/components/schemas/taxCalculator" }, { "$ref": "#/components/schemas/taxCategory" }, { "$ref": "#/components/schemas/sku" }, { "$ref": "#/components/schemas/shippingCategory" }, { "$ref": "#/components/schemas/bundle" }, { "$ref": "#/components/schemas/skuList" }, { "$ref": "#/components/schemas/stockItem" }, { "$ref": "#/components/schemas/stockLocation" }, { "$ref": "#/components/schemas/return" }, { "$ref": "#/components/schemas/carrierAccount" }, { "$ref": "#/components/schemas/couponRecipient" }, { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deliveryLeadTime" }, { "$ref": "#/components/schemas/shippingMethod" }, { "$ref": "#/components/schemas/shipment" }, { "$ref": "#/components/schemas/discountEngine" }, { "$ref": "#/components/schemas/parcel" }, { "$ref": "#/components/schemas/giftCardRecipient" }, { "$ref": "#/components/schemas/giftCard" }, { "$ref": "#/components/schemas/inventoryModel" }, { "$ref": "#/components/schemas/stockTransfer" }, { "$ref": "#/components/schemas/skuOption" }, { "$ref": "#/components/schemas/merchant" }, { "$ref": "#/components/schemas/subscriptionModel" }, { "$ref": "#/components/schemas/paymentOption" }, { "$ref": "#/components/schemas/package" }, { "$ref": "#/components/schemas/price" }, { "$ref": "#/components/schemas/priceTier" }, { "$ref": "#/components/schemas/shippingMethodTier" }, { "$ref": "#/components/schemas/shippingZone" } ] } } } } } } }, "attachmentResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/attachment/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "attachable": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachable" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "attachmentResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/attachmentResponse/properties/data" } } } }, "authorization": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "authorizations" ] }, "attributes": { "type": "object", "properties": { "number": { "type": "string", "description": "The transaction number, auto generated.", "example": "42/T/001", "nullable": false }, "type": { "type": "string", "description": "The transaction's type.", "example": "authorizations", "nullable": false, "enum": [ "authorizations", "voids", "captures", "refunds" ] }, "payment_method_type": { "type": "string", "description": "Information about the payment method used in the transaction.", "example": "credit card", "nullable": true }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated order.", "example": "EUR", "nullable": false }, "amount_cents": { "type": "integer", "description": "The transaction amount, in cents.", "example": 1500, "nullable": false }, "amount_float": { "type": "number", "description": "The transaction amount, float.", "example": 15.0, "nullable": false }, "formatted_amount": { "type": "string", "description": "The transaction amount, formatted.", "example": "€15,00", "nullable": false }, "succeeded": { "type": "boolean", "description": "Indicates if the transaction is successful.", "example": false, "nullable": false }, "message": { "type": "string", "description": "The message returned by the payment gateway.", "example": "Accepted", "nullable": true }, "error_code": { "type": "string", "description": "The error code, if any, returned by the payment gateway.", "example": "00001", "nullable": true }, "error_detail": { "type": "string", "description": "The error detail, if any, returned by the payment gateway.", "example": "Already settled", "nullable": true }, "token": { "type": "string", "description": "The token identifying the transaction, returned by the payment gateway.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "gateway_transaction_id": { "type": "string", "description": "The ID identifying the transaction, returned by the payment gateway.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "cvv_code": { "type": "string", "description": "The CVV code returned by the payment gateway.", "example": "000", "nullable": true }, "cvv_message": { "type": "string", "description": "The CVV message returned by the payment gateway.", "example": "validated", "nullable": true }, "avs_code": { "type": "string", "description": "The AVS code returned by the payment gateway.", "example": "000", "nullable": true }, "avs_message": { "type": "string", "description": "The AVS message returned by the payment gateway.", "example": "validated", "nullable": true }, "fraud_review": { "type": "string", "description": "The fraud review message, if any, returned by the payment gateway.", "example": "passed", "nullable": true }, "capture_amount_cents": { "type": "integer", "description": "The amount to be captured, in cents.", "example": 500, "nullable": true }, "capture_amount_float": { "type": "number", "description": "The amount to be captured, float.", "example": 5.0, "nullable": true }, "formatted_capture_amount": { "type": "string", "description": "The amount to be captured, formatted.", "example": "€5,00", "nullable": true }, "capture_balance_cents": { "type": "integer", "description": "The balance to be captured, in cents.", "example": 1000, "nullable": true }, "capture_balance_float": { "type": "number", "description": "The balance to be captured, float.", "example": 10.0, "nullable": true }, "formatted_capture_balance": { "type": "string", "description": "The balance to be captured, formatted.", "example": "€10,00", "nullable": true }, "void_balance_cents": { "type": "integer", "description": "The balance to be voided, in cents.", "example": 1500, "nullable": true }, "void_balance_float": { "type": "number", "description": "The balance to be voided, float.", "example": 15.0, "nullable": true }, "formatted_void_balance": { "type": "string", "description": "The balance to be voided, formatted.", "example": "€15,00", "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_source": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_payments", "axerve_payments", "braintree_payments", "checkout_com_payments", "external_payments", "klarna_payments", "paypal_payments", "satispay_payments", "stripe_payments", "wire_transfers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/adyenPayment" }, { "$ref": "#/components/schemas/axervePayment" }, { "$ref": "#/components/schemas/braintreePayment" }, { "$ref": "#/components/schemas/checkoutComPayment" }, { "$ref": "#/components/schemas/externalPayment" }, { "$ref": "#/components/schemas/klarnaPayment" }, { "$ref": "#/components/schemas/paypalPayment" }, { "$ref": "#/components/schemas/satispayPayment" }, { "$ref": "#/components/schemas/stripePayment" }, { "$ref": "#/components/schemas/wireTransfer" } ] }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "captures": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "captures" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "voids": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "voids" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "authorizationUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "authorizations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "succeeded": { "type": "boolean", "description": "Indicates if the transaction is successful.", "example": false, "nullable": false }, "_forward": { "type": "boolean", "description": "Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "_capture": { "type": "boolean", "description": "Send this attribute if you want to create a capture for this authorization.", "example": true, "nullable": false }, "_capture_amount_cents": { "type": "integer", "description": "Send this attribute as a value in cents if you want to overwrite the amount to be captured.", "example": 500 }, "_void": { "type": "boolean", "description": "Send this attribute if you want to create a void for this authorization.", "example": true, "nullable": false }, "_cancel": { "type": "boolean", "description": "Send this attribute if you want to void a succeeded authorization of a pending order (which is left unpaid).", "example": true, "nullable": false } } }, "relationships": { "type": "object", "properties": { } } } } } }, "authorizationResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "authorizations" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/authorization/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_source": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_source" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "captures": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "captures" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "voids": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "voids" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "authorizationResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/authorizationResponse/properties/data" } } } }, "avalaraAccount": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "avalara_accounts" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax calculator's internal name.", "example": "Personal tax calculator", "nullable": false }, "type": { "type": "string", "description": "The tax calculator's type.", "example": "avalara_accounts", "nullable": false, "enum": [ "avalara_accounts", "stripe_tax_accounts", "vertex_accounts", "taxjar_accounts", "manual_tax_calculators", "external_tax_calculators" ] }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "username": { "type": "string", "description": "The Avalara account username.", "example": "user@mydomain.com", "nullable": false }, "company_code": { "type": "string", "description": "The Avalara company code.", "example": "MYCOMPANY", "nullable": false }, "commit_invoice": { "type": "boolean", "description": "Indicates if the transaction will be recorded and visible on the Avalara website.", "example": true, "nullable": true }, "ddp": { "type": "boolean", "description": "Indicates if the seller is responsible for paying/remitting the customs duty & import tax to the customs authorities.", "example": true, "nullable": true } } }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tax_categories": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_categories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "avalaraAccountCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "avalara_accounts" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax calculator's internal name.", "example": "Personal tax calculator" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "username": { "type": "string", "description": "The Avalara account username.", "example": "user@mydomain.com" }, "password": { "type": "string", "description": "The Avalara account password.", "example": "secret" }, "company_code": { "type": "string", "description": "The Avalara company code.", "example": "MYCOMPANY" }, "commit_invoice": { "type": "boolean", "description": "Indicates if the transaction will be recorded and visible on the Avalara website.", "example": true }, "ddp": { "type": "boolean", "description": "Indicates if the seller is responsible for paying/remitting the customs duty & import tax to the customs authorities.", "example": true } }, "required": [ "name", "username", "password", "company_code" ] }, "relationships": { "type": "object", "properties": { "tax_categories": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_categories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "avalaraAccountUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "avalara_accounts" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax calculator's internal name.", "example": "Personal tax calculator", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "username": { "type": "string", "description": "The Avalara account username.", "example": "user@mydomain.com", "nullable": false }, "password": { "type": "string", "description": "The Avalara account password.", "example": "secret" }, "company_code": { "type": "string", "description": "The Avalara company code.", "example": "MYCOMPANY", "nullable": false }, "commit_invoice": { "type": "boolean", "description": "Indicates if the transaction will be recorded and visible on the Avalara website.", "example": true, "nullable": false }, "ddp": { "type": "boolean", "description": "Indicates if the seller is responsible for paying/remitting the customs duty & import tax to the customs authorities.", "example": true, "nullable": false } } }, "relationships": { "type": "object", "properties": { "tax_categories": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_categories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "avalaraAccountResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "avalara_accounts" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/avalaraAccount/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tax_categories": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_categories" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "avalaraAccountResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/avalaraAccountResponse/properties/data" } } } }, "axerveGateway": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "axerve_gateways" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway", "nullable": false }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true, "nullable": true }, "credential_keys": { "type": "object", "description": "The payment gateway's API credential keys last digits.", "example": { "api_key": "********BW989" }, "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "login": { "type": "string", "description": "The merchant login code.", "example": "xxxx-yyyy-zzzz", "nullable": false }, "webhook_endpoint_url": { "type": "string", "description": "The gateway webhook URL, generated automatically.", "example": "https://core.commercelayer.co/webhook_callbacks/axerve_gateways/xxxxx", "nullable": true } } }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "axerve_payments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "axerve_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "axerveGatewayCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "axerve_gateways" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway" }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "login": { "type": "string", "description": "The merchant login code.", "example": "xxxx-yyyy-zzzz" }, "api_key": { "type": "string", "description": "The gateway API key.", "example": "xxxx-yyyy-zzzz" } }, "required": [ "name", "login", "api_key" ] }, "relationships": { "type": "object", "properties": { "axerve_payments": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "axerve_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "axerveGatewayUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "axerve_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway", "nullable": false }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true, "nullable": false }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "login": { "type": "string", "description": "The merchant login code.", "example": "xxxx-yyyy-zzzz", "nullable": false }, "api_key": { "type": "string", "description": "The gateway API key.", "example": "xxxx-yyyy-zzzz" } } }, "relationships": { "type": "object", "properties": { "axerve_payments": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "axerve_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "axerveGatewayResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "axerve_gateways" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/axerveGateway/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "axerve_payments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "axerve_payments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "axerveGatewayResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/axerveGatewayResponse/properties/data" } } } }, "axervePayment": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "axerve_payments" ] }, "attributes": { "type": "object", "properties": { "login": { "type": "string", "description": "The merchant login code.", "example": "xxxx-yyyy-zzzz", "nullable": false }, "return_url": { "type": "string", "description": "The URL where the payer is redirected after they approve the payment.", "example": "https://yourdomain.com/thankyou", "nullable": false }, "payment_request_data": { "type": "object", "description": "The Axerve payment request data, collected by client.", "example": { "foo": "bar" }, "nullable": true }, "client_ip": { "type": "string", "description": "The IP adress of the client creating the payment.", "example": "213.45.120.5", "nullable": true }, "buyer_details": { "type": "object", "description": "The details of the buyer creating the payment.", "example": { "cardHolder": { "email": "george.harrison@gmail.com" }, "shippingAddress": { "firstName": "George" } }, "nullable": true }, "request_token": { "type": "boolean", "description": "Requires the creation of a token to represent this payment, mandatory to use customer's wallet and order subscriptions.", "example": true, "nullable": true }, "mismatched_amounts": { "type": "boolean", "description": "Indicates if the order current amount differs form the one of the associated authorization.", "example": false, "nullable": true }, "payment_instrument": { "type": "object", "description": "Information about the payment instrument used in the transaction.", "example": { "issuer": "cl bank", "card_type": "visa" }, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_gateway": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "axervePaymentCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "axerve_payments" ] }, "attributes": { "type": "object", "properties": { "return_url": { "type": "string", "description": "The URL where the payer is redirected after they approve the payment.", "example": "https://yourdomain.com/thankyou" }, "client_ip": { "type": "string", "description": "The IP adress of the client creating the payment.", "example": "213.45.120.5" }, "buyer_details": { "type": "object", "description": "The details of the buyer creating the payment.", "example": { "cardHolder": { "email": "george.harrison@gmail.com" }, "shippingAddress": { "firstName": "George" } } }, "request_token": { "type": "boolean", "description": "Requires the creation of a token to represent this payment, mandatory to use customer's wallet and order subscriptions.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "return_url" ] }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "order" ] } } } } }, "axervePaymentUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "axerve_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "payment_request_data": { "type": "object", "description": "The Axerve payment request data, collected by client.", "example": { "foo": "bar" }, "nullable": true }, "_update": { "type": "boolean", "description": "Send this attribute if you want to update the payment with fresh order data.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "axervePaymentResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "axerve_payments" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/axervePayment/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_gateway": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateway" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "axervePaymentResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/axervePaymentResponse/properties/data" } } } }, "bingGeocoder": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "bing_geocoders" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The geocoder's internal name.", "example": "Default geocoder", "nullable": false }, "type": { "type": "string", "description": "The geocoder's type.", "example": "google_geocoders", "nullable": false, "enum": [ "google_geocoders", "bing_geocoders" ] }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "addresses": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "bingGeocoderCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "bing_geocoders" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The geocoder's internal name.", "example": "Default geocoder" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "key": { "type": "string", "description": "The Bing Virtualearth key.", "example": "xxxx-yyyy-zzzz" } }, "required": [ "name", "key" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "bingGeocoderUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "bing_geocoders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The geocoder's internal name.", "example": "Default geocoder", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "key": { "type": "string", "description": "The Bing Virtualearth key.", "example": "xxxx-yyyy-zzzz" } } }, "relationships": { "type": "object", "properties": { } } } } } }, "bingGeocoderResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "bing_geocoders" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/bingGeocoder/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "addresses": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "bingGeocoderResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/bingGeocoderResponse/properties/data" } } } }, "braintreeGateway": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "braintree_gateways" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway", "nullable": false }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true, "nullable": true }, "credential_keys": { "type": "object", "description": "The payment gateway's API credential keys last digits.", "example": { "api_key": "********BW989" }, "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "descriptor_name": { "type": "string", "description": "The dynamic descriptor name. Must be composed by business name (3, 7 or 12 chars), an asterisk (*) and the product name (18, 14 or 9 chars), for a total length of 22 chars.", "example": "company*productabc1234", "nullable": true }, "descriptor_phone": { "type": "string", "description": "The dynamic descriptor phone number. Must be 10-14 characters and can only contain numbers, dashes, parentheses and periods.", "example": "3125551212", "nullable": true }, "descriptor_url": { "type": "string", "description": "The dynamic descriptor URL.", "example": "company.com", "nullable": true }, "webhook_endpoint_url": { "type": "string", "description": "The gateway webhook URL, generated automatically.", "example": "https://core.commercelayer.co/webhook_callbacks/braintree_gateways/xxxxx", "nullable": true } } }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "braintree_payments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "braintree_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "braintreeGatewayCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "braintree_gateways" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway" }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "_check": { "type": "boolean", "description": "Send this attribute if you want to check the credentials against the payment gateway's APIs.", "example": true }, "merchant_account_id": { "type": "string", "description": "The gateway merchant account ID.", "example": "xxxx-yyyy-zzzz" }, "merchant_id": { "type": "string", "description": "The gateway merchant ID.", "example": "xxxx-yyyy-zzzz" }, "public_key": { "type": "string", "description": "The gateway API public key.", "example": "xxxx-yyyy-zzzz" }, "private_key": { "type": "string", "description": "The gateway API private key.", "example": "xxxx-yyyy-zzzz" }, "descriptor_name": { "type": "string", "description": "The dynamic descriptor name. Must be composed by business name (3, 7 or 12 chars), an asterisk (*) and the product name (18, 14 or 9 chars), for a total length of 22 chars.", "example": "company*productabc1234" }, "descriptor_phone": { "type": "string", "description": "The dynamic descriptor phone number. Must be 10-14 characters and can only contain numbers, dashes, parentheses and periods.", "example": "3125551212" }, "descriptor_url": { "type": "string", "description": "The dynamic descriptor URL.", "example": "company.com" } }, "required": [ "name", "merchant_account_id", "merchant_id", "public_key", "private_key" ] }, "relationships": { "type": "object", "properties": { "braintree_payments": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "braintree_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "braintreeGatewayUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "braintree_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway", "nullable": false }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true, "nullable": false }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "_check": { "type": "boolean", "description": "Send this attribute if you want to check the credentials against the payment gateway's APIs.", "example": true, "nullable": false }, "merchant_account_id": { "type": "string", "description": "The gateway merchant account ID.", "example": "xxxx-yyyy-zzzz" }, "merchant_id": { "type": "string", "description": "The gateway merchant ID.", "example": "xxxx-yyyy-zzzz" }, "public_key": { "type": "string", "description": "The gateway API public key.", "example": "xxxx-yyyy-zzzz" }, "private_key": { "type": "string", "description": "The gateway API private key.", "example": "xxxx-yyyy-zzzz" }, "descriptor_name": { "type": "string", "description": "The dynamic descriptor name. Must be composed by business name (3, 7 or 12 chars), an asterisk (*) and the product name (18, 14 or 9 chars), for a total length of 22 chars.", "example": "company*productabc1234", "nullable": true }, "descriptor_phone": { "type": "string", "description": "The dynamic descriptor phone number. Must be 10-14 characters and can only contain numbers, dashes, parentheses and periods.", "example": "3125551212", "nullable": true }, "descriptor_url": { "type": "string", "description": "The dynamic descriptor URL.", "example": "company.com", "nullable": true } } }, "relationships": { "type": "object", "properties": { "braintree_payments": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "braintree_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "braintreeGatewayResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "braintree_gateways" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/braintreeGateway/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "braintree_payments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "braintree_payments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "braintreeGatewayResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/braintreeGatewayResponse/properties/data" } } } }, "braintreePayment": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "braintree_payments" ] }, "attributes": { "type": "object", "properties": { "client_token": { "type": "string", "description": "The Braintree payment client token. Required by the Braintree JS SDK.", "example": "xxxx.yyyy.zzzz", "nullable": false }, "payment_method_nonce": { "type": "string", "description": "The Braintree payment method nonce. Sent by the Braintree JS SDK.", "example": "xxxx.yyyy.zzzz", "nullable": true }, "payment_id": { "type": "string", "description": "The Braintree payment ID used by local payment and sent by the Braintree JS SDK.", "example": "xxxx.yyyy.zzzz", "nullable": true }, "local": { "type": "boolean", "description": "Indicates if the payment is local, in such case Braintree will trigger a webhook call passing the \"payment_id\" and \"payment_method_nonce\" in order to complete the transaction.", "example": true, "nullable": true }, "options": { "type": "object", "description": "Braintree payment options, 'customer_id' and 'payment_method_token'.", "example": { "customer_id": "1234567890" }, "nullable": true }, "payment_instrument": { "type": "object", "description": "Information about the payment instrument used in the transaction.", "example": { "issuer": "cl bank", "card_type": "visa" }, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_gateway": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "braintreePaymentCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "braintree_payments" ] }, "attributes": { "type": "object", "properties": { "payment_id": { "type": "string", "description": "The Braintree payment ID used by local payment and sent by the Braintree JS SDK.", "example": "xxxx.yyyy.zzzz" }, "local": { "type": "boolean", "description": "Indicates if the payment is local, in such case Braintree will trigger a webhook call passing the \"payment_id\" and \"payment_method_nonce\" in order to complete the transaction.", "example": true }, "options": { "type": "object", "description": "Braintree payment options, 'customer_id' and 'payment_method_token'.", "example": { "customer_id": "1234567890" } }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } } }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "order" ] } } } } }, "braintreePaymentUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "braintree_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "payment_method_nonce": { "type": "string", "description": "The Braintree payment method nonce. Sent by the Braintree JS SDK.", "example": "xxxx.yyyy.zzzz", "nullable": true }, "payment_id": { "type": "string", "description": "The Braintree payment ID used by local payment and sent by the Braintree JS SDK.", "example": "xxxx.yyyy.zzzz", "nullable": true }, "local": { "type": "boolean", "description": "Indicates if the payment is local, in such case Braintree will trigger a webhook call passing the \"payment_id\" and \"payment_method_nonce\" in order to complete the transaction.", "example": true, "nullable": false }, "options": { "type": "object", "description": "Braintree payment options, 'customer_id' and 'payment_method_token'.", "example": { "customer_id": "1234567890" }, "nullable": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "braintreePaymentResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "braintree_payments" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/braintreePayment/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_gateway": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateway" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "braintreePaymentResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/braintreePaymentResponse/properties/data" } } } }, "bundle": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "bundles" ] }, "attributes": { "type": "object", "properties": { "code": { "type": "string", "description": "The bundle code, that uniquely identifies the bundle within the market.", "example": "BUNDMM000000FFFFFFXLXX", "nullable": false }, "name": { "type": "string", "description": "The internal name of the bundle.", "example": "Men's Black T-shirt (XL) with Black Cap and Socks, all with White Logo", "nullable": false }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "description": { "type": "string", "description": "An internal description of the bundle.", "example": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", "nullable": true }, "image_url": { "type": "string", "description": "The URL of an image that represents the bundle.", "example": "https://img.yourdomain.com/bundles/xYZkjABcde.png", "nullable": true }, "do_not_ship": { "type": "boolean", "description": "Indicates if the bundle doesn't generate shipments (all sku_list's SKUs must be do_not_ship).", "example": false, "nullable": true }, "do_not_track": { "type": "boolean", "description": "Indicates if the bundle doesn't track the stock inventory (all sku_list's SKUs must be do_not_track).", "example": false, "nullable": true }, "price_amount_cents": { "type": "integer", "description": "The bundle price amount for the associated market, in cents.", "example": 10000, "nullable": true }, "price_amount_float": { "type": "number", "description": "The bundle price amount for the associated market, float.", "example": 100.0, "nullable": true }, "formatted_price_amount": { "type": "string", "description": "The bundle price amount for the associated market, formatted.", "example": "€100,00", "nullable": true }, "compare_at_amount_cents": { "type": "integer", "description": "The compared price amount, in cents. Useful to display a percentage discount.", "example": 13000, "nullable": true }, "compare_at_amount_float": { "type": "number", "description": "The compared price amount, float.", "example": 130.0, "nullable": true }, "formatted_compare_at_amount": { "type": "string", "description": "The compared price amount, formatted.", "example": "€130,00", "nullable": true }, "skus_count": { "type": "integer", "description": "The total number of SKUs in the bundle.", "example": 2, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "skus": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "bundleCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "bundles" ] }, "attributes": { "type": "object", "properties": { "code": { "type": "string", "description": "The bundle code, that uniquely identifies the bundle within the market.", "example": "BUNDMM000000FFFFFFXLXX" }, "name": { "type": "string", "description": "The internal name of the bundle.", "example": "Men's Black T-shirt (XL) with Black Cap and Socks, all with White Logo" }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR" }, "description": { "type": "string", "description": "An internal description of the bundle.", "example": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." }, "image_url": { "type": "string", "description": "The URL of an image that represents the bundle.", "example": "https://img.yourdomain.com/bundles/xYZkjABcde.png" }, "price_amount_cents": { "type": "integer", "description": "The bundle price amount for the associated market, in cents.", "example": 10000 }, "compare_at_amount_cents": { "type": "integer", "description": "The compared price amount, in cents. Useful to display a percentage discount.", "example": 13000 }, "_compute_price_amount": { "type": "boolean", "description": "Send this attribute if you want to compute the price_amount_cents as the sum of the prices of the bundle SKUs for the market.", "example": true }, "_compute_compare_at_amount": { "type": "boolean", "description": "Send this attribute if you want to compute the compare_at_amount_cents as the sum of the prices of the bundle SKUs for the market.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "code", "name" ] }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "sku_list" ] } } } } }, "bundleUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "bundles" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "code": { "type": "string", "description": "The bundle code, that uniquely identifies the bundle within the market.", "example": "BUNDMM000000FFFFFFXLXX", "nullable": false }, "name": { "type": "string", "description": "The internal name of the bundle.", "example": "Men's Black T-shirt (XL) with Black Cap and Socks, all with White Logo", "nullable": false }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "description": { "type": "string", "description": "An internal description of the bundle.", "example": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", "nullable": true }, "image_url": { "type": "string", "description": "The URL of an image that represents the bundle.", "example": "https://img.yourdomain.com/bundles/xYZkjABcde.png", "nullable": true }, "price_amount_cents": { "type": "integer", "description": "The bundle price amount for the associated market, in cents.", "example": 10000, "nullable": true }, "compare_at_amount_cents": { "type": "integer", "description": "The compared price amount, in cents. Useful to display a percentage discount.", "example": 13000, "nullable": true }, "_compute_price_amount": { "type": "boolean", "description": "Send this attribute if you want to compute the price_amount_cents as the sum of the prices of the bundle SKUs for the market.", "example": true, "nullable": false }, "_compute_compare_at_amount": { "type": "boolean", "description": "Send this attribute if you want to compute the compare_at_amount_cents as the sum of the prices of the bundle SKUs for the market.", "example": true, "nullable": false }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "bundleResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "bundles" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/bundle/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "market" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_list": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "skus": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "bundleResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/bundleResponse/properties/data" } } } }, "buyXPayYPromotion": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "buy_x_pay_y_promotions" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion", "nullable": false }, "type": { "type": "string", "description": "The promotion's type.", "example": "percentage_discount_promotions", "nullable": false, "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true, "nullable": true }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2, "nullable": true }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": false }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5, "nullable": true }, "total_usage_count": { "type": "integer", "description": "The number of times this promotion has been applied.", "example": 2, "nullable": true }, "total_usage_reached": { "type": "boolean", "description": "Indicates if the promotion has been applied the total number of allowed times.", "example": false, "nullable": true }, "active": { "type": "boolean", "description": "Indicates if the promotion is active (enabled and not expired).", "example": true, "nullable": true }, "status": { "type": "string", "description": "The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.", "example": "pending", "nullable": true, "enum": [ "disabled", "expired", "pending", "active", "inactive" ] }, "weight": { "type": "integer", "description": "The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.", "example": 112, "nullable": true }, "coupons_count": { "type": "integer", "description": "The total number of coupons created for this promotion.", "example": 2, "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "x": { "type": "integer", "description": "The quantity which defines the threshold for free items (works by multiple of x).", "example": 3, "nullable": false }, "y": { "type": "integer", "description": "The quantity which defines how many items you get for free, with the formula x-y.", "example": 2, "nullable": false }, "cheapest_free": { "type": "boolean", "description": "Indicates if the cheapest items are discounted, allowing all of the SKUs in the associated list to be eligible for counting.", "example": true, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "promotion_rules": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupons": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "skus": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "buyXPayYPromotionCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "buy_x_pay_y_promotions" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion" }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR" }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2 }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z" }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z" }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5 }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "x": { "type": "integer", "description": "The quantity which defines the threshold for free items (works by multiple of x).", "example": 3 }, "y": { "type": "integer", "description": "The quantity which defines how many items you get for free, with the formula x-y.", "example": 2 }, "cheapest_free": { "type": "boolean", "description": "Indicates if the cheapest items are discounted, allowing all of the SKUs in the associated list to be eligible for counting.", "example": true } }, "required": [ "name", "starts_at", "expires_at", "x", "y" ] }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "sku_list" ] } } } } }, "buyXPayYPromotionUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "buy_x_pay_y_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion", "nullable": false }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true, "nullable": false }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2, "nullable": true }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": false }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5, "nullable": true }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "x": { "type": "integer", "description": "The quantity which defines the threshold for free items (works by multiple of x).", "example": 3, "nullable": false }, "y": { "type": "integer", "description": "The quantity which defines how many items you get for free, with the formula x-y.", "example": 2, "nullable": false }, "cheapest_free": { "type": "boolean", "description": "Indicates if the cheapest items are discounted, allowing all of the SKUs in the associated list to be eligible for counting.", "example": true, "nullable": false } } }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "buyXPayYPromotionResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "buy_x_pay_y_promotions" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/buyXPayYPromotion/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "market" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "promotion_rules": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion_rules" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "order_amount_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_list_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "coupon_codes_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "custom_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_list": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "coupons": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "skus": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "buyXPayYPromotionResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/buyXPayYPromotionResponse/properties/data" } } } }, "capture": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "captures" ] }, "attributes": { "type": "object", "properties": { "number": { "type": "string", "description": "The transaction number, auto generated.", "example": "42/T/001", "nullable": false }, "type": { "type": "string", "description": "The transaction's type.", "example": "authorizations", "nullable": false, "enum": [ "authorizations", "voids", "captures", "refunds" ] }, "payment_method_type": { "type": "string", "description": "Information about the payment method used in the transaction.", "example": "credit card", "nullable": true }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated order.", "example": "EUR", "nullable": false }, "amount_cents": { "type": "integer", "description": "The transaction amount, in cents.", "example": 1500, "nullable": false }, "amount_float": { "type": "number", "description": "The transaction amount, float.", "example": 15.0, "nullable": false }, "formatted_amount": { "type": "string", "description": "The transaction amount, formatted.", "example": "€15,00", "nullable": false }, "succeeded": { "type": "boolean", "description": "Indicates if the transaction is successful.", "example": false, "nullable": false }, "message": { "type": "string", "description": "The message returned by the payment gateway.", "example": "Accepted", "nullable": true }, "error_code": { "type": "string", "description": "The error code, if any, returned by the payment gateway.", "example": "00001", "nullable": true }, "error_detail": { "type": "string", "description": "The error detail, if any, returned by the payment gateway.", "example": "Already settled", "nullable": true }, "token": { "type": "string", "description": "The token identifying the transaction, returned by the payment gateway.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "gateway_transaction_id": { "type": "string", "description": "The ID identifying the transaction, returned by the payment gateway.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "refund_amount_cents": { "type": "integer", "description": "The amount to be refunded, in cents.", "example": 500, "nullable": true }, "refund_amount_float": { "type": "number", "description": "The amount to be refunded, float.", "example": 5.0, "nullable": true }, "formatted_refund_amount": { "type": "string", "description": "The amount to be refunded, formatted.", "example": "€5,00", "nullable": true }, "refund_balance_cents": { "type": "integer", "description": "The balance to be refunded, in cents.", "example": 1000, "nullable": true }, "refund_balance_float": { "type": "number", "description": "The balance to be refunded, float.", "example": 10.0, "nullable": true }, "formatted_refund_balance": { "type": "string", "description": "The balance to be refunded, formatted.", "example": "€10,00", "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_source": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_payments", "axerve_payments", "braintree_payments", "checkout_com_payments", "external_payments", "klarna_payments", "paypal_payments", "satispay_payments", "stripe_payments", "wire_transfers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/adyenPayment" }, { "$ref": "#/components/schemas/axervePayment" }, { "$ref": "#/components/schemas/braintreePayment" }, { "$ref": "#/components/schemas/checkoutComPayment" }, { "$ref": "#/components/schemas/externalPayment" }, { "$ref": "#/components/schemas/klarnaPayment" }, { "$ref": "#/components/schemas/paypalPayment" }, { "$ref": "#/components/schemas/satispayPayment" }, { "$ref": "#/components/schemas/stripePayment" }, { "$ref": "#/components/schemas/wireTransfer" } ] }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "reference_authorization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "authorizations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "refunds": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "refunds" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "return": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "returns" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "captureUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "captures" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "succeeded": { "type": "boolean", "description": "Indicates if the transaction is successful.", "example": false, "nullable": false }, "_forward": { "type": "boolean", "description": "Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "_refund": { "type": "boolean", "description": "Send this attribute if you want to create a refund for this capture.", "example": true, "nullable": false }, "_refund_amount_cents": { "type": "integer", "description": "Send this attribute as a value in cents if you want to overwrite the amount to be refunded.", "example": 500 }, "_cancel": { "type": "boolean", "description": "Send this attribute if you want to refund a succeeded capture of a pending order (which is left unpaid).", "example": true, "nullable": false } } }, "relationships": { "type": "object", "properties": { } } } } } }, "captureResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "captures" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/capture/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_source": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_source" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "reference_authorization": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "reference_authorization" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "refunds": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "refunds" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "return": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "return" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "captureResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/captureResponse/properties/data" } } } }, "carrierAccount": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "carrier_accounts" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The carrier account internal name.", "example": "Accurate", "nullable": false }, "easypost_type": { "type": "string", "description": "The Easypost service carrier type.", "example": "AccurateAccount", "nullable": false }, "easypost_id": { "type": "string", "description": "The Easypost internal reference ID.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "credentials": { "type": "object", "description": "The Easypost carrier accounts credentials fields.", "example": { "username": "xxxx", "password": "secret" }, "nullable": false }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "carrierAccountCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "carrier_accounts" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The carrier account internal name.", "example": "Accurate" }, "easypost_type": { "type": "string", "description": "The Easypost service carrier type.", "example": "AccurateAccount" }, "credentials": { "type": "object", "description": "The Easypost carrier accounts credentials fields.", "example": { "username": "xxxx", "password": "secret" } }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name", "easypost_type", "credentials" ] }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "carrierAccountUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "carrier_accounts" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The carrier account internal name.", "example": "Accurate", "nullable": false }, "easypost_type": { "type": "string", "description": "The Easypost service carrier type.", "example": "AccurateAccount", "nullable": false }, "credentials": { "type": "object", "description": "The Easypost carrier accounts credentials fields.", "example": { "username": "xxxx", "password": "secret" }, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "carrierAccountResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "carrier_accounts" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/carrierAccount/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "market" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "carrierAccountResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/carrierAccountResponse/properties/data" } } } }, "checkoutComGateway": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "checkout_com_gateways" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway", "nullable": false }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true, "nullable": true }, "credential_keys": { "type": "object", "description": "The payment gateway's API credential keys last digits.", "example": { "api_key": "********BW989" }, "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "webhook_endpoint_id": { "type": "string", "description": "The gateway webhook endpoint ID, generated automatically.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "webhook_endpoint_secret": { "type": "string", "description": "The gateway webhook endpoint secret, generated automatically.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "webhook_endpoint_url": { "type": "string", "description": "The gateway webhook URL, generated automatically.", "example": "https://core.commercelayer.co/webhook_callbacks/checkout_com_gateways/xxxxx", "nullable": true } } }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "checkout_com_payments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "checkout_com_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "checkoutComGatewayCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "checkout_com_gateways" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway" }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "_check": { "type": "boolean", "description": "Send this attribute if you want to check the credentials against the payment gateway's APIs.", "example": true }, "secret_key": { "type": "string", "description": "The gateway secret key.", "example": "sk_test_xxxx-yyyy-zzzz" }, "public_key": { "type": "string", "description": "The gateway public key.", "example": "pk_test_xxxx-yyyy-zzzz" } }, "required": [ "name", "secret_key", "public_key" ] }, "relationships": { "type": "object", "properties": { "checkout_com_payments": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "checkout_com_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "checkoutComGatewayUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "checkout_com_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway", "nullable": false }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true, "nullable": false }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "_check": { "type": "boolean", "description": "Send this attribute if you want to check the credentials against the payment gateway's APIs.", "example": true, "nullable": false }, "secret_key": { "type": "string", "description": "The gateway secret key.", "example": "sk_test_xxxx-yyyy-zzzz" }, "public_key": { "type": "string", "description": "The gateway public key.", "example": "pk_test_xxxx-yyyy-zzzz" } } }, "relationships": { "type": "object", "properties": { "checkout_com_payments": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "checkout_com_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "checkoutComGatewayResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "checkout_com_gateways" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/checkoutComGateway/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "checkout_com_payments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "checkout_com_payments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "checkoutComGatewayResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/checkoutComGatewayResponse/properties/data" } } } }, "checkoutComPayment": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "checkout_com_payments" ] }, "attributes": { "type": "object", "properties": { "public_key": { "type": "string", "description": "The Checkout.com publishable API key.", "example": "pk_test_xxxx-yyyy-zzzz", "nullable": true }, "token": { "type": "string", "description": "The Checkout.com payment or digital wallet token.", "example": "tok_4gzeau5o2uqubbk6fufs3m7p54", "nullable": false }, "payment_session": { "type": "object", "description": "The session object which initializes payment.", "example": { "id": "ps_xxxx_yyyy_zzzz", "payment_session_secret": "pss_xxxx_yyy_zzzz", "payment_session_token": "xxxxx_yyyyy_zzzzz", "_links": { "self": { "href": "https://api.sandbox.checkout.com/payment-sessions/ps_xxxx_yyyy_zzzz" } } }, "nullable": false }, "success_url": { "type": "string", "description": "The URL to redirect your customer upon 3DS succeeded authentication.", "example": "http://commercelayer.dev/checkout_com/success", "nullable": false }, "failure_url": { "type": "string", "description": "The URL to redirect your customer upon 3DS failed authentication.", "example": "http://commercelayer.dev/checkout_com/failure", "nullable": false }, "source_id": { "type": "string", "description": "The payment source identifier that can be used for subsequent payments.", "example": "src_nwd3m4in3hkuddfpjsaevunhdy", "nullable": true }, "customer_token": { "type": "string", "description": "The customer's unique identifier. This can be passed as a source when making a payment.", "example": "cus_udst2tfldj6upmye2reztkmm4i", "nullable": true }, "redirect_uri": { "type": "string", "description": "The URI that the customer should be redirected to in order to complete the payment.", "example": "https://api.checkout.com/3ds/pay_mbabizu24mvu3mela5njyhpit4", "nullable": true }, "payment_response": { "type": "object", "description": "The Checkout.com payment response, used to fetch internal data.", "example": { "foo": "bar" }, "nullable": true }, "mismatched_amounts": { "type": "boolean", "description": "Indicates if the order current amount differs form the one of the associated authorization.", "example": false, "nullable": true }, "payment_instrument": { "type": "object", "description": "Information about the payment instrument used in the transaction.", "example": { "issuer": "cl bank", "card_type": "visa" }, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_gateway": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "checkoutComPaymentCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "checkout_com_payments" ] }, "attributes": { "type": "object", "properties": { "token": { "type": "string", "description": "The Checkout.com payment or digital wallet token.", "example": "tok_4gzeau5o2uqubbk6fufs3m7p54" }, "success_url": { "type": "string", "description": "The URL to redirect your customer upon 3DS succeeded authentication.", "example": "http://commercelayer.dev/checkout_com/success" }, "failure_url": { "type": "string", "description": "The URL to redirect your customer upon 3DS failed authentication.", "example": "http://commercelayer.dev/checkout_com/failure" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "token", "success_url", "failure_url" ] }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "order" ] } } } } }, "checkoutComPaymentUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "checkout_com_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "token": { "type": "string", "description": "The Checkout.com payment or digital wallet token.", "example": "tok_4gzeau5o2uqubbk6fufs3m7p54", "nullable": false }, "_details": { "type": "boolean", "description": "Send this attribute if you want to send additional details the payment request (i.e. upon 3DS check).", "example": true, "nullable": false }, "_refresh": { "type": "boolean", "description": "Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "checkoutComPaymentResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "checkout_com_payments" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/checkoutComPayment/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_gateway": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateway" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "checkoutComPaymentResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/checkoutComPaymentResponse/properties/data" } } } }, "cleanup": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "cleanups" ] }, "attributes": { "type": "object", "properties": { "resource_type": { "type": "string", "description": "The type of resource being cleaned.", "example": "skus", "nullable": false }, "status": { "type": "string", "description": "The cleanup job status. One of 'pending' (default), 'in_progress', 'interrupted', or 'completed'.", "example": "in_progress", "nullable": false, "enum": [ "pending", "in_progress", "interrupted", "completed" ] }, "started_at": { "type": "string", "description": "Time at which the cleanup was started.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "completed_at": { "type": "string", "description": "Time at which the cleanup was completed.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "interrupted_at": { "type": "string", "description": "Time at which the cleanup was interrupted.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "filters": { "type": "object", "description": "The filters used to select the records to be cleaned.", "example": { "code_eq": "AAA" }, "nullable": true }, "records_count": { "type": "integer", "description": "Indicates the number of records to be cleaned.", "example": 300, "nullable": true }, "errors_count": { "type": "integer", "description": "Indicates the number of cleanup errors, if any.", "example": 30, "nullable": true }, "processed_count": { "type": "integer", "description": "Indicates the number of records that have been cleaned.", "example": 270, "nullable": true }, "errors_log": { "type": "object", "description": "Contains the cleanup errors, if any.", "example": { "ABC": { "name": [ "has already been taken" ] } }, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "cleanupCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "cleanups" ] }, "attributes": { "type": "object", "properties": { "resource_type": { "type": "string", "description": "The type of resource being cleaned.", "example": "skus" }, "filters": { "type": "object", "description": "The filters used to select the records to be cleaned.", "example": { "code_eq": "AAA" } }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "resource_type" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "cleanupUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "cleanups" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "_interrupt": { "type": "boolean", "description": "Send this attribute if you want to mark status as 'interrupted'.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "cleanupResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "cleanups" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/cleanup/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "cleanupResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/cleanupResponse/properties/data" } } } }, "couponCodesPromotionRule": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "attributes": { "type": "object", "properties": { "type": { "type": "string", "description": "The promotion rule's type.", "example": "coupon_codes_promotion_rules", "nullable": false, "enum": [ "order_amount_promotion_rules", "sku_list_promotion_rules", "coupon_codes_promotion_rules", "custom_promotion_rules" ] }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "promotion": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/percentageDiscountPromotion" }, { "$ref": "#/components/schemas/freeShippingPromotion" }, { "$ref": "#/components/schemas/buyXPayYPromotion" }, { "$ref": "#/components/schemas/freeGiftPromotion" }, { "$ref": "#/components/schemas/fixedPricePromotion" }, { "$ref": "#/components/schemas/externalPromotion" }, { "$ref": "#/components/schemas/fixedAmountPromotion" }, { "$ref": "#/components/schemas/flexPromotion" } ] }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupons": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "couponCodesPromotionRuleCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "attributes": { "type": "object", "properties": { "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } } }, "relationships": { "type": "object", "properties": { "promotion": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/percentageDiscountPromotion" }, { "$ref": "#/components/schemas/freeShippingPromotion" }, { "$ref": "#/components/schemas/buyXPayYPromotion" }, { "$ref": "#/components/schemas/freeGiftPromotion" }, { "$ref": "#/components/schemas/fixedPricePromotion" }, { "$ref": "#/components/schemas/externalPromotion" }, { "$ref": "#/components/schemas/fixedAmountPromotion" }, { "$ref": "#/components/schemas/flexPromotion" } ] }, "coupons": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "promotion" ] } } } } }, "couponCodesPromotionRuleUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "promotion": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/percentageDiscountPromotion" }, { "$ref": "#/components/schemas/freeShippingPromotion" }, { "$ref": "#/components/schemas/buyXPayYPromotion" }, { "$ref": "#/components/schemas/freeGiftPromotion" }, { "$ref": "#/components/schemas/fixedPricePromotion" }, { "$ref": "#/components/schemas/externalPromotion" }, { "$ref": "#/components/schemas/fixedAmountPromotion" }, { "$ref": "#/components/schemas/flexPromotion" } ] }, "coupons": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "couponCodesPromotionRuleResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/couponCodesPromotionRule/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "promotion": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "coupons": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "couponCodesPromotionRuleResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/couponCodesPromotionRuleResponse/properties/data" } } } }, "couponRecipient": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_recipients" ] }, "attributes": { "type": "object", "properties": { "email": { "type": "string", "description": "The recipient email address.", "example": "john@example.com", "nullable": false }, "first_name": { "type": "string", "description": "The recipient first name.", "example": "John", "nullable": true }, "last_name": { "type": "string", "description": "The recipient last name.", "example": "Smith", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "customer": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "couponRecipientCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_recipients" ] }, "attributes": { "type": "object", "properties": { "email": { "type": "string", "description": "The recipient email address.", "example": "john@example.com" }, "first_name": { "type": "string", "description": "The recipient first name.", "example": "John" }, "last_name": { "type": "string", "description": "The recipient last name.", "example": "Smith" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "email" ] }, "relationships": { "type": "object", "properties": { "customer": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "couponRecipientUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_recipients" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "email": { "type": "string", "description": "The recipient email address.", "example": "john@example.com", "nullable": false }, "first_name": { "type": "string", "description": "The recipient first name.", "example": "John", "nullable": true }, "last_name": { "type": "string", "description": "The recipient last name.", "example": "Smith", "nullable": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "customer": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "couponRecipientResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_recipients" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/couponRecipient/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "customer": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "couponRecipientResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/couponRecipientResponse/properties/data" } } } }, "coupon": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "attributes": { "type": "object", "properties": { "code": { "type": "string", "description": "The coupon code, that uniquely identifies the coupon within the promotion rule.", "example": "04371af2-70b3-48d7-8f4e-316b374224c3", "nullable": false }, "customer_single_use": { "type": "boolean", "description": "Indicates if the coupon can be used just once per customer.", "example": false, "nullable": true }, "usage_limit": { "type": "integer", "description": "The total number of times this coupon can be used.", "example": 50, "nullable": true }, "usage_count": { "type": "integer", "description": "The number of times this coupon has been used.", "example": 20, "nullable": true }, "recipient_email": { "type": "string", "description": "The email address of the associated recipient. When creating or updating a coupon, this is a shortcut to find or create the associated recipient by email.", "example": "john@example.com", "nullable": true }, "expires_at": { "type": "string", "description": "Time at which the coupon will expire.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_recipient": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_recipients" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "couponCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "attributes": { "type": "object", "properties": { "code": { "type": "string", "description": "The coupon code, that uniquely identifies the coupon within the promotion rule.", "example": "04371af2-70b3-48d7-8f4e-316b374224c3" }, "customer_single_use": { "type": "boolean", "description": "Indicates if the coupon can be used just once per customer.", "example": false }, "usage_limit": { "type": "integer", "description": "The total number of times this coupon can be used.", "example": 50 }, "recipient_email": { "type": "string", "description": "The email address of the associated recipient. When creating or updating a coupon, this is a shortcut to find or create the associated recipient by email.", "example": "john@example.com" }, "expires_at": { "type": "string", "description": "Time at which the coupon will expire.", "example": "2018-01-01T12:00:00.000Z" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "code" ] }, "relationships": { "type": "object", "properties": { "promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_recipient": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_recipients" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "promotion_rule" ] } } } } }, "couponUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "code": { "type": "string", "description": "The coupon code, that uniquely identifies the coupon within the promotion rule.", "example": "04371af2-70b3-48d7-8f4e-316b374224c3", "nullable": false }, "customer_single_use": { "type": "boolean", "description": "Indicates if the coupon can be used just once per customer.", "example": false, "nullable": false }, "usage_limit": { "type": "integer", "description": "The total number of times this coupon can be used.", "example": 50, "nullable": true }, "recipient_email": { "type": "string", "description": "The email address of the associated recipient. When creating or updating a coupon, this is a shortcut to find or create the associated recipient by email.", "example": "john@example.com", "nullable": true }, "expires_at": { "type": "string", "description": "Time at which the coupon will expire.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_recipient": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_recipients" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "couponResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/coupon/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "coupon_recipient": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_recipient" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "couponResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/couponResponse/properties/data" } } } }, "customPromotionRule": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "attributes": { "type": "object", "properties": { "type": { "type": "string", "description": "The promotion rule's type.", "example": "coupon_codes_promotion_rules", "nullable": false, "enum": [ "order_amount_promotion_rules", "sku_list_promotion_rules", "coupon_codes_promotion_rules", "custom_promotion_rules" ] }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "filters": { "type": "object", "description": "The filters used to trigger promotion on the matching order and its relationships attributes.", "example": { "status_eq": "pending", "line_items_sku_code_eq": "AAA" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "promotion": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/percentageDiscountPromotion" }, { "$ref": "#/components/schemas/freeShippingPromotion" }, { "$ref": "#/components/schemas/buyXPayYPromotion" }, { "$ref": "#/components/schemas/freeGiftPromotion" }, { "$ref": "#/components/schemas/fixedPricePromotion" }, { "$ref": "#/components/schemas/externalPromotion" }, { "$ref": "#/components/schemas/fixedAmountPromotion" }, { "$ref": "#/components/schemas/flexPromotion" } ] }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "customPromotionRuleCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "attributes": { "type": "object", "properties": { "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "filters": { "type": "object", "description": "The filters used to trigger promotion on the matching order and its relationships attributes.", "example": { "status_eq": "pending", "line_items_sku_code_eq": "AAA" } } } }, "relationships": { "type": "object", "properties": { "promotion": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/percentageDiscountPromotion" }, { "$ref": "#/components/schemas/freeShippingPromotion" }, { "$ref": "#/components/schemas/buyXPayYPromotion" }, { "$ref": "#/components/schemas/freeGiftPromotion" }, { "$ref": "#/components/schemas/fixedPricePromotion" }, { "$ref": "#/components/schemas/externalPromotion" }, { "$ref": "#/components/schemas/fixedAmountPromotion" }, { "$ref": "#/components/schemas/flexPromotion" } ] } }, "required": [ "promotion" ] } } } } }, "customPromotionRuleUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "filters": { "type": "object", "description": "The filters used to trigger promotion on the matching order and its relationships attributes.", "example": { "status_eq": "pending", "line_items_sku_code_eq": "AAA" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "promotion": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/percentageDiscountPromotion" }, { "$ref": "#/components/schemas/freeShippingPromotion" }, { "$ref": "#/components/schemas/buyXPayYPromotion" }, { "$ref": "#/components/schemas/freeGiftPromotion" }, { "$ref": "#/components/schemas/fixedPricePromotion" }, { "$ref": "#/components/schemas/externalPromotion" }, { "$ref": "#/components/schemas/fixedAmountPromotion" }, { "$ref": "#/components/schemas/flexPromotion" } ] } } } } } } }, "customPromotionRuleResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/customPromotionRule/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "promotion": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "customPromotionRuleResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/customPromotionRuleResponse/properties/data" } } } }, "customerAddress": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_addresses" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Returns the associated address' name.", "example": "John Smith, 2883 Geraldine Lane Apt.23, 10013 New York NY (US) (212) 646-338-1228", "nullable": true }, "customer_email": { "type": "string", "description": "The email of the customer associated to the address.", "example": "john@example.com", "nullable": false }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "customer": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "address": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "customerAddressCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_addresses" ] }, "attributes": { "type": "object", "properties": { "customer_email": { "type": "string", "description": "The email of the customer associated to the address.", "example": "john@example.com" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "customer_email" ] }, "relationships": { "type": "object", "properties": { "customer": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "address": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "customer", "address" ] } } } } }, "customerAddressUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "customer": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "address": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "customerAddressResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_addresses" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/customerAddress/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "customer": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "address": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "address" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "customerAddressResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/customerAddressResponse/properties/data" } } } }, "customerGroup": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_groups" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The customer group's internal name.", "example": "VIP", "nullable": false }, "code": { "type": "string", "description": "A string that you can use to identify the customer group (must be unique within the environment).", "example": "vip1", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "customers": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "markets": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "customerGroupCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_groups" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The customer group's internal name.", "example": "VIP" }, "code": { "type": "string", "description": "A string that you can use to identify the customer group (must be unique within the environment).", "example": "vip1" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "customerGroupUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_groups" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The customer group's internal name.", "example": "VIP", "nullable": false }, "code": { "type": "string", "description": "A string that you can use to identify the customer group (must be unique within the environment).", "example": "vip1", "nullable": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "customerGroupResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_groups" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/customerGroup/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "customers": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "markets": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "customerGroupResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/customerGroupResponse/properties/data" } } } }, "customerPasswordReset": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_password_resets" ] }, "attributes": { "type": "object", "properties": { "customer_email": { "type": "string", "description": "The email of the customer that requires a password reset.", "example": "john@example.com", "nullable": false }, "reset_password_token": { "type": "string", "description": "Automatically generated on create. Send its value as the '_reset_password_token' argument when updating the customer password.", "example": "xhFfkmfybsLxzaAP6xcs", "nullable": true }, "reset_password_at": { "type": "string", "description": "Time at which the password was reset.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "customer": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "customerPasswordResetCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_password_resets" ] }, "attributes": { "type": "object", "properties": { "customer_email": { "type": "string", "description": "The email of the customer that requires a password reset.", "example": "john@example.com" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "customer_email" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "customerPasswordResetUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_password_resets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "customer_password": { "type": "string", "description": "The customer new password. This will be accepted only if a valid '_reset_password_token' is sent with the request.", "example": "secret" }, "_reset_password_token": { "type": "string", "description": "Send the 'reset_password_token' that you got on create when updating the customer password.", "example": "xhFfkmfybsLxzaAP6xcs" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "customerPasswordResetResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_password_resets" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/customerPasswordReset/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "customer": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "customerPasswordResetResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/customerPasswordResetResponse/properties/data" } } } }, "customerPaymentSource": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_payment_sources" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Returns the associated payment source's name.", "example": "XXXX-XXXX-XXXX-1111", "nullable": true }, "customer_token": { "type": "string", "description": "Returns the customer gateway token stored in the gateway.", "example": "cus_xxxyyyzzz", "nullable": true }, "payment_source_token": { "type": "string", "description": "Returns the payment source token stored in the gateway.", "example": "pm_xxxyyyzzz", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "customer": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_method": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_source": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_payments", "axerve_payments", "braintree_payments", "checkout_com_payments", "external_payments", "klarna_payments", "paypal_payments", "satispay_payments", "stripe_payments", "wire_transfers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/adyenPayment" }, { "$ref": "#/components/schemas/axervePayment" }, { "$ref": "#/components/schemas/braintreePayment" }, { "$ref": "#/components/schemas/checkoutComPayment" }, { "$ref": "#/components/schemas/externalPayment" }, { "$ref": "#/components/schemas/klarnaPayment" }, { "$ref": "#/components/schemas/paypalPayment" }, { "$ref": "#/components/schemas/satispayPayment" }, { "$ref": "#/components/schemas/stripePayment" }, { "$ref": "#/components/schemas/wireTransfer" } ] }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "customerPaymentSourceCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_payment_sources" ] }, "attributes": { "type": "object", "properties": { "customer_token": { "type": "string", "description": "Returns the customer gateway token stored in the gateway.", "example": "cus_xxxyyyzzz" }, "payment_source_token": { "type": "string", "description": "Returns the payment source token stored in the gateway.", "example": "pm_xxxyyyzzz" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } } }, "relationships": { "type": "object", "properties": { "customer": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_method": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_source": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_payments", "axerve_payments", "braintree_payments", "checkout_com_payments", "external_payments", "klarna_payments", "paypal_payments", "satispay_payments", "stripe_payments", "wire_transfers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/adyenPayment" }, { "$ref": "#/components/schemas/axervePayment" }, { "$ref": "#/components/schemas/braintreePayment" }, { "$ref": "#/components/schemas/checkoutComPayment" }, { "$ref": "#/components/schemas/externalPayment" }, { "$ref": "#/components/schemas/klarnaPayment" }, { "$ref": "#/components/schemas/paypalPayment" }, { "$ref": "#/components/schemas/satispayPayment" }, { "$ref": "#/components/schemas/stripePayment" }, { "$ref": "#/components/schemas/wireTransfer" } ] } }, "required": [ "customer" ] } } } } }, "customerPaymentSourceUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_payment_sources" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "customer_token": { "type": "string", "description": "Returns the customer gateway token stored in the gateway.", "example": "cus_xxxyyyzzz", "nullable": true }, "payment_source_token": { "type": "string", "description": "Returns the payment source token stored in the gateway.", "example": "pm_xxxyyyzzz", "nullable": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "customer": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_method": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_source": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_payments", "axerve_payments", "braintree_payments", "checkout_com_payments", "external_payments", "klarna_payments", "paypal_payments", "satispay_payments", "stripe_payments", "wire_transfers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/adyenPayment" }, { "$ref": "#/components/schemas/axervePayment" }, { "$ref": "#/components/schemas/braintreePayment" }, { "$ref": "#/components/schemas/checkoutComPayment" }, { "$ref": "#/components/schemas/externalPayment" }, { "$ref": "#/components/schemas/klarnaPayment" }, { "$ref": "#/components/schemas/paypalPayment" }, { "$ref": "#/components/schemas/satispayPayment" }, { "$ref": "#/components/schemas/stripePayment" }, { "$ref": "#/components/schemas/wireTransfer" } ] } } } } } } }, "customerPaymentSourceResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_payment_sources" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/customerPaymentSource/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "customer": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_method": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_method" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_source": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_source" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "customerPaymentSourceResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/customerPaymentSourceResponse/properties/data" } } } }, "customerSubscription": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_subscriptions" ] }, "attributes": { "type": "object", "properties": { "customer_email": { "type": "string", "description": "The email of the customer that owns the subscription.", "example": "john@example.com", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": false }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "customer": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "customerSubscriptionCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_subscriptions" ] }, "attributes": { "type": "object", "properties": { "customer_email": { "type": "string", "description": "The email of the customer that owns the subscription.", "example": "john@example.com" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "customer_email", "reference" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "customerSubscriptionUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_subscriptions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": false }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "customerSubscriptionResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_subscriptions" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/customerSubscription/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "customer": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "customerSubscriptionResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/customerSubscriptionResponse/properties/data" } } } }, "customer": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "attributes": { "type": "object", "properties": { "email": { "type": "string", "description": "The customer's email address.", "example": "john@example.com", "nullable": false }, "status": { "type": "string", "description": "The customer's status. One of 'prospect' (default), 'acquired', or 'repeat'.", "example": "prospect", "nullable": false, "enum": [ "prospect", "acquired", "repeat" ] }, "has_password": { "type": "boolean", "description": "Indicates if the customer has a password.", "example": false, "nullable": true }, "total_orders_count": { "type": "integer", "description": "The total number of orders for the customer.", "example": 6, "nullable": true }, "shopper_reference": { "type": "string", "description": "A reference to uniquely identify the shopper during payment sessions.", "example": "xxx-yyy-zzz", "nullable": true }, "profile_id": { "type": "string", "description": "A reference to uniquely identify the customer on any connected external services.", "example": "xxx-yyy-zzz", "nullable": true }, "tax_exemption_code": { "type": "string", "description": "A specific code to identify the tax exemption reason for this customer.", "example": "xxx-yyy-zzz", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "jwt_custom_claim": { "type": "object", "description": "The custom_claim attached to the current JWT (if any).", "example": { }, "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "anonymization_info": { "type": "object", "description": "The anonymization info object.", "example": { "status": "requested", "requested_at": "2025-03-15 11:39:21 UTC", "requester": { "id": "fdgt56hh", "first_name": "Travis", "last_name": "Muller", "email": "test@labadie.test" } }, "properties": { "status": { "type": "string", "description": "The status of the anonymization." }, "requested_at": { "type": "string", "description": "The time when the anonymization was requested." }, "started_at": { "type": "string", "description": "The time when the anonymization request was started." }, "completed_at": { "type": "string", "description": "The time when the anonymization request was completed." }, "failed_at": { "type": "string", "description": "The time when the anonymization request failed." }, "cancelled_at": { "type": "string", "description": "The time when the anonymization request was cancelled." }, "requester": { "type": "object", "description": "The user who requested the anonymization.", "properties": { "id": { "type": "string", "description": "The ID of the user." }, "first_name": { "type": "string", "description": "First name of the user." }, "last_name": { "type": "string", "description": "Last name of the user." }, "email": { "type": "string", "description": "Email of the user." } } }, "cancellation_requester": { "type": "object", "description": "The user who requested the cancellation of the anonymization.", "properties": { "id": { "type": "string", "description": "The ID of the user." }, "first_name": { "type": "string", "description": "First name of the user." }, "last_name": { "type": "string", "description": "Last name of the user." }, "email": { "type": "string", "description": "Email of the user." } } } }, "nullable": true }, "anonymization_status": { "type": "string", "description": "Status of the current anonymization request (if any). One of 'requested', 'started', 'completed', 'failed', or 'cancelled'.", "example": "requested", "nullable": true, "enum": [ "requested", "started", "completed", "failed", "cancelled" ] } } }, "relationships": { "type": "object", "properties": { "customer_group": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_groups" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "customer_addresses": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "customer_payment_sources": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_payment_sources" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "customer_subscriptions": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_subscriptions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "orders": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_subscriptions": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscriptions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "returns": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "returns" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_lists": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "jwt_customer": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "jwt_markets": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "jwt_stock_locations": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "customerCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "attributes": { "type": "object", "properties": { "email": { "type": "string", "description": "The customer's email address.", "example": "john@example.com" }, "password": { "type": "string", "description": "The customer's password. Initiate a customer password reset flow if you need to change it.", "example": "secret" }, "shopper_reference": { "type": "string", "description": "A reference to uniquely identify the shopper during payment sessions.", "example": "xxx-yyy-zzz" }, "profile_id": { "type": "string", "description": "A reference to uniquely identify the customer on any connected external services.", "example": "xxx-yyy-zzz" }, "tax_exemption_code": { "type": "string", "description": "A specific code to identify the tax exemption reason for this customer.", "example": "xxx-yyy-zzz" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "email" ] }, "relationships": { "type": "object", "properties": { "customer_group": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_groups" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "customerUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "email": { "type": "string", "description": "The customer's email address.", "example": "john@example.com", "nullable": false }, "password": { "type": "string", "description": "The customer's password. Initiate a customer password reset flow if you need to change it.", "example": "secret" }, "shopper_reference": { "type": "string", "description": "A reference to uniquely identify the shopper during payment sessions.", "example": "xxx-yyy-zzz", "nullable": true }, "profile_id": { "type": "string", "description": "A reference to uniquely identify the customer on any connected external services.", "example": "xxx-yyy-zzz", "nullable": true }, "tax_exemption_code": { "type": "string", "description": "A specific code to identify the tax exemption reason for this customer.", "example": "xxx-yyy-zzz", "nullable": true }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "_request_anonymization": { "type": "boolean", "description": "Send this attribute if you want to trigger anonymization. Cannot be passed by sales channels.", "example": true, "nullable": false }, "_cancel_anonymization": { "type": "boolean", "description": "Send this attribute if you want to trigger a cancellation of anonymization. Cannot be passed by sales channels.", "example": true, "nullable": false } } }, "relationships": { "type": "object", "properties": { "customer_group": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_groups" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "customerResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/customer/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "customer_group": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_group" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "customer_addresses": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_addresses" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "customer_payment_sources": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_payment_sources" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "customer_subscriptions": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_subscriptions" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "orders": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "order_subscriptions": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscriptions" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "returns": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "returns" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_lists": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "jwt_customer": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "jwt_customer" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "jwt_markets": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "jwt_markets" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "jwt_stock_locations": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "jwt_stock_locations" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "customerResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/customerResponse/properties/data" } } } }, "deliveryLeadTime": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "delivery_lead_times" ] }, "attributes": { "type": "object", "properties": { "min_hours": { "type": "integer", "description": "The delivery lead minimum time (in hours) when shipping from the associated stock location with the associated shipping method.", "example": 48, "nullable": false }, "max_hours": { "type": "integer", "description": "The delivery lead maximun time (in hours) when shipping from the associated stock location with the associated shipping method.", "example": 72, "nullable": false }, "min_days": { "type": "integer", "description": "The delivery lead minimum time, in days (rounded).", "example": 2, "nullable": true }, "max_days": { "type": "integer", "description": "The delivery lead maximun time, in days (rounded).", "example": 3, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "stock_location": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_method": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "deliveryLeadTimeCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "delivery_lead_times" ] }, "attributes": { "type": "object", "properties": { "min_hours": { "type": "integer", "description": "The delivery lead minimum time (in hours) when shipping from the associated stock location with the associated shipping method.", "example": 48 }, "max_hours": { "type": "integer", "description": "The delivery lead maximun time (in hours) when shipping from the associated stock location with the associated shipping method.", "example": 72 }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "min_hours", "max_hours" ] }, "relationships": { "type": "object", "properties": { "stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_method": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "stock_location", "shipping_method" ] } } } } }, "deliveryLeadTimeUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "delivery_lead_times" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "min_hours": { "type": "integer", "description": "The delivery lead minimum time (in hours) when shipping from the associated stock location with the associated shipping method.", "example": 48, "nullable": false }, "max_hours": { "type": "integer", "description": "The delivery lead maximun time (in hours) when shipping from the associated stock location with the associated shipping method.", "example": 72, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_method": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "deliveryLeadTimeResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "delivery_lead_times" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/deliveryLeadTime/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "stock_location": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_location" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "shipping_method": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_method" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "deliveryLeadTimeResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/deliveryLeadTimeResponse/properties/data" } } } }, "discountEngineItem": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "discount_engine_items" ] }, "attributes": { "type": "object", "properties": { "body": { "type": "object", "description": "The body of the external discount engine response.", "example": { "foo": "bar" }, "nullable": false }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "discount_engine": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "discount_engines" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "discountEngineItemResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "discount_engine_items" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/discountEngineItem/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "discount_engine": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "discount_engine" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "discountEngineItemResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/discountEngineItemResponse/properties/data" } } } }, "discountEngine": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "discount_engines" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The discount engine's internal name.", "example": "Personal discount engine", "nullable": false }, "type": { "type": "string", "description": "The discount engine's type.", "example": "talon_one_accounts", "nullable": false, "enum": [ "talon_one_accounts" ] }, "manage_gift_cards": { "type": "boolean", "description": "Indicates if the discount engine manages both promotions and gift cards application at once.", "example": false, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "discount_engine_items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "discount_engine_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "discountEngineResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "discount_engines" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/discountEngine/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "discount_engine_items": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "discount_engine_items" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "discountEngineResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/discountEngineResponse/properties/data" } } } }, "easypostPickup": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "easypost_pickups" ] }, "attributes": { "type": "object", "properties": { "type": { "type": "string", "description": "The pick up's type.", "example": "easypost_pickups", "nullable": false, "enum": [ "easypost_pickups" ] }, "status": { "type": "string", "description": "The pick up status.", "example": "unknown", "nullable": true }, "internal_id": { "type": "string", "description": "The pick up service internal ID.", "example": "pickup_13e5d7e2a7824432a07975bc553944bc", "nullable": false }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "selected_rate_id": { "type": "string", "description": "The selected purchase rate from the available pick up rates.", "example": "pickuprate_a6cd2647a898410aa5d33febde44e1b2", "nullable": true }, "rates": { "type": "array", "description": "The available pick up rates.", "example": [ { "id": "pickuprate_a6cd2647a898410aa5d33febde44e1b2", "rate": "45.59", "carrier": "USPS", "service": "NextDay" } ], "nullable": false, "items": { "type": "object" } }, "instructions": { "type": "string", "description": "Additional text to help the driver successfully obtain the package, automatically enriched with parcels and package informations.", "example": "Knock loudly", "nullable": true }, "min_datetime": { "type": "string", "description": "The earliest time at which the package is available to pick up, must be larger than 2 hours from creation time.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "max_datetime": { "type": "string", "description": "The latest time at which the package is available to pick up, must be smaller than 24 hours from creation time.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "purchase_started_at": { "type": "string", "description": "Time at which the purchasing of the pick up rate started.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "purchase_completed_at": { "type": "string", "description": "Time at which the purchasing of the pick up rate completed.", "example": "2018-01-01T12:00:00.000Z", "nullable": true } } }, "relationships": { "type": "object", "properties": { "shipment": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "parcels": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "parcels" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "easypostPickupCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "easypost_pickups" ] }, "attributes": { "type": "object", "properties": { "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "instructions": { "type": "string", "description": "Additional text to help the driver successfully obtain the package, automatically enriched with parcels and package informations.", "example": "Knock loudly" }, "min_datetime": { "type": "string", "description": "The earliest time at which the package is available to pick up, must be larger than 2 hours from creation time.", "example": "2018-01-01T12:00:00.000Z" }, "max_datetime": { "type": "string", "description": "The latest time at which the package is available to pick up, must be smaller than 24 hours from creation time.", "example": "2018-01-01T12:00:00.000Z" } }, "required": [ "min_datetime", "max_datetime" ] }, "relationships": { "type": "object", "properties": { "shipment": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "shipment" ] } } } } }, "easypostPickupUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "easypost_pickups" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "selected_rate_id": { "type": "string", "description": "The selected purchase rate from the available pick up rates.", "example": "pickuprate_a6cd2647a898410aa5d33febde44e1b2", "nullable": true }, "_purchase": { "type": "boolean", "description": "Send this attribute if you want to purchase this pick up with the selected rate.", "example": true, "nullable": false } } }, "relationships": { "type": "object", "properties": { "shipment": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "easypostPickupResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "easypost_pickups" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/easypostPickup/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "shipment": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipment" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "parcels": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "parcels" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "easypostPickupResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/easypostPickupResponse/properties/data" } } } }, "eventCallback": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_callbacks" ] }, "attributes": { "type": "object", "properties": { "callback_url": { "type": "string", "description": "The URI of the callback, inherited by the associated webhook.", "example": "https://yourapp.com/webhooks", "nullable": false }, "payload": { "type": "object", "description": "The payload sent to the callback endpoint, including the event affected resource and the specified includes.", "example": { "data": { "attributes": { "id": "PYWehaoXJj", "type": "orders" } } }, "nullable": true }, "response_code": { "type": "string", "description": "The HTTP response code of the callback endpoint.", "example": "200", "nullable": true }, "response_message": { "type": "string", "description": "The HTTP response message of the callback endpoint.", "example": "OK", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "webhook": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "webhooks" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "eventCallbackResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "event_callbacks" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/eventCallback/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "webhook": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "webhook" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "eventCallbackResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/eventCallbackResponse/properties/data" } } } }, "eventStore": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "attributes": { "type": "object", "properties": { "resource_type": { "type": "string", "description": "The type of the affected resource.", "example": "orders", "nullable": true }, "resource_id": { "type": "string", "description": "The ID of the affected resource.", "example": "PzdJhdLdYV", "nullable": true }, "event": { "type": "string", "description": "The type of change (one of create or update).", "example": "update", "nullable": true }, "payload": { "type": "object", "description": "The object changes payload.", "example": { "status": [ "draft", "placed" ] }, "nullable": true }, "who": { "type": "object", "description": "Information about who triggered the change.", "example": { "application": { "id": "DNOPYiZYpn", "kind": "sales_channel", "public": true }, "owner": { "id": "yQQrBhLBmQ", "type": "Customer" } }, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "eventStoreResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "The event identifier.", "example": "1755185525941-0" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/eventStore/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { } } } } } }, "eventStoreResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/eventStoreResponse/properties/data" } } } }, "event": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The event's internal name.", "example": "orders.create", "nullable": false }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "webhooks": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "webhooks" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "last_event_callbacks": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_callbacks" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "eventUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "_trigger": { "type": "boolean", "description": "Send this attribute if you want to force webhooks execution for this event. Cannot be passed by sales channels.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "eventResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/event/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "webhooks": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "webhooks" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "last_event_callbacks": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "last_event_callbacks" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "eventResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/eventResponse/properties/data" } } } }, "export": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "exports" ] }, "attributes": { "type": "object", "properties": { "resource_type": { "type": "string", "description": "The type of resource being exported.", "example": "skus", "nullable": false }, "format": { "type": "string", "description": "The format of the export one of 'json' (default) or 'csv'.", "example": "json", "nullable": true }, "status": { "type": "string", "description": "The export job status. One of 'pending' (default), 'in_progress', 'interrupted', 'completed', or 'failed'.", "example": "in_progress", "nullable": false, "enum": [ "pending", "in_progress", "interrupted", "completed", "failed" ] }, "includes": { "type": "array", "description": "List of related resources that should be included in the export (redundant when 'fields' are specified).", "example": [ "prices.price_tiers" ], "nullable": true, "items": { "type": "string" } }, "fields": { "type": "array", "description": "List of fields to export for the main and related resources (automatically included). Pass the asterisk '*' to include all exportable fields for the main and related resources.", "example": [ "code", "name", "prices.*", "prices.price_tiers.price_amount_cents" ], "nullable": true, "items": { "type": "string" } }, "filters": { "type": "object", "description": "The filters used to select the records to be exported.", "example": { "code_eq": "AAA" }, "nullable": true }, "dry_data": { "type": "boolean", "description": "Send this attribute if you want to skip exporting redundant attributes (IDs, timestamps, blanks, etc.), useful when combining export and import to duplicate your dataset.", "example": false, "nullable": true }, "jwt_filters": { "type": "boolean", "description": "Send this attribute to apply JWT scope–based sales channel filtering to the exported data.", "example": true, "nullable": true }, "started_at": { "type": "string", "description": "Time at which the export was started.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "completed_at": { "type": "string", "description": "Time at which the export was completed.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "estimated_completion_at": { "type": "string", "description": "Estimated time at which the export should complete (dynamically refres^hed).", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "interrupted_at": { "type": "string", "description": "Time at which the export was interrupted.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "records_count": { "type": "integer", "description": "Indicates the number of records to be exported.", "example": 300, "nullable": true }, "processed_count": { "type": "integer", "description": "Indicates how many records have been processed in real time.", "example": 270, "nullable": true }, "progress": { "type": "number", "description": "The percentage of progress of the export.", "example": 30.0, "nullable": true }, "attachment_url": { "type": "string", "description": "The URL to the output file, which will be generated upon export completion.", "example": "http://cl_exports.s3.amazonaws.com/", "nullable": true }, "errors_log": { "type": "object", "description": "Contains the exports errors, if any.", "example": { "RuntimeError": "query timeout" }, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "exportCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "exports" ] }, "attributes": { "type": "object", "properties": { "resource_type": { "type": "string", "description": "The type of resource being exported.", "example": "skus" }, "format": { "type": "string", "description": "The format of the export one of 'json' (default) or 'csv'.", "example": "json" }, "includes": { "type": "array", "description": "List of related resources that should be included in the export (redundant when 'fields' are specified).", "example": [ "prices.price_tiers" ], "items": { "type": "string" } }, "fields": { "type": "array", "description": "List of fields to export for the main and related resources (automatically included). Pass the asterisk '*' to include all exportable fields for the main and related resources.", "example": [ "code", "name", "prices.*", "prices.price_tiers.price_amount_cents" ], "items": { "type": "string" } }, "filters": { "type": "object", "description": "The filters used to select the records to be exported.", "example": { "code_eq": "AAA" } }, "dry_data": { "type": "boolean", "description": "Send this attribute if you want to skip exporting redundant attributes (IDs, timestamps, blanks, etc.), useful when combining export and import to duplicate your dataset.", "example": false }, "jwt_filters": { "type": "boolean", "description": "Send this attribute to apply JWT scope–based sales channel filtering to the exported data.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "resource_type" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "exportUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "exports" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "_start": { "type": "boolean", "description": "Send this attribute if you want to restart an 'interrupted' export.", "example": true, "nullable": false }, "_interrupt": { "type": "boolean", "description": "Send this attribute if you want to mark status as 'interrupted'.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "exportResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "exports" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/export/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "exportResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/exportResponse/properties/data" } } } }, "externalGateway": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "external_gateways" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway", "nullable": false }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true, "nullable": true }, "credential_keys": { "type": "object", "description": "The payment gateway's API credential keys last digits.", "example": { "api_key": "********BW989" }, "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "circuit_state": { "type": "string", "description": "The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made.", "example": "closed", "nullable": true }, "circuit_failure_count": { "type": "integer", "description": "The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback.", "example": 5, "nullable": true }, "shared_secret": { "type": "string", "description": "The shared secret used to sign the external request payload.", "example": "1c0994cc4e996e8c6ee56a2198f66f3c", "nullable": false }, "external_includes": { "type": "array", "description": "List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.", "example": [ "order.line_item_options" ], "nullable": true, "items": { "type": "string" } }, "authorize_url": { "type": "string", "description": "The endpoint used by the external gateway to authorize payments.", "example": "https://external_gateway.com/authorize", "nullable": true }, "capture_url": { "type": "string", "description": "The endpoint used by the external gateway to capture payments.", "example": "https://external_gateway.com/capture", "nullable": true }, "void_url": { "type": "string", "description": "The endpoint used by the external gateway to void payments.", "example": "https://external_gateway.com/void", "nullable": true }, "refund_url": { "type": "string", "description": "The endpoint used by the external gateway to refund payments.", "example": "https://external_gateway.com/refund", "nullable": true }, "token_url": { "type": "string", "description": "The endpoint used by the external gateway to create a customer payment token.", "example": "https://external_gateway.com/token", "nullable": true } } }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "external_payments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "external_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "externalGatewayCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "external_gateways" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway" }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "external_includes": { "type": "array", "description": "List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.", "example": [ "order.line_item_options" ], "items": { "type": "string" } }, "authorize_url": { "type": "string", "description": "The endpoint used by the external gateway to authorize payments.", "example": "https://external_gateway.com/authorize" }, "capture_url": { "type": "string", "description": "The endpoint used by the external gateway to capture payments.", "example": "https://external_gateway.com/capture" }, "void_url": { "type": "string", "description": "The endpoint used by the external gateway to void payments.", "example": "https://external_gateway.com/void" }, "refund_url": { "type": "string", "description": "The endpoint used by the external gateway to refund payments.", "example": "https://external_gateway.com/refund" }, "token_url": { "type": "string", "description": "The endpoint used by the external gateway to create a customer payment token.", "example": "https://external_gateway.com/token" } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "externalGatewayUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "external_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway", "nullable": false }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true, "nullable": false }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "_reset_circuit": { "type": "boolean", "description": "Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.", "example": true, "nullable": false }, "external_includes": { "type": "array", "description": "List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.", "example": [ "order.line_item_options" ], "nullable": true, "items": { "type": "string" } }, "authorize_url": { "type": "string", "description": "The endpoint used by the external gateway to authorize payments.", "example": "https://external_gateway.com/authorize", "nullable": true }, "capture_url": { "type": "string", "description": "The endpoint used by the external gateway to capture payments.", "example": "https://external_gateway.com/capture", "nullable": true }, "void_url": { "type": "string", "description": "The endpoint used by the external gateway to void payments.", "example": "https://external_gateway.com/void", "nullable": true }, "refund_url": { "type": "string", "description": "The endpoint used by the external gateway to refund payments.", "example": "https://external_gateway.com/refund", "nullable": true }, "token_url": { "type": "string", "description": "The endpoint used by the external gateway to create a customer payment token.", "example": "https://external_gateway.com/token", "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "externalGatewayResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "external_gateways" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/externalGateway/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "external_payments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "external_payments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "externalGatewayResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/externalGatewayResponse/properties/data" } } } }, "externalPayment": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "external_payments" ] }, "attributes": { "type": "object", "properties": { "payment_source_token": { "type": "string", "description": "The payment source token, as generated by the external gateway SDK. Credit Card numbers are rejected.", "example": "xxxx.yyyy.zzzz", "nullable": false }, "options": { "type": "object", "description": "External payment options.", "example": { "foo": "bar" }, "nullable": true }, "payment_instrument": { "type": "object", "description": "Information about the payment instrument used in the transaction.", "example": { "issuer": "cl bank", "card_type": "visa" }, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_gateway": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "wallet": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_payment_sources" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "externalPaymentCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "external_payments" ] }, "attributes": { "type": "object", "properties": { "payment_source_token": { "type": "string", "description": "The payment source token, as generated by the external gateway SDK. Credit Card numbers are rejected.", "example": "xxxx.yyyy.zzzz" }, "options": { "type": "object", "description": "External payment options.", "example": { "foo": "bar" } }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "payment_source_token" ] }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "order" ] } } } } }, "externalPaymentUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "external_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "options": { "type": "object", "description": "External payment options.", "example": { "foo": "bar" }, "nullable": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "externalPaymentResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "external_payments" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/externalPayment/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_gateway": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateway" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "wallet": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "wallet" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "externalPaymentResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/externalPaymentResponse/properties/data" } } } }, "externalPromotion": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "external_promotions" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion", "nullable": false }, "type": { "type": "string", "description": "The promotion's type.", "example": "percentage_discount_promotions", "nullable": false, "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true, "nullable": true }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2, "nullable": true }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": false }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5, "nullable": true }, "total_usage_count": { "type": "integer", "description": "The number of times this promotion has been applied.", "example": 2, "nullable": true }, "total_usage_reached": { "type": "boolean", "description": "Indicates if the promotion has been applied the total number of allowed times.", "example": false, "nullable": true }, "active": { "type": "boolean", "description": "Indicates if the promotion is active (enabled and not expired).", "example": true, "nullable": true }, "status": { "type": "string", "description": "The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.", "example": "pending", "nullable": true, "enum": [ "disabled", "expired", "pending", "active", "inactive" ] }, "weight": { "type": "integer", "description": "The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.", "example": 112, "nullable": true }, "coupons_count": { "type": "integer", "description": "The total number of coupons created for this promotion.", "example": 2, "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "circuit_state": { "type": "string", "description": "The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made.", "example": "closed", "nullable": true }, "circuit_failure_count": { "type": "integer", "description": "The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback.", "example": 5, "nullable": true }, "shared_secret": { "type": "string", "description": "The shared secret used to sign the external request payload.", "example": "1c0994cc4e996e8c6ee56a2198f66f3c", "nullable": false }, "external_includes": { "type": "array", "description": "List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.", "example": [ "order.line_item_options" ], "nullable": true, "items": { "type": "string" } }, "promotion_url": { "type": "string", "description": "The URL to the service that will compute the discount.", "example": "https://external_promotion.yourbrand.com", "nullable": false } } }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "promotion_rules": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupons": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "skus": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "externalPromotionCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "external_promotions" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion" }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR" }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2 }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z" }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z" }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5 }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "external_includes": { "type": "array", "description": "List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.", "example": [ "order.line_item_options" ], "items": { "type": "string" } }, "promotion_url": { "type": "string", "description": "The URL to the service that will compute the discount.", "example": "https://external_promotion.yourbrand.com" } }, "required": [ "name", "starts_at", "expires_at", "promotion_url" ] }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "externalPromotionUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "external_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion", "nullable": false }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true, "nullable": false }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2, "nullable": true }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": false }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5, "nullable": true }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "_reset_circuit": { "type": "boolean", "description": "Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.", "example": true, "nullable": false }, "external_includes": { "type": "array", "description": "List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.", "example": [ "order.line_item_options" ], "nullable": true, "items": { "type": "string" } }, "promotion_url": { "type": "string", "description": "The URL to the service that will compute the discount.", "example": "https://external_promotion.yourbrand.com", "nullable": false } } }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "externalPromotionResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "external_promotions" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/externalPromotion/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "market" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "promotion_rules": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion_rules" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "order_amount_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_list_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "coupon_codes_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "custom_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_list": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "coupons": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "skus": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "externalPromotionResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/externalPromotionResponse/properties/data" } } } }, "externalTaxCalculator": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "external_tax_calculators" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax calculator's internal name.", "example": "Personal tax calculator", "nullable": false }, "type": { "type": "string", "description": "The tax calculator's type.", "example": "avalara_accounts", "nullable": false, "enum": [ "avalara_accounts", "stripe_tax_accounts", "vertex_accounts", "taxjar_accounts", "manual_tax_calculators", "external_tax_calculators" ] }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "circuit_state": { "type": "string", "description": "The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made.", "example": "closed", "nullable": true }, "circuit_failure_count": { "type": "integer", "description": "The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback.", "example": 5, "nullable": true }, "shared_secret": { "type": "string", "description": "The shared secret used to sign the external request payload.", "example": "1c0994cc4e996e8c6ee56a2198f66f3c", "nullable": false }, "external_includes": { "type": "array", "description": "List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.", "example": [ "order.line_item_options" ], "nullable": true, "items": { "type": "string" } }, "tax_calculator_url": { "type": "string", "description": "The URL to the service that will compute the taxes.", "example": "https://external_calculator.yourbrand.com", "nullable": false } } }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "externalTaxCalculatorCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "external_tax_calculators" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax calculator's internal name.", "example": "Personal tax calculator" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "external_includes": { "type": "array", "description": "List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.", "example": [ "order.line_item_options" ], "items": { "type": "string" } }, "tax_calculator_url": { "type": "string", "description": "The URL to the service that will compute the taxes.", "example": "https://external_calculator.yourbrand.com" } }, "required": [ "name", "tax_calculator_url" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "externalTaxCalculatorUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "external_tax_calculators" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax calculator's internal name.", "example": "Personal tax calculator", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "_reset_circuit": { "type": "boolean", "description": "Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.", "example": true, "nullable": false }, "external_includes": { "type": "array", "description": "List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.", "example": [ "order.line_item_options" ], "nullable": true, "items": { "type": "string" } }, "tax_calculator_url": { "type": "string", "description": "The URL to the service that will compute the taxes.", "example": "https://external_calculator.yourbrand.com", "nullable": false } } }, "relationships": { "type": "object", "properties": { } } } } } }, "externalTaxCalculatorResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "external_tax_calculators" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/externalTaxCalculator/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "externalTaxCalculatorResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/externalTaxCalculatorResponse/properties/data" } } } }, "fixedAmountPromotion": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "fixed_amount_promotions" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion", "nullable": false }, "type": { "type": "string", "description": "The promotion's type.", "example": "percentage_discount_promotions", "nullable": false, "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true, "nullable": true }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2, "nullable": true }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": false }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5, "nullable": true }, "total_usage_count": { "type": "integer", "description": "The number of times this promotion has been applied.", "example": 2, "nullable": true }, "total_usage_reached": { "type": "boolean", "description": "Indicates if the promotion has been applied the total number of allowed times.", "example": false, "nullable": true }, "active": { "type": "boolean", "description": "Indicates if the promotion is active (enabled and not expired).", "example": true, "nullable": true }, "status": { "type": "string", "description": "The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.", "example": "pending", "nullable": true, "enum": [ "disabled", "expired", "pending", "active", "inactive" ] }, "weight": { "type": "integer", "description": "The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.", "example": 112, "nullable": true }, "coupons_count": { "type": "integer", "description": "The total number of coupons created for this promotion.", "example": 2, "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "fixed_amount_cents": { "type": "integer", "description": "The discount fixed amount to be applied, in cents.", "example": 1000, "nullable": false }, "fixed_amount_float": { "type": "number", "description": "The discount fixed amount to be applied, float.", "example": 10.0, "nullable": true }, "formatted_fixed_amount": { "type": "string", "description": "The discount fixed amount to be applied, formatted.", "example": "€10,00", "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "promotion_rules": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupons": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "skus": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "fixedAmountPromotionCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "fixed_amount_promotions" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion" }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR" }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2 }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z" }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z" }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5 }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "fixed_amount_cents": { "type": "integer", "description": "The discount fixed amount to be applied, in cents.", "example": 1000 } }, "required": [ "name", "starts_at", "expires_at", "fixed_amount_cents" ] }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "fixedAmountPromotionUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "fixed_amount_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion", "nullable": false }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true, "nullable": false }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2, "nullable": true }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": false }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5, "nullable": true }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "fixed_amount_cents": { "type": "integer", "description": "The discount fixed amount to be applied, in cents.", "example": 1000, "nullable": false } } }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "fixedAmountPromotionResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "fixed_amount_promotions" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/fixedAmountPromotion/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "market" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "promotion_rules": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion_rules" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "order_amount_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_list_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "coupon_codes_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "custom_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_list": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "coupons": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "skus": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "fixedAmountPromotionResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/fixedAmountPromotionResponse/properties/data" } } } }, "fixedPricePromotion": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "fixed_price_promotions" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion", "nullable": false }, "type": { "type": "string", "description": "The promotion's type.", "example": "percentage_discount_promotions", "nullable": false, "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true, "nullable": true }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2, "nullable": true }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": false }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5, "nullable": true }, "total_usage_count": { "type": "integer", "description": "The number of times this promotion has been applied.", "example": 2, "nullable": true }, "total_usage_reached": { "type": "boolean", "description": "Indicates if the promotion has been applied the total number of allowed times.", "example": false, "nullable": true }, "active": { "type": "boolean", "description": "Indicates if the promotion is active (enabled and not expired).", "example": true, "nullable": true }, "status": { "type": "string", "description": "The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.", "example": "pending", "nullable": true, "enum": [ "disabled", "expired", "pending", "active", "inactive" ] }, "weight": { "type": "integer", "description": "The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.", "example": 112, "nullable": true }, "coupons_count": { "type": "integer", "description": "The total number of coupons created for this promotion.", "example": 2, "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "fixed_amount_cents": { "type": "integer", "description": "The price fixed amount to be applied on matching SKUs, in cents.", "example": 1000, "nullable": false }, "fixed_amount_float": { "type": "number", "description": "The discount fixed amount to be applied, float.", "example": 10.0, "nullable": true }, "formatted_fixed_amount": { "type": "string", "description": "The discount fixed amount to be applied, formatted.", "example": "€10,00", "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "promotion_rules": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupons": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "skus": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "fixedPricePromotionCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "fixed_price_promotions" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion" }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR" }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2 }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z" }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z" }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5 }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "fixed_amount_cents": { "type": "integer", "description": "The price fixed amount to be applied on matching SKUs, in cents.", "example": 1000 } }, "required": [ "name", "starts_at", "expires_at", "fixed_amount_cents" ] }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "sku_list" ] } } } } }, "fixedPricePromotionUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "fixed_price_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion", "nullable": false }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true, "nullable": false }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2, "nullable": true }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": false }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5, "nullable": true }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "fixed_amount_cents": { "type": "integer", "description": "The price fixed amount to be applied on matching SKUs, in cents.", "example": 1000, "nullable": false } } }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "fixedPricePromotionResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "fixed_price_promotions" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/fixedPricePromotion/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "market" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "promotion_rules": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion_rules" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "order_amount_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_list_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "coupon_codes_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "custom_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_list": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "coupons": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "skus": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "fixedPricePromotionResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/fixedPricePromotionResponse/properties/data" } } } }, "flexPromotion": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "flex_promotions" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion", "nullable": false }, "type": { "type": "string", "description": "The promotion's type.", "example": "percentage_discount_promotions", "nullable": false, "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true, "nullable": true }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2, "nullable": true }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": false }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5, "nullable": true }, "total_usage_count": { "type": "integer", "description": "The number of times this promotion has been applied.", "example": 2, "nullable": true }, "active": { "type": "boolean", "description": "Indicates if the promotion is active (enabled and not expired).", "example": true, "nullable": true }, "status": { "type": "string", "description": "The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.", "example": "pending", "nullable": true, "enum": [ "disabled", "expired", "pending", "active", "inactive" ] }, "rules": { "type": "object", "description": "The discount rule to be applied.", "example": { }, "nullable": false }, "rule_outcomes": { "type": "object", "description": "The rule outcomes.", "example": [ ], "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "resource_payload": { "type": "object", "description": "The payload used to evaluate the rules.", "example": { }, "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "coupon_codes_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupons": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "flexPromotionCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "flex_promotions" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion" }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2 }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z" }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z" }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5 }, "rules": { "type": "object", "description": "The discount rule to be applied.", "example": { } }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name", "starts_at", "expires_at", "rules" ] }, "relationships": { "type": "object", "properties": { "coupon_codes_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "flexPromotionUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "flex_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion", "nullable": false }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true, "nullable": false }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2, "nullable": true }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": false }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5, "nullable": true }, "rules": { "type": "object", "description": "The discount rule to be applied.", "example": { }, "nullable": false }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "coupon_codes_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "flexPromotionResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "flex_promotions" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/flexPromotion/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "coupon_codes_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "coupons": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "flexPromotionResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/flexPromotionResponse/properties/data" } } } }, "freeGiftPromotion": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "free_gift_promotions" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion", "nullable": false }, "type": { "type": "string", "description": "The promotion's type.", "example": "percentage_discount_promotions", "nullable": false, "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true, "nullable": true }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2, "nullable": true }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": false }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5, "nullable": true }, "total_usage_count": { "type": "integer", "description": "The number of times this promotion has been applied.", "example": 2, "nullable": true }, "total_usage_reached": { "type": "boolean", "description": "Indicates if the promotion has been applied the total number of allowed times.", "example": false, "nullable": true }, "active": { "type": "boolean", "description": "Indicates if the promotion is active (enabled and not expired).", "example": true, "nullable": true }, "status": { "type": "string", "description": "The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.", "example": "pending", "nullable": true, "enum": [ "disabled", "expired", "pending", "active", "inactive" ] }, "weight": { "type": "integer", "description": "The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.", "example": 112, "nullable": true }, "coupons_count": { "type": "integer", "description": "The total number of coupons created for this promotion.", "example": 2, "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "max_quantity": { "type": "integer", "description": "The max quantity of free gifts globally applicable by the promotion.", "example": 3, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "promotion_rules": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupons": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "skus": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "freeGiftPromotionCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "free_gift_promotions" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion" }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR" }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2 }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z" }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z" }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5 }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "max_quantity": { "type": "integer", "description": "The max quantity of free gifts globally applicable by the promotion.", "example": 3 } }, "required": [ "name", "starts_at", "expires_at" ] }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "sku_list" ] } } } } }, "freeGiftPromotionUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "free_gift_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion", "nullable": false }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true, "nullable": false }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2, "nullable": true }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": false }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5, "nullable": true }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "max_quantity": { "type": "integer", "description": "The max quantity of free gifts globally applicable by the promotion.", "example": 3, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "freeGiftPromotionResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "free_gift_promotions" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/freeGiftPromotion/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "market" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "promotion_rules": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion_rules" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "order_amount_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_list_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "coupon_codes_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "custom_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_list": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "coupons": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "skus": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "freeGiftPromotionResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/freeGiftPromotionResponse/properties/data" } } } }, "freeShippingPromotion": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "free_shipping_promotions" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion", "nullable": false }, "type": { "type": "string", "description": "The promotion's type.", "example": "percentage_discount_promotions", "nullable": false, "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true, "nullable": true }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2, "nullable": true }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": false }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5, "nullable": true }, "total_usage_count": { "type": "integer", "description": "The number of times this promotion has been applied.", "example": 2, "nullable": true }, "total_usage_reached": { "type": "boolean", "description": "Indicates if the promotion has been applied the total number of allowed times.", "example": false, "nullable": true }, "active": { "type": "boolean", "description": "Indicates if the promotion is active (enabled and not expired).", "example": true, "nullable": true }, "status": { "type": "string", "description": "The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.", "example": "pending", "nullable": true, "enum": [ "disabled", "expired", "pending", "active", "inactive" ] }, "weight": { "type": "integer", "description": "The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.", "example": 112, "nullable": true }, "coupons_count": { "type": "integer", "description": "The total number of coupons created for this promotion.", "example": 2, "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "promotion_rules": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupons": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "freeShippingPromotionCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "free_shipping_promotions" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion" }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR" }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2 }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z" }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z" }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5 }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name", "starts_at", "expires_at" ] }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "freeShippingPromotionUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "free_shipping_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion", "nullable": false }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true, "nullable": false }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2, "nullable": true }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": false }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5, "nullable": true }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "freeShippingPromotionResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "free_shipping_promotions" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/freeShippingPromotion/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "market" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "promotion_rules": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion_rules" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "order_amount_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_list_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "coupon_codes_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "custom_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_list": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "coupons": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "freeShippingPromotionResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/freeShippingPromotionResponse/properties/data" } } } }, "geocoder": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "geocoders" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The geocoder's internal name.", "example": "Default geocoder", "nullable": false }, "type": { "type": "string", "description": "The geocoder's type.", "example": "google_geocoders", "nullable": false, "enum": [ "google_geocoders", "bing_geocoders" ] }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "addresses": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "geocoderResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "geocoders" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/geocoder/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "addresses": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "geocoderResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/geocoderResponse/properties/data" } } } }, "giftCardRecipient": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "gift_card_recipients" ] }, "attributes": { "type": "object", "properties": { "email": { "type": "string", "description": "The recipient email address.", "example": "john@example.com", "nullable": false }, "first_name": { "type": "string", "description": "The recipient first name.", "example": "John", "nullable": true }, "last_name": { "type": "string", "description": "The recipient last name.", "example": "Smith", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "customer": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "giftCardRecipientCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "gift_card_recipients" ] }, "attributes": { "type": "object", "properties": { "email": { "type": "string", "description": "The recipient email address.", "example": "john@example.com" }, "first_name": { "type": "string", "description": "The recipient first name.", "example": "John" }, "last_name": { "type": "string", "description": "The recipient last name.", "example": "Smith" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "email" ] }, "relationships": { "type": "object", "properties": { "customer": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "giftCardRecipientUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "gift_card_recipients" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "email": { "type": "string", "description": "The recipient email address.", "example": "john@example.com", "nullable": false }, "first_name": { "type": "string", "description": "The recipient first name.", "example": "John", "nullable": true }, "last_name": { "type": "string", "description": "The recipient last name.", "example": "Smith", "nullable": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "customer": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "giftCardRecipientResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "gift_card_recipients" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/giftCardRecipient/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "customer": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "giftCardRecipientResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/giftCardRecipientResponse/properties/data" } } } }, "giftCard": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "gift_cards" ] }, "attributes": { "type": "object", "properties": { "status": { "type": "string", "description": "The gift card status. One of 'draft' (default), 'inactive', 'active', or 'redeemed'.", "example": "draft", "nullable": false, "enum": [ "draft", "inactive", "active", "redeemed" ] }, "code": { "type": "string", "description": "The gift card code UUID. If not set, it's automatically generated.", "example": "32db311a-75d9-4c17-9e34-2be220137ad6", "nullable": true }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "initial_balance_cents": { "type": "integer", "description": "The gift card initial balance, in cents.", "example": 15000, "nullable": false }, "initial_balance_float": { "type": "number", "description": "The gift card initial balance, float.", "example": 150.0, "nullable": false }, "formatted_initial_balance": { "type": "string", "description": "The gift card initial balance, formatted.", "example": "€150,00", "nullable": false }, "balance_cents": { "type": "integer", "description": "The gift card balance, in cents.", "example": 15000, "nullable": false }, "balance_float": { "type": "number", "description": "The gift card balance, float.", "example": 150.0, "nullable": false }, "formatted_balance": { "type": "string", "description": "The gift card balance, formatted.", "example": "€150,00", "nullable": false }, "balance_max_cents": { "type": "integer", "description": "The gift card balance max, in cents.", "example": 100000, "nullable": true }, "balance_max_float": { "type": "number", "description": "The gift card balance max, float.", "example": 1000.0, "nullable": true }, "formatted_balance_max": { "type": "string", "description": "The gift card balance max, formatted.", "example": "€1000,00", "nullable": true }, "balance_log": { "type": "array", "description": "The gift card balance log. Tracks all the gift card transactions.", "example": [ { "datetime": "2019-12-23T12:00:00.000Z", "balance_change_cents": -10000 }, { "datetime": "2020-02-01T12:00:00.000Z", "balance_change_cents": 5000 } ], "nullable": false, "items": { "type": "object" } }, "usage_log": { "type": "object", "description": "The gift card usage log. Tracks all the gift card usage actions by orders.", "example": { "eNoKkhmbNp": [ { "action": "use", "amount_cents": -1000, "balance_cents": 4000, "order_number": "11111", "datetime": "2020-02-01T12:00:00.000Z" } ] }, "nullable": false }, "single_use": { "type": "boolean", "description": "Indicates if the gift card can be used only one.", "example": false, "nullable": true }, "rechargeable": { "type": "boolean", "description": "Indicates if the gift card can be recharged.", "example": true, "nullable": true }, "distribute_discount": { "type": "boolean", "description": "Indicates if redeemed gift card amount is distributed for tax calculation.", "example": true, "nullable": true }, "image_url": { "type": "string", "description": "The URL of an image that represents the gift card.", "example": "https://img.yourdomain.com/gift_cards/32db311a.png", "nullable": true }, "expires_at": { "type": "string", "description": "Time at which the gift card will expire.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "recipient_email": { "type": "string", "description": "The email address of the associated recipient. When creating or updating a gift card, this is a shortcut to find or create the associated recipient by email.", "example": "john@example.com", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "gift_card_recipient": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "gift_card_recipients" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "giftCardCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "gift_cards" ] }, "attributes": { "type": "object", "properties": { "code": { "type": "string", "description": "The gift card code UUID. If not set, it's automatically generated.", "example": "32db311a-75d9-4c17-9e34-2be220137ad6" }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR" }, "balance_cents": { "type": "integer", "description": "The gift card balance, in cents.", "example": 15000 }, "balance_max_cents": { "type": "integer", "description": "The gift card balance max, in cents.", "example": 100000 }, "single_use": { "type": "boolean", "description": "Indicates if the gift card can be used only one.", "example": false }, "rechargeable": { "type": "boolean", "description": "Indicates if the gift card can be recharged.", "example": true }, "distribute_discount": { "type": "boolean", "description": "Indicates if redeemed gift card amount is distributed for tax calculation.", "example": true }, "image_url": { "type": "string", "description": "The URL of an image that represents the gift card.", "example": "https://img.yourdomain.com/gift_cards/32db311a.png" }, "expires_at": { "type": "string", "description": "Time at which the gift card will expire.", "example": "2018-01-01T12:00:00.000Z" }, "recipient_email": { "type": "string", "description": "The email address of the associated recipient. When creating or updating a gift card, this is a shortcut to find or create the associated recipient by email.", "example": "john@example.com" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "balance_cents" ] }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "gift_card_recipient": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "gift_card_recipients" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "giftCardUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "gift_cards" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "balance_cents": { "type": "integer", "description": "The gift card balance, in cents.", "example": 15000, "nullable": false }, "balance_max_cents": { "type": "integer", "description": "The gift card balance max, in cents.", "example": 100000, "nullable": true }, "single_use": { "type": "boolean", "description": "Indicates if the gift card can be used only one.", "example": false, "nullable": false }, "rechargeable": { "type": "boolean", "description": "Indicates if the gift card can be recharged.", "example": true, "nullable": false }, "distribute_discount": { "type": "boolean", "description": "Indicates if redeemed gift card amount is distributed for tax calculation.", "example": true, "nullable": false }, "image_url": { "type": "string", "description": "The URL of an image that represents the gift card.", "example": "https://img.yourdomain.com/gift_cards/32db311a.png", "nullable": true }, "expires_at": { "type": "string", "description": "Time at which the gift card will expire.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "recipient_email": { "type": "string", "description": "The email address of the associated recipient. When creating or updating a gift card, this is a shortcut to find or create the associated recipient by email.", "example": "john@example.com", "nullable": true }, "_purchase": { "type": "boolean", "description": "Send this attribute if you want to confirm a draft gift card. The gift card becomes 'inactive', waiting to be activated.", "example": true, "nullable": false }, "_activate": { "type": "boolean", "description": "Send this attribute if you want to activate a gift card.", "example": true, "nullable": false }, "_deactivate": { "type": "boolean", "description": "Send this attribute if you want to deactivate a gift card.", "example": true, "nullable": false }, "_balance_change_cents": { "type": "integer", "description": "The balance change, in cents. Send a negative value to reduces the card balance by the specified amount. Send a positive value to recharge the gift card (if rechargeable).", "example": -5000 }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "gift_card_recipient": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "gift_card_recipients" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "giftCardResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "gift_cards" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/giftCard/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "market" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "gift_card_recipient": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "gift_card_recipient" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "giftCardResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/giftCardResponse/properties/data" } } } }, "googleGeocoder": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "google_geocoders" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The geocoder's internal name.", "example": "Default geocoder", "nullable": false }, "type": { "type": "string", "description": "The geocoder's type.", "example": "google_geocoders", "nullable": false, "enum": [ "google_geocoders", "bing_geocoders" ] }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "addresses": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "googleGeocoderCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "google_geocoders" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The geocoder's internal name.", "example": "Default geocoder" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "api_key": { "type": "string", "description": "The Google Map API key.", "example": "xxxx-yyyy-zzzz" } }, "required": [ "name", "api_key" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "googleGeocoderUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "google_geocoders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The geocoder's internal name.", "example": "Default geocoder", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "api_key": { "type": "string", "description": "The Google Map API key.", "example": "xxxx-yyyy-zzzz" } } }, "relationships": { "type": "object", "properties": { } } } } } }, "googleGeocoderResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "google_geocoders" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/googleGeocoder/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "addresses": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "googleGeocoderResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/googleGeocoderResponse/properties/data" } } } }, "import": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "imports" ] }, "attributes": { "type": "object", "properties": { "resource_type": { "type": "string", "description": "The type of resource being imported.", "example": "skus", "nullable": false }, "format": { "type": "string", "description": "The format of the import inputs one of 'json' (default) or 'csv'.", "example": "json", "nullable": true }, "parent_resource_id": { "type": "string", "description": "The ID of the parent resource to be associated with imported data.", "example": "1234", "nullable": true }, "status": { "type": "string", "description": "The import job status. One of 'pending' (default), 'in_progress', 'interrupted', or 'completed'.", "example": "in_progress", "nullable": false, "enum": [ "pending", "in_progress", "interrupted", "completed" ] }, "started_at": { "type": "string", "description": "Time at which the import was started.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "completed_at": { "type": "string", "description": "Time at which the import was completed.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "interrupted_at": { "type": "string", "description": "Time at which the import was interrupted.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "inputs": { "type": "array", "description": "Array of objects representing the resources that are being imported.", "example": [ { "code": "ABC", "name": "Foo" }, { "code": "DEF", "name": "Bar" } ], "nullable": false, "items": { "type": "object" } }, "inputs_size": { "type": "integer", "description": "Indicates the size of the objects to be imported.", "example": 300, "nullable": true }, "errors_count": { "type": "integer", "description": "Indicates the number of import errors, if any.", "example": 30, "nullable": true }, "warnings_count": { "type": "integer", "description": "Indicates the number of import warnings, if any.", "example": 1, "nullable": true }, "processed_count": { "type": "integer", "description": "Indicates the number of records that have been processed (created or updated).", "example": 270, "nullable": true }, "errors_log": { "type": "object", "description": "Contains the import errors, if any.", "example": { "ABC": { "name": [ "has already been taken" ] } }, "nullable": true }, "warnings_log": { "type": "object", "description": "Contains the import warnings, if any.", "example": { "ABC": [ "could not be deleted" ] }, "nullable": true }, "skip_errors": { "type": "boolean", "description": "Disables the interruption of the import in case its errors exceeds the 10% threshold.", "example": true, "nullable": true }, "attachment_url": { "type": "string", "description": "The URL the the raw inputs file, which will be generated at import start.", "example": "http://cl_imports.s3.amazonaws.com/", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "importCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "imports" ] }, "attributes": { "type": "object", "properties": { "resource_type": { "type": "string", "description": "The type of resource being imported.", "example": "skus" }, "format": { "type": "string", "description": "The format of the import inputs one of 'json' (default) or 'csv'.", "example": "json" }, "parent_resource_id": { "type": "string", "description": "The ID of the parent resource to be associated with imported data.", "example": "1234" }, "inputs": { "type": "array", "description": "Array of objects representing the resources that are being imported.", "example": [ { "code": "ABC", "name": "Foo" }, { "code": "DEF", "name": "Bar" } ], "items": { "type": "object" } }, "skip_errors": { "type": "boolean", "description": "Disables the interruption of the import in case its errors exceeds the 10% threshold.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "resource_type", "inputs" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "importUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "imports" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "_interrupt": { "type": "boolean", "description": "Send this attribute if you want to mark status as 'interrupted'.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "importResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "imports" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/import/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "importResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/importResponse/properties/data" } } } }, "inStockSubscription": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "in_stock_subscriptions" ] }, "attributes": { "type": "object", "properties": { "status": { "type": "string", "description": "The subscription status. One of 'active' (default), 'inactive', or 'notified'.", "example": "active", "nullable": false, "enum": [ "active", "inactive", "notified" ] }, "customer_email": { "type": "string", "description": "The email of the associated customer, replace the relationship.", "example": "john@example.com", "nullable": true }, "sku_code": { "type": "string", "description": "The code of the associated SKU, replace the relationship.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": true }, "stock_threshold": { "type": "integer", "description": "The threshold at which to trigger the back in stock notification.", "example": 3, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "customer": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "inStockSubscriptionCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "in_stock_subscriptions" ] }, "attributes": { "type": "object", "properties": { "customer_email": { "type": "string", "description": "The email of the associated customer, replace the relationship.", "example": "john@example.com" }, "sku_code": { "type": "string", "description": "The code of the associated SKU, replace the relationship.", "example": "TSHIRTMM000000FFFFFFXLXX" }, "stock_threshold": { "type": "integer", "description": "The threshold at which to trigger the back in stock notification.", "example": 3 }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } } }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "customer": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "market", "customer", "sku" ] } } } } }, "inStockSubscriptionUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "in_stock_subscriptions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "sku_code": { "type": "string", "description": "The code of the associated SKU, replace the relationship.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": true }, "stock_threshold": { "type": "integer", "description": "The threshold at which to trigger the back in stock notification.", "example": 3, "nullable": true }, "_activate": { "type": "boolean", "description": "Send this attribute if you want to activate an inactive subscription.", "example": true, "nullable": false }, "_deactivate": { "type": "boolean", "description": "Send this attribute if you want to dactivate an active subscription.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "customer": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "inStockSubscriptionResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "in_stock_subscriptions" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/inStockSubscription/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "market" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "customer": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "inStockSubscriptionResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/inStockSubscriptionResponse/properties/data" } } } }, "inventoryModel": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_models" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The inventory model's internal name.", "example": "EU Inventory Model", "nullable": false }, "strategy": { "type": "string", "description": "The inventory model's shipping strategy: one between 'no_split' (default), 'split_shipments', 'ship_from_primary' and 'ship_from_first_available_or_primary'.", "example": "no_split", "nullable": true }, "stock_locations_cutoff": { "type": "integer", "description": "The maximum number of stock locations used for inventory computation.", "example": 3, "nullable": true }, "stock_reservation_cutoff": { "type": "integer", "description": "The duration in seconds of the generated stock reservations.", "example": 3600, "nullable": true }, "put_stock_transfers_on_hold": { "type": "boolean", "description": "Indicates if the the stock transfers must be put on hold automatically with the associated shipment.", "example": true, "nullable": true }, "manual_stock_decrement": { "type": "boolean", "description": "Indicates if the the stock will be decremented manually after the order approval.", "example": true, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "inventory_stock_locations": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "inventory_return_locations": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_return_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "inventoryModelCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_models" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The inventory model's internal name.", "example": "EU Inventory Model" }, "strategy": { "type": "string", "description": "The inventory model's shipping strategy: one between 'no_split' (default), 'split_shipments', 'ship_from_primary' and 'ship_from_first_available_or_primary'.", "example": "no_split" }, "stock_locations_cutoff": { "type": "integer", "description": "The maximum number of stock locations used for inventory computation.", "example": 3 }, "stock_reservation_cutoff": { "type": "integer", "description": "The duration in seconds of the generated stock reservations.", "example": 3600 }, "put_stock_transfers_on_hold": { "type": "boolean", "description": "Indicates if the the stock transfers must be put on hold automatically with the associated shipment.", "example": true }, "manual_stock_decrement": { "type": "boolean", "description": "Indicates if the the stock will be decremented manually after the order approval.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "inventoryModelUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_models" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The inventory model's internal name.", "example": "EU Inventory Model", "nullable": false }, "strategy": { "type": "string", "description": "The inventory model's shipping strategy: one between 'no_split' (default), 'split_shipments', 'ship_from_primary' and 'ship_from_first_available_or_primary'.", "example": "no_split", "nullable": true }, "stock_locations_cutoff": { "type": "integer", "description": "The maximum number of stock locations used for inventory computation.", "example": 3, "nullable": true }, "stock_reservation_cutoff": { "type": "integer", "description": "The duration in seconds of the generated stock reservations.", "example": 3600, "nullable": true }, "put_stock_transfers_on_hold": { "type": "boolean", "description": "Indicates if the the stock transfers must be put on hold automatically with the associated shipment.", "example": true, "nullable": false }, "manual_stock_decrement": { "type": "boolean", "description": "Indicates if the the stock will be decremented manually after the order approval.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "inventoryModelResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_models" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/inventoryModel/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "inventory_stock_locations": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_stock_locations" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "inventory_return_locations": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_return_locations" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "inventoryModelResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/inventoryModelResponse/properties/data" } } } }, "inventoryReturnLocation": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_return_locations" ] }, "attributes": { "type": "object", "properties": { "priority": { "type": "integer", "description": "The inventory return location priority within the associated invetory model.", "example": 1, "nullable": false }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "stock_location": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "inventory_model": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_models" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "inventoryReturnLocationCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_return_locations" ] }, "attributes": { "type": "object", "properties": { "priority": { "type": "integer", "description": "The inventory return location priority within the associated invetory model.", "example": 1 }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "priority" ] }, "relationships": { "type": "object", "properties": { "stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "inventory_model": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_models" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "stock_location", "inventory_model" ] } } } } }, "inventoryReturnLocationUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_return_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "priority": { "type": "integer", "description": "The inventory return location priority within the associated invetory model.", "example": 1, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "inventory_model": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_models" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "inventoryReturnLocationResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_return_locations" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/inventoryReturnLocation/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "stock_location": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_location" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "inventory_model": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_model" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "inventoryReturnLocationResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/inventoryReturnLocationResponse/properties/data" } } } }, "inventoryStockLocation": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_stock_locations" ] }, "attributes": { "type": "object", "properties": { "priority": { "type": "integer", "description": "The stock location priority within the associated invetory model.", "example": 1, "nullable": false }, "on_hold": { "type": "boolean", "description": "Indicates if the shipment should be put on hold if fulfilled from the associated stock location. This is useful to manage use cases like back-orders, pre-orders or personalized orders that need to be customized before being fulfilled.", "example": false, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "stock_location": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "inventory_model": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_models" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "inventoryStockLocationCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_stock_locations" ] }, "attributes": { "type": "object", "properties": { "priority": { "type": "integer", "description": "The stock location priority within the associated invetory model.", "example": 1 }, "on_hold": { "type": "boolean", "description": "Indicates if the shipment should be put on hold if fulfilled from the associated stock location. This is useful to manage use cases like back-orders, pre-orders or personalized orders that need to be customized before being fulfilled.", "example": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "priority" ] }, "relationships": { "type": "object", "properties": { "stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "inventory_model": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_models" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "stock_location", "inventory_model" ] } } } } }, "inventoryStockLocationUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "priority": { "type": "integer", "description": "The stock location priority within the associated invetory model.", "example": 1, "nullable": false }, "on_hold": { "type": "boolean", "description": "Indicates if the shipment should be put on hold if fulfilled from the associated stock location. This is useful to manage use cases like back-orders, pre-orders or personalized orders that need to be customized before being fulfilled.", "example": false, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "inventory_model": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_models" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "inventoryStockLocationResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_stock_locations" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/inventoryStockLocation/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "stock_location": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_location" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "inventory_model": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_model" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "inventoryStockLocationResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/inventoryStockLocationResponse/properties/data" } } } }, "klarnaGateway": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "klarna_gateways" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway", "nullable": false }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true, "nullable": true }, "credential_keys": { "type": "object", "description": "The payment gateway's API credential keys last digits.", "example": { "api_key": "********BW989" }, "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "klarna_payments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "klarna_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "klarnaGatewayCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "klarna_gateways" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway" }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "country_code": { "type": "string", "description": "The gateway country code one of EU, US, or OC.", "example": "EU" }, "api_key": { "type": "string", "description": "The public key linked to your API credential.", "example": "xxxx-yyyy-zzzz" }, "api_secret": { "type": "string", "description": "The gateway API key.", "example": "xxxx-yyyy-zzzz" } }, "required": [ "name", "country_code", "api_key", "api_secret" ] }, "relationships": { "type": "object", "properties": { "klarna_payments": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "klarna_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "klarnaGatewayUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "klarna_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway", "nullable": false }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true, "nullable": false }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "country_code": { "type": "string", "description": "The gateway country code one of EU, US, or OC.", "example": "EU" }, "api_key": { "type": "string", "description": "The public key linked to your API credential.", "example": "xxxx-yyyy-zzzz" }, "api_secret": { "type": "string", "description": "The gateway API key.", "example": "xxxx-yyyy-zzzz" } } }, "relationships": { "type": "object", "properties": { "klarna_payments": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "klarna_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "klarnaGatewayResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "klarna_gateways" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/klarnaGateway/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "klarna_payments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "klarna_payments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "klarnaGatewayResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/klarnaGatewayResponse/properties/data" } } } }, "klarnaPayment": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "klarna_payments" ] }, "attributes": { "type": "object", "properties": { "session_id": { "type": "string", "description": "The identifier of the payment session.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "client_token": { "type": "string", "description": "The public token linked to your API credential. Available upon session creation.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "payment_methods": { "type": "array", "description": "The merchant available payment methods for the assoiated order. Available upon session creation.", "example": [ { "foo": "bar" } ], "nullable": false, "items": { "type": "object" } }, "auth_token": { "type": "string", "description": "The token returned by a successful client authorization, mandatory to place the order.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "mismatched_amounts": { "type": "boolean", "description": "Indicates if the order current amount differs form the one of the created payment intent.", "example": false, "nullable": true }, "payment_instrument": { "type": "object", "description": "Information about the payment instrument used in the transaction.", "example": { "issuer": "cl bank", "card_type": "visa" }, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_gateway": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "klarnaPaymentCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "klarna_payments" ] }, "attributes": { "type": "object", "properties": { "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } } }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "order" ] } } } } }, "klarnaPaymentUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "klarna_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "auth_token": { "type": "string", "description": "The token returned by a successful client authorization, mandatory to place the order.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "_update": { "type": "boolean", "description": "Send this attribute if you want to update the payment session with fresh order data.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "klarnaPaymentResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "klarna_payments" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/klarnaPayment/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_gateway": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateway" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "klarnaPaymentResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/klarnaPaymentResponse/properties/data" } } } }, "lineItemOption": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_item_options" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the line item option. When blank, it gets populated with the name of the associated SKU option.", "example": "Embossing", "nullable": true }, "quantity": { "type": "integer", "description": "The line item option's quantity.", "example": 2, "nullable": false }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard, automatically inherited from the order's market.", "example": "EUR", "nullable": true }, "unit_amount_cents": { "type": "integer", "description": "The unit amount of the line item option, in cents. When you add a line item option to an order, this is automatically populated from associated SKU option's price. Cannot be passed by sales channels.", "example": 990, "nullable": true }, "unit_amount_float": { "type": "number", "description": "The unit amount of the line item option, float. This can be useful to track the purchase on thrid party systems, e.g Google Analyitcs Enhanced Ecommerce.", "example": 9.9, "nullable": true }, "formatted_unit_amount": { "type": "string", "description": "The unit amount of the line item option, formatted. This can be useful to display the amount with currency in you views.", "example": "€9,90", "nullable": true }, "total_amount_cents": { "type": "integer", "description": "The unit amount x quantity, in cents.", "example": 1880, "nullable": true }, "total_amount_float": { "type": "number", "description": "The unit amount x quantity, float. This can be useful to track the purchase on thrid party systems, e.g Google Analyitcs Enhanced Ecommerce.", "example": 18.8, "nullable": false }, "formatted_total_amount": { "type": "string", "description": "The unit amount x quantity, formatted. This can be useful to display the amount with currency in you views.", "example": "€18,80", "nullable": true }, "delay_hours": { "type": "integer", "description": "The shipping delay that the customer can expect when adding this option (hours). Inherited from the associated SKU option.", "example": 48, "nullable": true }, "delay_days": { "type": "integer", "description": "The shipping delay that the customer can expect when adding this option (days, rounded).", "example": 2, "nullable": true }, "options": { "type": "object", "description": "Set of key-value pairs that represent the selected options.", "example": { "embossing_text": "Happy Birthday!" }, "nullable": false }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "line_item": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_option": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_options" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "lineItemOptionCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_item_options" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the line item option. When blank, it gets populated with the name of the associated SKU option.", "example": "Embossing" }, "quantity": { "type": "integer", "description": "The line item option's quantity.", "example": 2 }, "unit_amount_cents": { "type": "integer", "description": "The unit amount of the line item option, in cents. When you add a line item option to an order, this is automatically populated from associated SKU option's price. Cannot be passed by sales channels.", "example": 990 }, "options": { "type": "object", "description": "Set of key-value pairs that represent the selected options.", "example": { "embossing_text": "Happy Birthday!" } }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "quantity", "options" ] }, "relationships": { "type": "object", "properties": { "line_item": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_option": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_options" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "line_item", "sku_option" ] } } } } }, "lineItemOptionUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_item_options" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the line item option. When blank, it gets populated with the name of the associated SKU option.", "example": "Embossing", "nullable": true }, "quantity": { "type": "integer", "description": "The line item option's quantity.", "example": 2, "nullable": false }, "unit_amount_cents": { "type": "integer", "description": "The unit amount of the line item option, in cents. When you add a line item option to an order, this is automatically populated from associated SKU option's price. Cannot be passed by sales channels.", "example": 990, "nullable": true }, "options": { "type": "object", "description": "Set of key-value pairs that represent the selected options.", "example": { "embossing_text": "Happy Birthday!" }, "nullable": false }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "sku_option": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_options" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "lineItemOptionResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "line_item_options" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/lineItemOption/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "line_item": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_item" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_option": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_option" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "lineItemOptionResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/lineItemOptionResponse/properties/data" } } } }, "lineItem": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items" ] }, "attributes": { "type": "object", "properties": { "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": true }, "bundle_code": { "type": "string", "description": "The code of the associated bundle.", "example": "BUNDLEMM000000FFFFFFXLXX", "nullable": true }, "quantity": { "type": "integer", "description": "The line item quantity.", "example": 4, "nullable": false }, "_external_price": { "type": "boolean", "description": "When creating or updating a new line item, set this attribute to '1' if you want to inject the unit_amount_cents price from an external source. Any successive price computation will be done externally, until the attribute is reset to '0'.", "example": true, "nullable": true }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard, automatically inherited from the order's market.", "example": "EUR", "nullable": true }, "unit_amount_cents": { "type": "integer", "description": "The unit amount of the line item, in cents. Can be specified only via an integration application, or when the item is missing, otherwise is automatically computed by using one of the available methods. Cannot be passed by sales channels.", "example": 10000, "nullable": true }, "unit_amount_float": { "type": "number", "description": "The unit amount of the line item, float. This can be useful to track the purchase on thrid party systems, e.g Google Analyitcs Enhanced Ecommerce.", "example": 100.0, "nullable": true }, "formatted_unit_amount": { "type": "string", "description": "The unit amount of the line item, formatted. This can be useful to display the amount with currency in you views.", "example": "€100,00", "nullable": true }, "compare_at_amount_cents": { "type": "integer", "description": "The compared price amount, in cents. Useful to display a percentage discount.", "example": 13000, "nullable": true }, "compare_at_amount_float": { "type": "number", "description": "The compared price amount, float.", "example": 130.0, "nullable": true }, "formatted_compare_at_amount": { "type": "string", "description": "The compared price amount, formatted.", "example": "€130,00", "nullable": true }, "options_amount_cents": { "type": "integer", "description": "The options amount of the line item, in cents. Cannot be passed by sales channels.", "example": 1000, "nullable": true }, "options_amount_float": { "type": "number", "description": "The options amount of the line item, float.", "example": 10.0, "nullable": true }, "formatted_options_amount": { "type": "string", "description": "The options amount of the line item, formatted.", "example": "€10,00", "nullable": true }, "discount_cents": { "type": "integer", "description": "The discount applied to the line item, in cents. When you apply a discount to an order, this is automatically calculated basing on the line item total_amount_cents value.", "example": -1000, "nullable": true }, "discount_float": { "type": "number", "description": "The discount applied to the line item, float. When you apply a discount to an order, this is automatically calculated basing on the line item total_amount_cents value.", "example": 10.0, "nullable": true }, "formatted_discount": { "type": "string", "description": "The discount applied to the line item, fromatted. When you apply a discount to an order, this is automatically calculated basing on the line item total_amount_cents value.", "example": "€10,00", "nullable": true }, "total_amount_cents": { "type": "integer", "description": "Calculated as unit amount x quantity + options amount, in cents.", "example": 18800, "nullable": true }, "total_amount_float": { "type": "number", "description": "Calculated as unit amount x quantity + options amount, float. This can be useful to track the purchase on thrid party systems, e.g Google Analyitcs Enhanced Ecommerce.", "example": 188.0, "nullable": false }, "formatted_total_amount": { "type": "string", "description": "Calculated as unit amount x quantity + options amount, formatted. This can be useful to display the amount with currency in you views.", "example": "€188,00", "nullable": true }, "tax_amount_cents": { "type": "integer", "description": "The collected tax amount, otherwise calculated as total amount cents - discount cent * tax rate, in cents.", "example": 1880, "nullable": true }, "tax_amount_float": { "type": "number", "description": "The collected tax amount, otherwise calculated as total amount cents - discount cent * tax rate, float.", "example": 18.8, "nullable": false }, "formatted_tax_amount": { "type": "string", "description": "The collected tax amount, otherwise calculated as total amount cents - discount cent * tax rate, formatted.", "example": "€18,80", "nullable": true }, "name": { "type": "string", "description": "The name of the line item. When blank, it gets populated with the name of the associated item (if present).", "example": "Men's Black T-shirt with White Logo (XL)", "nullable": true }, "image_url": { "type": "string", "description": "The image_url of the line item. When blank, it gets populated with the image_url of the associated item (if present, SKU only).", "example": "https://img.yourdomain.com/skus/xYZkjABcde.png", "nullable": true }, "discount_breakdown": { "type": "object", "description": "The discount breakdown for this line item (if calculated).", "example": { "41": { "name": "10% ALL", "cents": -900, "weight": 0.416, "coupon_code": "XXXXXXXX" } }, "nullable": true }, "tax_rate": { "type": "number", "description": "The tax rate for this line item (if calculated).", "example": 0.22, "nullable": true }, "tax_breakdown": { "type": "object", "description": "The tax breakdown for this line item (if calculated).", "example": { "id": "1234", "city_amount": "0.0", "state_amount": 6.6, "city_tax_rate": 0.0, "county_amount": 2.78, "taxable_amount": 139.0, "county_tax_rate": 0.02, "tax_collectable": 10.08, "special_tax_rate": 0.005, "combined_tax_rate": 0.0725, "city_taxable_amount": 0.0, "state_sales_tax_rate": 0.0475, "state_taxable_amount": 139.0, "county_taxable_amount": 139.0, "special_district_amount": 0.7, "special_district_taxable_amount": 139.0 }, "nullable": true }, "item_type": { "type": "string", "description": "The type of the associated item. One of 'skus', 'bundles', 'gift_cards', 'shipments', 'payment_methods', 'adjustments', 'discount_engine_items', 'percentage_discount_promotions', 'free_shipping_promotions', 'buy_x_pay_y_promotions', 'free_gift_promotions', 'fixed_price_promotions', 'external_promotions', 'fixed_amount_promotions', or 'flex_promotions'.", "example": "skus", "nullable": true, "enum": [ "skus", "bundles", "gift_cards", "shipments", "payment_methods", "adjustments", "discount_engine_items", "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "frequency": { "type": "string", "description": "The frequency which generates a subscription. Must be supported by existing associated subscription_model.", "example": "monthly", "nullable": true }, "coupon_code": { "type": "string", "description": "The coupon code, if any, used to trigger this promotion line item. null for other line item types or if the promotion line item wasn't triggered by a coupon.", "example": "SUMMERDISCOUNT", "nullable": true }, "rule_outcomes": { "type": "object", "description": "The rule outcomes.", "example": [ ], "nullable": true }, "circuit_state": { "type": "string", "description": "The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made.", "example": "closed", "nullable": true }, "circuit_failure_count": { "type": "integer", "description": "The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback.", "example": 5, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "item": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus", "bundles", "gift_cards", "shipments", "payment_methods", "adjustments", "discount_engine_items", "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/sku" }, { "$ref": "#/components/schemas/bundle" }, { "$ref": "#/components/schemas/giftCard" }, { "$ref": "#/components/schemas/shipment" }, { "$ref": "#/components/schemas/paymentMethod" }, { "$ref": "#/components/schemas/adjustment" }, { "$ref": "#/components/schemas/discountEngineItem" }, { "$ref": "#/components/schemas/percentageDiscountPromotion" }, { "$ref": "#/components/schemas/freeShippingPromotion" }, { "$ref": "#/components/schemas/buyXPayYPromotion" }, { "$ref": "#/components/schemas/freeGiftPromotion" }, { "$ref": "#/components/schemas/fixedPricePromotion" }, { "$ref": "#/components/schemas/externalPromotion" }, { "$ref": "#/components/schemas/fixedAmountPromotion" }, { "$ref": "#/components/schemas/flexPromotion" } ] }, "sku": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "bundle": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "bundles" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "adjustment": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adjustments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "gift_card": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "gift_cards" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipment": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_method": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "line_item_options": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_item_options" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "return_line_items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "return_line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_reservations": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_reservations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_line_items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_transfers": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_transfers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "notifications": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "notifications" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "lineItemCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items" ] }, "attributes": { "type": "object", "properties": { "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX" }, "bundle_code": { "type": "string", "description": "The code of the associated bundle.", "example": "BUNDLEMM000000FFFFFFXLXX" }, "quantity": { "type": "integer", "description": "The line item quantity.", "example": 4 }, "_external_price": { "type": "boolean", "description": "When creating or updating a new line item, set this attribute to '1' if you want to inject the unit_amount_cents price from an external source. Any successive price computation will be done externally, until the attribute is reset to '0'.", "example": true }, "_update_quantity": { "type": "boolean", "description": "When creating a new line item, set this attribute to '1' if you want to update the line item quantity (if present) instead of creating a new line item for the same SKU.", "example": true }, "_reserve_stock": { "type": "boolean", "description": "Send this attribute if you want to reserve the stock for the line item's SKUs quantity. Stock reservations expiration depends on the inventory model's cutoff. When used on update the existing active stock reservations are renewed. Cannot be passed by sales channels.", "example": true }, "_reset_restocked_quantity": { "type": "boolean", "description": "Send this attribute if you want to reset the quantity restocked by a return or by an order/shipment cancel. This will allow for multiple returns, albeit you need to adjust the stock manually. Cannot be passed by sales channels.", "example": true }, "unit_amount_cents": { "type": "integer", "description": "The unit amount of the line item, in cents. Can be specified only via an integration application, or when the item is missing, otherwise is automatically computed by using one of the available methods. Cannot be passed by sales channels.", "example": 10000 }, "compare_at_amount_cents": { "type": "integer", "description": "The compared price amount, in cents. Useful to display a percentage discount.", "example": 13000 }, "name": { "type": "string", "description": "The name of the line item. When blank, it gets populated with the name of the associated item (if present).", "example": "Men's Black T-shirt with White Logo (XL)" }, "image_url": { "type": "string", "description": "The image_url of the line item. When blank, it gets populated with the image_url of the associated item (if present, SKU only).", "example": "https://img.yourdomain.com/skus/xYZkjABcde.png" }, "item_type": { "type": "string", "description": "The type of the associated item. One of 'skus', 'bundles', 'gift_cards', 'shipments', 'payment_methods', 'adjustments', 'discount_engine_items', 'percentage_discount_promotions', 'free_shipping_promotions', 'buy_x_pay_y_promotions', 'free_gift_promotions', 'fixed_price_promotions', 'external_promotions', 'fixed_amount_promotions', or 'flex_promotions'.", "example": "skus", "enum": [ "skus", "bundles", "gift_cards", "shipments", "payment_methods", "adjustments", "discount_engine_items", "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "frequency": { "type": "string", "description": "The frequency which generates a subscription. Must be supported by existing associated subscription_model.", "example": "monthly" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "quantity" ] }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "item": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus", "bundles", "gift_cards", "shipments", "payment_methods", "adjustments", "discount_engine_items", "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/sku" }, { "$ref": "#/components/schemas/bundle" }, { "$ref": "#/components/schemas/giftCard" }, { "$ref": "#/components/schemas/shipment" }, { "$ref": "#/components/schemas/paymentMethod" }, { "$ref": "#/components/schemas/adjustment" }, { "$ref": "#/components/schemas/discountEngineItem" }, { "$ref": "#/components/schemas/percentageDiscountPromotion" }, { "$ref": "#/components/schemas/freeShippingPromotion" }, { "$ref": "#/components/schemas/buyXPayYPromotion" }, { "$ref": "#/components/schemas/freeGiftPromotion" }, { "$ref": "#/components/schemas/fixedPricePromotion" }, { "$ref": "#/components/schemas/externalPromotion" }, { "$ref": "#/components/schemas/fixedAmountPromotion" }, { "$ref": "#/components/schemas/flexPromotion" } ] }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "order" ] } } } } }, "lineItemUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": true }, "bundle_code": { "type": "string", "description": "The code of the associated bundle.", "example": "BUNDLEMM000000FFFFFFXLXX", "nullable": true }, "quantity": { "type": "integer", "description": "The line item quantity.", "example": 4, "nullable": false }, "_external_price": { "type": "boolean", "description": "When creating or updating a new line item, set this attribute to '1' if you want to inject the unit_amount_cents price from an external source. Any successive price computation will be done externally, until the attribute is reset to '0'.", "example": true, "nullable": false }, "_reserve_stock": { "type": "boolean", "description": "Send this attribute if you want to reserve the stock for the line item's SKUs quantity. Stock reservations expiration depends on the inventory model's cutoff. When used on update the existing active stock reservations are renewed. Cannot be passed by sales channels.", "example": true, "nullable": false }, "_reset_restocked_quantity": { "type": "boolean", "description": "Send this attribute if you want to reset the quantity restocked by a return or by an order/shipment cancel. This will allow for multiple returns, albeit you need to adjust the stock manually. Cannot be passed by sales channels.", "example": true, "nullable": false }, "unit_amount_cents": { "type": "integer", "description": "The unit amount of the line item, in cents. Can be specified only via an integration application, or when the item is missing, otherwise is automatically computed by using one of the available methods. Cannot be passed by sales channels.", "example": 10000, "nullable": true }, "compare_at_amount_cents": { "type": "integer", "description": "The compared price amount, in cents. Useful to display a percentage discount.", "example": 13000, "nullable": true }, "options_amount_cents": { "type": "integer", "description": "The options amount of the line item, in cents. Cannot be passed by sales channels.", "example": 1000, "nullable": true }, "name": { "type": "string", "description": "The name of the line item. When blank, it gets populated with the name of the associated item (if present).", "example": "Men's Black T-shirt with White Logo (XL)", "nullable": true }, "image_url": { "type": "string", "description": "The image_url of the line item. When blank, it gets populated with the image_url of the associated item (if present, SKU only).", "example": "https://img.yourdomain.com/skus/xYZkjABcde.png", "nullable": true }, "frequency": { "type": "string", "description": "The frequency which generates a subscription. Must be supported by existing associated subscription_model.", "example": "monthly", "nullable": true }, "_reset_circuit": { "type": "boolean", "description": "Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.", "example": true, "nullable": false }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "lineItemResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/lineItem/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "item": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "item" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "bundle": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "bundle" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "adjustment": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adjustment" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "gift_card": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "gift_card" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "shipment": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipment" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_method": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_method" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "line_item_options": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_item_options" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "return_line_items": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "return_line_items" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_reservations": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_reservations" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_line_items": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_line_items" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_transfers": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_transfers" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "notifications": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "notifications" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "lineItemResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/lineItemResponse/properties/data" } } } }, "link": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "links" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The link internal name.", "example": "FW SALE 2023", "nullable": false }, "client_id": { "type": "string", "description": "The link application client id, used to fetch JWT.", "example": "xxxx-yyyy-zzzz", "nullable": false }, "scope": { "type": "string", "description": "The link application scope, used to fetch JWT.", "example": "market:id:GhvCxsElAQ,market:id:kJhgVcxZDr", "nullable": false }, "starts_at": { "type": "string", "description": "The activation date/time of this link.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "expires_at": { "type": "string", "description": "The expiration date/time of this link (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": true }, "active": { "type": "boolean", "description": "Indicates if the link is active (enabled and not expired).", "example": true, "nullable": true }, "status": { "type": "string", "description": "The link status. One of 'disabled', 'expired', 'pending', or 'active'.", "example": "pending", "nullable": true, "enum": [ "disabled", "expired", "pending", "active" ] }, "domain": { "type": "string", "description": "The link URL second level domain.", "example": "commercelayer.link", "nullable": true }, "url": { "type": "string", "description": "The link URL.", "example": "https://commercelayer.link/ZXUtd2VzdC0xLzE5ZjBlMGVlLTg4OGMtNDQ1Yi1iYTA0LTg3MTUxY2FjZjFmYQ", "nullable": true }, "item_type": { "type": "string", "description": "The type of the associated item. One of 'orders', 'skus', or 'sku_lists'.", "example": "orders", "nullable": true, "enum": [ "orders", "skus", "sku_lists" ] }, "params": { "type": "object", "description": "The link params to be passed in URL the query string.", "example": { "param1": "ABC", "param2": "XYZ" }, "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "item": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders", "skus", "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/order" }, { "$ref": "#/components/schemas/sku" }, { "$ref": "#/components/schemas/skuList" } ] }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "linkCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "links" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The link internal name.", "example": "FW SALE 2023" }, "client_id": { "type": "string", "description": "The link application client id, used to fetch JWT.", "example": "xxxx-yyyy-zzzz" }, "scope": { "type": "string", "description": "The link application scope, used to fetch JWT.", "example": "market:id:GhvCxsElAQ,market:id:kJhgVcxZDr" }, "starts_at": { "type": "string", "description": "The activation date/time of this link.", "example": "2018-01-01T12:00:00.000Z" }, "expires_at": { "type": "string", "description": "The expiration date/time of this link (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z" }, "domain": { "type": "string", "description": "The link URL second level domain.", "example": "commercelayer.link" }, "item_type": { "type": "string", "description": "The type of the associated item. One of 'orders', 'skus', or 'sku_lists'.", "example": "orders", "enum": [ "orders", "skus", "sku_lists" ] }, "params": { "type": "object", "description": "The link params to be passed in URL the query string.", "example": { "param1": "ABC", "param2": "XYZ" } }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name", "client_id", "scope" ] }, "relationships": { "type": "object", "properties": { "item": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders", "skus", "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/order" }, { "$ref": "#/components/schemas/sku" }, { "$ref": "#/components/schemas/skuList" } ] } }, "required": [ "item" ] } } } } }, "linkUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "links" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The link internal name.", "example": "FW SALE 2023", "nullable": false }, "client_id": { "type": "string", "description": "The link application client id, used to fetch JWT.", "example": "xxxx-yyyy-zzzz", "nullable": false }, "scope": { "type": "string", "description": "The link application scope, used to fetch JWT.", "example": "market:id:GhvCxsElAQ,market:id:kJhgVcxZDr", "nullable": false }, "starts_at": { "type": "string", "description": "The activation date/time of this link.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "expires_at": { "type": "string", "description": "The expiration date/time of this link (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": true }, "domain": { "type": "string", "description": "The link URL second level domain.", "example": "commercelayer.link", "nullable": true }, "params": { "type": "object", "description": "The link params to be passed in URL the query string.", "example": { "param1": "ABC", "param2": "XYZ" }, "nullable": true }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "item": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders", "skus", "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/order" }, { "$ref": "#/components/schemas/sku" }, { "$ref": "#/components/schemas/skuList" } ] } } } } } } }, "linkResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "links" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/link/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "item": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "item" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "linkResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/linkResponse/properties/data" } } } }, "manualGateway": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "manual_gateways" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway", "nullable": false }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true, "nullable": true }, "credential_keys": { "type": "object", "description": "The payment gateway's API credential keys last digits.", "example": { "api_key": "********BW989" }, "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "manualGatewayCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "manual_gateways" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway" }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "manualGatewayUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "manual_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway", "nullable": false }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true, "nullable": false }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "manualGatewayResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "manual_gateways" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/manualGateway/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "manualGatewayResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/manualGatewayResponse/properties/data" } } } }, "manualTaxCalculator": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "manual_tax_calculators" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax calculator's internal name.", "example": "Personal tax calculator", "nullable": false }, "type": { "type": "string", "description": "The tax calculator's type.", "example": "avalara_accounts", "nullable": false, "enum": [ "avalara_accounts", "stripe_tax_accounts", "vertex_accounts", "taxjar_accounts", "manual_tax_calculators", "external_tax_calculators" ] }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tax_rules": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "manualTaxCalculatorCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "manual_tax_calculators" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax calculator's internal name.", "example": "Personal tax calculator" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { "tax_rules": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "manualTaxCalculatorUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "manual_tax_calculators" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax calculator's internal name.", "example": "Personal tax calculator", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "tax_rules": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "manualTaxCalculatorResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "manual_tax_calculators" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/manualTaxCalculator/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tax_rules": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_rules" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "manualTaxCalculatorResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/manualTaxCalculatorResponse/properties/data" } } } }, "market": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "attributes": { "type": "object", "properties": { "number": { "type": "integer", "description": "Unique identifier for the market (numeric).", "example": 1234, "nullable": true }, "name": { "type": "string", "description": "The market's internal name.", "example": "EU Market", "nullable": false }, "code": { "type": "string", "description": "A string that you can use to identify the market (must be unique within the environment).", "example": "europe1", "nullable": true }, "facebook_pixel_id": { "type": "string", "description": "The Facebook Pixed ID.", "example": "1234567890", "nullable": true }, "checkout_url": { "type": "string", "description": "The checkout URL for this market.", "example": "https://checkout.yourbrand.com/:order_id", "nullable": true }, "external_prices_url": { "type": "string", "description": "The URL used to overwrite prices by an external source.", "example": "https://external_prices.yourbrand.com", "nullable": true }, "external_order_validation_url": { "type": "string", "description": "The URL used to validate orders by an external source.", "example": "https://external_validation.yourbrand.com", "nullable": true }, "private": { "type": "boolean", "description": "Indicates if market belongs to a customer_group.", "example": true, "nullable": true }, "shipping_cost_cutoff": { "type": "integer", "description": "When specified indicates the maximum number of shipping line items with cost that will be added to an order.", "example": 3, "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "shared_secret": { "type": "string", "description": "The shared secret used to sign the external request payload.", "example": "1c0994cc4e996e8c6ee56a2198f66f3c", "nullable": false }, "external_includes": { "type": "array", "description": "List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.", "example": [ "order.line_item_options" ], "nullable": true, "items": { "type": "string" } }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "merchant": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "merchants" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "price_list": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "base_price_list": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "inventory_model": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_models" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "subscription_model": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "subscription_models" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "discount_engine": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "discount_engines" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tax_calculator": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "avalara_accounts", "stripe_tax_accounts", "vertex_accounts", "taxjar_accounts", "manual_tax_calculators", "external_tax_calculators" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/avalaraAccount" }, { "$ref": "#/components/schemas/stripeTaxAccount" }, { "$ref": "#/components/schemas/vertexAccount" }, { "$ref": "#/components/schemas/taxjarAccount" }, { "$ref": "#/components/schemas/manualTaxCalculator" }, { "$ref": "#/components/schemas/externalTaxCalculator" } ] }, "customer_group": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_groups" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "geocoder": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "geocoders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "default_shipping_method": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "default_payment_method": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "price_list_schedulers": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_list_schedulers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "marketCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The market's internal name.", "example": "EU Market" }, "code": { "type": "string", "description": "A string that you can use to identify the market (must be unique within the environment).", "example": "europe1" }, "facebook_pixel_id": { "type": "string", "description": "The Facebook Pixed ID.", "example": "1234567890" }, "checkout_url": { "type": "string", "description": "The checkout URL for this market.", "example": "https://checkout.yourbrand.com/:order_id" }, "external_prices_url": { "type": "string", "description": "The URL used to overwrite prices by an external source.", "example": "https://external_prices.yourbrand.com" }, "external_order_validation_url": { "type": "string", "description": "The URL used to validate orders by an external source.", "example": "https://external_validation.yourbrand.com" }, "shipping_cost_cutoff": { "type": "integer", "description": "When specified indicates the maximum number of shipping line items with cost that will be added to an order.", "example": 3 }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "external_includes": { "type": "array", "description": "List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.", "example": [ "order.line_item_options" ], "items": { "type": "string" } }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { "merchant": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "merchants" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "price_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "inventory_model": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_models" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "subscription_model": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "subscription_models" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "discount_engine": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "discount_engines" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tax_calculator": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "avalara_accounts", "stripe_tax_accounts", "vertex_accounts", "taxjar_accounts", "manual_tax_calculators", "external_tax_calculators" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/avalaraAccount" }, { "$ref": "#/components/schemas/stripeTaxAccount" }, { "$ref": "#/components/schemas/vertexAccount" }, { "$ref": "#/components/schemas/taxjarAccount" }, { "$ref": "#/components/schemas/manualTaxCalculator" }, { "$ref": "#/components/schemas/externalTaxCalculator" } ] }, "customer_group": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_groups" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "geocoder": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "geocoders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "default_shipping_method": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "default_payment_method": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "merchant", "price_list", "inventory_model" ] } } } } }, "marketUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The market's internal name.", "example": "EU Market", "nullable": false }, "code": { "type": "string", "description": "A string that you can use to identify the market (must be unique within the environment).", "example": "europe1", "nullable": true }, "facebook_pixel_id": { "type": "string", "description": "The Facebook Pixed ID.", "example": "1234567890", "nullable": true }, "checkout_url": { "type": "string", "description": "The checkout URL for this market.", "example": "https://checkout.yourbrand.com/:order_id", "nullable": true }, "external_prices_url": { "type": "string", "description": "The URL used to overwrite prices by an external source.", "example": "https://external_prices.yourbrand.com", "nullable": true }, "external_order_validation_url": { "type": "string", "description": "The URL used to validate orders by an external source.", "example": "https://external_validation.yourbrand.com", "nullable": true }, "shipping_cost_cutoff": { "type": "integer", "description": "When specified indicates the maximum number of shipping line items with cost that will be added to an order.", "example": 3, "nullable": true }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "external_includes": { "type": "array", "description": "List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.", "example": [ "order.line_item_options" ], "nullable": true, "items": { "type": "string" } }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "merchant": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "merchants" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "price_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "inventory_model": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_models" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "subscription_model": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "subscription_models" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "discount_engine": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "discount_engines" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tax_calculator": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "avalara_accounts", "stripe_tax_accounts", "vertex_accounts", "taxjar_accounts", "manual_tax_calculators", "external_tax_calculators" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/avalaraAccount" }, { "$ref": "#/components/schemas/stripeTaxAccount" }, { "$ref": "#/components/schemas/vertexAccount" }, { "$ref": "#/components/schemas/taxjarAccount" }, { "$ref": "#/components/schemas/manualTaxCalculator" }, { "$ref": "#/components/schemas/externalTaxCalculator" } ] }, "customer_group": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_groups" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "geocoder": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "geocoders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "default_shipping_method": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "default_payment_method": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "marketResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/market/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "merchant": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "merchant" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "price_list": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_list" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "base_price_list": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "base_price_list" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "inventory_model": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_model" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "subscription_model": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "subscription_model" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "discount_engine": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "discount_engine" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tax_calculator": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_calculator" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "customer_group": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_group" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "geocoder": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "geocoder" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "default_shipping_method": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "default_shipping_method" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "default_payment_method": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "default_payment_method" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "price_list_schedulers": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_list_schedulers" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "marketResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/marketResponse/properties/data" } } } }, "merchant": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "merchants" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The merchant's internal name.", "example": "The Brand Inc.", "nullable": false }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "address": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "merchantCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "merchants" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The merchant's internal name.", "example": "The Brand Inc." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { "address": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "address" ] } } } } }, "merchantUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "merchants" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The merchant's internal name.", "example": "The Brand Inc.", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "address": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "merchantResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "merchants" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/merchant/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "address": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "address" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "merchantResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/merchantResponse/properties/data" } } } }, "notification": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "notifications" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The internal name of the notification.", "example": "DDT transport document", "nullable": false }, "flash": { "type": "boolean", "description": "Indicates if the notification is temporary, valid for the ones created by external services.", "example": false, "nullable": true }, "body": { "type": "object", "description": "An internal body of the notification.", "example": { "sku": "REDHANDBAG", "name": "Enjoy your free item" }, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "notifiable": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items", "orders", "shipping_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/lineItem" }, { "$ref": "#/components/schemas/order" }, { "$ref": "#/components/schemas/shippingMethod" } ] }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "notificationCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "notifications" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The internal name of the notification.", "example": "DDT transport document" }, "flash": { "type": "boolean", "description": "Indicates if the notification is temporary, valid for the ones created by external services.", "example": false }, "body": { "type": "object", "description": "An internal body of the notification.", "example": { "sku": "REDHANDBAG", "name": "Enjoy your free item" } }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { "notifiable": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items", "orders", "shipping_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/lineItem" }, { "$ref": "#/components/schemas/order" }, { "$ref": "#/components/schemas/shippingMethod" } ] } }, "required": [ "notifiable" ] } } } } }, "notificationUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "notifications" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The internal name of the notification.", "example": "DDT transport document", "nullable": false }, "flash": { "type": "boolean", "description": "Indicates if the notification is temporary, valid for the ones created by external services.", "example": false, "nullable": false }, "body": { "type": "object", "description": "An internal body of the notification.", "example": { "sku": "REDHANDBAG", "name": "Enjoy your free item" }, "nullable": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "notifiable": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items", "orders", "shipping_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/lineItem" }, { "$ref": "#/components/schemas/order" }, { "$ref": "#/components/schemas/shippingMethod" } ] } } } } } } }, "notificationResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "notifications" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/notification/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "notifiable": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "notifiable" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "notificationResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/notificationResponse/properties/data" } } } }, "orderAmountPromotionRule": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "attributes": { "type": "object", "properties": { "type": { "type": "string", "description": "The promotion rule's type.", "example": "coupon_codes_promotion_rules", "nullable": false, "enum": [ "order_amount_promotion_rules", "sku_list_promotion_rules", "coupon_codes_promotion_rules", "custom_promotion_rules" ] }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "order_amount_cents": { "type": "integer", "description": "Apply the promotion only when order is over this amount, in cents.", "example": 1000, "nullable": true }, "order_amount_float": { "type": "number", "description": "Apply the promotion only when order is over this amount, float.", "example": 10.0, "nullable": true }, "formatted_order_amount": { "type": "string", "description": "Apply the promotion only when order is over this amount, formatted.", "example": "€10,00", "nullable": true }, "use_subtotal": { "type": "boolean", "description": "Send this attribute if you want to compare the specified amount with order's subtotal (excluding discounts, if any).", "example": true, "nullable": true } } }, "relationships": { "type": "object", "properties": { "promotion": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/percentageDiscountPromotion" }, { "$ref": "#/components/schemas/freeShippingPromotion" }, { "$ref": "#/components/schemas/buyXPayYPromotion" }, { "$ref": "#/components/schemas/freeGiftPromotion" }, { "$ref": "#/components/schemas/fixedPricePromotion" }, { "$ref": "#/components/schemas/externalPromotion" }, { "$ref": "#/components/schemas/fixedAmountPromotion" }, { "$ref": "#/components/schemas/flexPromotion" } ] }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "orderAmountPromotionRuleCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "attributes": { "type": "object", "properties": { "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "order_amount_cents": { "type": "integer", "description": "Apply the promotion only when order is over this amount, in cents.", "example": 1000 }, "use_subtotal": { "type": "boolean", "description": "Send this attribute if you want to compare the specified amount with order's subtotal (excluding discounts, if any).", "example": true } } }, "relationships": { "type": "object", "properties": { "promotion": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/percentageDiscountPromotion" }, { "$ref": "#/components/schemas/freeShippingPromotion" }, { "$ref": "#/components/schemas/buyXPayYPromotion" }, { "$ref": "#/components/schemas/freeGiftPromotion" }, { "$ref": "#/components/schemas/fixedPricePromotion" }, { "$ref": "#/components/schemas/externalPromotion" }, { "$ref": "#/components/schemas/fixedAmountPromotion" }, { "$ref": "#/components/schemas/flexPromotion" } ] } }, "required": [ "promotion" ] } } } } }, "orderAmountPromotionRuleUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "order_amount_cents": { "type": "integer", "description": "Apply the promotion only when order is over this amount, in cents.", "example": 1000, "nullable": true }, "use_subtotal": { "type": "boolean", "description": "Send this attribute if you want to compare the specified amount with order's subtotal (excluding discounts, if any).", "example": true, "nullable": false } } }, "relationships": { "type": "object", "properties": { "promotion": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/percentageDiscountPromotion" }, { "$ref": "#/components/schemas/freeShippingPromotion" }, { "$ref": "#/components/schemas/buyXPayYPromotion" }, { "$ref": "#/components/schemas/freeGiftPromotion" }, { "$ref": "#/components/schemas/fixedPricePromotion" }, { "$ref": "#/components/schemas/externalPromotion" }, { "$ref": "#/components/schemas/fixedAmountPromotion" }, { "$ref": "#/components/schemas/flexPromotion" } ] } } } } } } }, "orderAmountPromotionRuleResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/orderAmountPromotionRule/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "promotion": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "orderAmountPromotionRuleResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/orderAmountPromotionRuleResponse/properties/data" } } } }, "orderCopy": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_copies" ] }, "attributes": { "type": "object", "properties": { "type": { "type": "string", "description": "The order factory's type.", "example": "recurring_order_copies", "nullable": false, "enum": [ "order_copies", "recurring_order_copies" ] }, "status": { "type": "string", "description": "The order factory status. One of 'pending' (default), 'in_progress', 'aborted', 'failed', or 'completed'.", "example": "in_progress", "nullable": false, "enum": [ "pending", "in_progress", "aborted", "failed", "completed" ] }, "started_at": { "type": "string", "description": "Time at which the order copy was started.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "completed_at": { "type": "string", "description": "Time at which the order copy was completed.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "failed_at": { "type": "string", "description": "Time at which the order copy has failed.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "errors_log": { "type": "object", "description": "Contains the order copy errors, if any.", "example": { "status": [ "cannot transition from draft to placed" ] }, "nullable": true }, "errors_count": { "type": "integer", "description": "Indicates the number of copy errors, if any.", "example": 2, "nullable": true }, "place_target_order": { "type": "boolean", "description": "Indicates if the target order must be placed upon copy.", "example": true, "nullable": true }, "reuse_wallet": { "type": "boolean", "description": "Indicates if the payment source within the source order customer's wallet must be copied.", "example": true, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "cancel_source_order": { "type": "boolean", "description": "Indicates if the source order must be cancelled upon copy.", "example": true, "nullable": true }, "apply_promotions": { "type": "boolean", "description": "Indicates if promotions got applied upon copy.", "example": true, "nullable": true }, "skip_errors": { "type": "boolean", "description": "Indicates to ignore any errors during copy.", "example": true, "nullable": true }, "ignore_invalid_coupon": { "type": "boolean", "description": "Indicates to ignore invalid coupon code during copy.", "example": true, "nullable": true } } }, "relationships": { "type": "object", "properties": { "source_order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "target_order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_subscription": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscriptions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "orderCopyCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_copies" ] }, "attributes": { "type": "object", "properties": { "place_target_order": { "type": "boolean", "description": "Indicates if the target order must be placed upon copy.", "example": true }, "reuse_wallet": { "type": "boolean", "description": "Indicates if the payment source within the source order customer's wallet must be copied.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "cancel_source_order": { "type": "boolean", "description": "Indicates if the source order must be cancelled upon copy.", "example": true }, "apply_promotions": { "type": "boolean", "description": "Indicates if promotions got applied upon copy.", "example": true }, "skip_errors": { "type": "boolean", "description": "Indicates to ignore any errors during copy.", "example": true }, "ignore_invalid_coupon": { "type": "boolean", "description": "Indicates to ignore invalid coupon code during copy.", "example": true } } }, "relationships": { "type": "object", "properties": { "source_order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "source_order" ] } } } } }, "orderCopyUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_copies" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "orderCopyResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "order_copies" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/orderCopy/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "source_order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "source_order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "target_order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "target_order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "order_subscription": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscription" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "orderCopyResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/orderCopyResponse/properties/data" } } } }, "orderFactory": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_factories" ] }, "attributes": { "type": "object", "properties": { "type": { "type": "string", "description": "The order factory's type.", "example": "recurring_order_copies", "nullable": false, "enum": [ "order_copies", "recurring_order_copies" ] }, "status": { "type": "string", "description": "The order factory status. One of 'pending' (default), 'in_progress', 'aborted', 'failed', or 'completed'.", "example": "in_progress", "nullable": false, "enum": [ "pending", "in_progress", "aborted", "failed", "completed" ] }, "started_at": { "type": "string", "description": "Time at which the order copy was started.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "completed_at": { "type": "string", "description": "Time at which the order copy was completed.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "failed_at": { "type": "string", "description": "Time at which the order copy has failed.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "errors_log": { "type": "object", "description": "Contains the order copy errors, if any.", "example": { "status": [ "cannot transition from draft to placed" ] }, "nullable": true }, "errors_count": { "type": "integer", "description": "Indicates the number of copy errors, if any.", "example": 2, "nullable": true }, "place_target_order": { "type": "boolean", "description": "Indicates if the target order must be placed upon copy.", "example": true, "nullable": true }, "reuse_wallet": { "type": "boolean", "description": "Indicates if the payment source within the source order customer's wallet must be copied.", "example": true, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "source_order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "target_order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "orderFactoryResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "order_factories" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/orderFactory/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "source_order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "source_order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "target_order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "target_order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "orderFactoryResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/orderFactoryResponse/properties/data" } } } }, "orderSubscriptionItem": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscription_items" ] }, "attributes": { "type": "object", "properties": { "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": true }, "bundle_code": { "type": "string", "description": "The code of the associated bundle.", "example": "BUNDLEMM000000FFFFFFXLXX", "nullable": true }, "quantity": { "type": "integer", "description": "The subscription item quantity.", "example": 4, "nullable": false }, "unit_amount_cents": { "type": "integer", "description": "The unit amount of the subscription item, in cents.", "example": 9900, "nullable": true }, "unit_amount_float": { "type": "number", "description": "The unit amount of the subscription item, float. This can be useful to track the purchase on thrid party systems, e.g Google Analyitcs Enhanced Ecommerce.", "example": 99.0, "nullable": true }, "formatted_unit_amount": { "type": "string", "description": "The unit amount of the subscription item, formatted. This can be useful to display the amount with currency in you views.", "example": "€99,00", "nullable": true }, "total_amount_cents": { "type": "integer", "description": "Calculated as unit amount x quantity amount, in cents.", "example": 18800, "nullable": true }, "total_amount_float": { "type": "number", "description": "Calculated as unit amount x quantity amount, float. This can be useful to track the purchase on thrid party systems, e.g Google Analyitcs Enhanced Ecommerce.", "example": 188.0, "nullable": false }, "formatted_total_amount": { "type": "string", "description": "Calculated as unit amount x quantity amount, formatted. This can be useful to display the amount with currency in you views.", "example": "€188,00", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order_subscription": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscriptions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "item": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus", "bundles", "adjustments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/sku" }, { "$ref": "#/components/schemas/bundle" }, { "$ref": "#/components/schemas/adjustment" } ] }, "sku": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "bundle": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "bundles" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "adjustment": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adjustments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "source_line_item": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "orderSubscriptionItemCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscription_items" ] }, "attributes": { "type": "object", "properties": { "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX" }, "bundle_code": { "type": "string", "description": "The code of the associated bundle.", "example": "BUNDLEMM000000FFFFFFXLXX" }, "quantity": { "type": "integer", "description": "The subscription item quantity.", "example": 4 }, "unit_amount_cents": { "type": "integer", "description": "The unit amount of the subscription item, in cents.", "example": 9900 }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "quantity" ] }, "relationships": { "type": "object", "properties": { "order_subscription": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscriptions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "item": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus", "bundles", "adjustments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/sku" }, { "$ref": "#/components/schemas/bundle" }, { "$ref": "#/components/schemas/adjustment" } ] }, "sku": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "bundle": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "bundles" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "adjustment": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adjustments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "order_subscription", "item" ] } } } } }, "orderSubscriptionItemUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscription_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": true }, "bundle_code": { "type": "string", "description": "The code of the associated bundle.", "example": "BUNDLEMM000000FFFFFFXLXX", "nullable": true }, "quantity": { "type": "integer", "description": "The subscription item quantity.", "example": 4, "nullable": false }, "unit_amount_cents": { "type": "integer", "description": "The unit amount of the subscription item, in cents.", "example": 9900, "nullable": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "orderSubscriptionItemResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscription_items" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/orderSubscriptionItem/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "order_subscription": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscription" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "item": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "item" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "bundle": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "bundle" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "adjustment": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adjustment" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "source_line_item": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "source_line_item" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "orderSubscriptionItemResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/orderSubscriptionItemResponse/properties/data" } } } }, "orderSubscription": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscriptions" ] }, "attributes": { "type": "object", "properties": { "number": { "type": "string", "description": "Unique identifier for the subscription (numeric).", "example": "1234", "nullable": true }, "status": { "type": "string", "description": "The subscription status. One of 'draft' (default), 'inactive', 'active', 'running', or 'cancelled'.", "example": "draft", "nullable": false, "enum": [ "draft", "inactive", "active", "running", "cancelled" ] }, "frequency": { "type": "string", "description": "The frequency of the subscription. Use one of the supported within 'hourly', 'daily', 'weekly', 'monthly', 'two-month', 'three-month', 'four-month', 'six-month', 'yearly', or provide your custom crontab expression (min unit is hour). Must be supported by existing associated subscription_model.", "example": "monthly", "nullable": false }, "activate_by_source_order": { "type": "boolean", "description": "Indicates if the subscription will be activated considering the placed source order as its first run.", "example": true, "nullable": true }, "place_target_order": { "type": "boolean", "description": "Indicates if the subscription created orders are automatically placed at the end of the copy.", "example": true, "nullable": true }, "renewal_alert_period": { "type": "integer", "description": "Indicates the number of hours the renewal alert will be triggered before the subscription next run. Must be included between 1 and 720 hours.", "example": 1, "nullable": true }, "customer_email": { "type": "string", "description": "The email address of the customer, if any, associated to the source order.", "example": "john@example.com", "nullable": true }, "starts_at": { "type": "string", "description": "The activation date/time of this subscription.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "expires_at": { "type": "string", "description": "The expiration date/time of this subscription (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": true }, "last_run_at": { "type": "string", "description": "The date/time of the subscription last run.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "next_run_at": { "type": "string", "description": "The date/time of the subscription next run. Can be updated but only in the future, to copy with frequency changes.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "occurrencies": { "type": "integer", "description": "The number of times this subscription has run.", "example": 2, "nullable": true }, "errors_count": { "type": "integer", "description": "Indicates the number of subscription errors, if any.", "example": 3, "nullable": true }, "succeeded_on_last_run": { "type": "boolean", "description": "Indicates if the subscription has succeeded on its last run.", "example": true, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "subscription_model": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "subscription_models" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "source_order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "customer": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "customer_payment_source": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_payment_sources" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_subscription_items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscription_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_factories": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_factories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "recurring_order_copies": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "recurring_order_copies" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "orders": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "orderSubscriptionCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscriptions" ] }, "attributes": { "type": "object", "properties": { "frequency": { "type": "string", "description": "The frequency of the subscription. Use one of the supported within 'hourly', 'daily', 'weekly', 'monthly', 'two-month', 'three-month', 'four-month', 'six-month', 'yearly', or provide your custom crontab expression (min unit is hour). Must be supported by existing associated subscription_model.", "example": "monthly" }, "activate_by_source_order": { "type": "boolean", "description": "Indicates if the subscription will be activated considering the placed source order as its first run.", "example": true }, "place_target_order": { "type": "boolean", "description": "Indicates if the subscription created orders are automatically placed at the end of the copy.", "example": true }, "renewal_alert_period": { "type": "integer", "description": "Indicates the number of hours the renewal alert will be triggered before the subscription next run. Must be included between 1 and 720 hours.", "example": 1 }, "starts_at": { "type": "string", "description": "The activation date/time of this subscription.", "example": "2018-01-01T12:00:00.000Z" }, "expires_at": { "type": "string", "description": "The expiration date/time of this subscription (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "frequency" ] }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "source_order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "source_order" ] } } } } }, "orderSubscriptionUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscriptions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "frequency": { "type": "string", "description": "The frequency of the subscription. Use one of the supported within 'hourly', 'daily', 'weekly', 'monthly', 'two-month', 'three-month', 'four-month', 'six-month', 'yearly', or provide your custom crontab expression (min unit is hour). Must be supported by existing associated subscription_model.", "example": "monthly", "nullable": false }, "activate_by_source_order": { "type": "boolean", "description": "Indicates if the subscription will be activated considering the placed source order as its first run.", "example": true, "nullable": false }, "place_target_order": { "type": "boolean", "description": "Indicates if the subscription created orders are automatically placed at the end of the copy.", "example": true, "nullable": false }, "renewal_alert_period": { "type": "integer", "description": "Indicates the number of hours the renewal alert will be triggered before the subscription next run. Must be included between 1 and 720 hours.", "example": 1, "nullable": true }, "expires_at": { "type": "string", "description": "The expiration date/time of this subscription (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": true }, "next_run_at": { "type": "string", "description": "The date/time of the subscription next run. Can be updated but only in the future, to copy with frequency changes.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "_activate": { "type": "boolean", "description": "Send this attribute if you want to mark this subscription as active.", "example": true, "nullable": false }, "_deactivate": { "type": "boolean", "description": "Send this attribute if you want to mark this subscription as inactive.", "example": true, "nullable": false }, "_cancel": { "type": "boolean", "description": "Send this attribute if you want to mark this subscription as cancelled.", "example": true, "nullable": false }, "_convert": { "type": "boolean", "description": "Send this attribute if you want to convert a manual subscription to an automatic one. A subscription model is required before conversion.", "example": true, "nullable": false }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "customer_payment_source": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_payment_sources" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "orderSubscriptionResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscriptions" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/orderSubscription/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "market" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "subscription_model": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "subscription_model" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "source_order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "source_order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "customer": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "customer_payment_source": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_payment_source" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "order_subscription_items": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscription_items" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "order_factories": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_factories" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "recurring_order_copies": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "recurring_order_copies" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "orders": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "orderSubscriptionResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/orderSubscriptionResponse/properties/data" } } } }, "order": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "attributes": { "type": "object", "properties": { "number": { "type": "string", "description": "The order identifier. Can be specified if unique within the organization (for enterprise plans only), default to numeric ID otherwise. Cannot be passed by sales channels.", "example": "1234", "nullable": true }, "affiliate_code": { "type": "string", "description": "The affiliate code, if any, to track commissions using any third party services.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "autorefresh": { "type": "boolean", "description": "Save this attribute as 'false' if you want prevent the order to be refreshed automatically at each change (much faster).", "example": true, "nullable": true }, "place_async": { "type": "boolean", "description": "Save this attribute as 'true' if you want perform the place asynchronously. Payment errors, if any, will be collected afterwards.", "example": true, "nullable": true }, "status": { "type": "string", "description": "The order status. One of 'draft' (default), 'pending', 'editing', 'placing', 'placed', 'approved', or 'cancelled'.", "example": "draft", "nullable": false, "enum": [ "draft", "pending", "editing", "placing", "placed", "approved", "cancelled" ] }, "payment_status": { "type": "string", "description": "The order payment status. One of 'unpaid' (default), 'authorized', 'partially_authorized', 'paid', 'partially_paid', 'voided', 'partially_voided', 'refunded', 'partially_refunded', or 'free'.", "example": "unpaid", "nullable": false, "enum": [ "unpaid", "authorized", "partially_authorized", "paid", "partially_paid", "voided", "partially_voided", "refunded", "partially_refunded", "free" ] }, "fulfillment_status": { "type": "string", "description": "The order fulfillment status. One of 'unfulfilled' (default), 'in_progress', 'fulfilled', or 'not_required'.", "example": "unfulfilled", "nullable": false, "enum": [ "unfulfilled", "in_progress", "fulfilled", "not_required" ] }, "guest": { "type": "boolean", "description": "Indicates if the order has been placed as guest.", "example": true, "nullable": true }, "editable": { "type": "boolean", "description": "Indicates if the order can be edited.", "example": true, "nullable": true }, "customer_email": { "type": "string", "description": "The email address of the associated customer. When creating or updating an order, this is a shortcut to find or create the associated customer by email.", "example": "john@example.com", "nullable": true }, "customer_type": { "type": "string", "description": "The type of the associated customer. One of 'new', or 'returning'.", "example": "returning", "nullable": true, "enum": [ "new", "returning" ] }, "language_code": { "type": "string", "description": "The preferred language code (ISO 639-1) to be used when communicating with the customer. This can be useful when sending the order to 3rd party marketing tools and CRMs. If the language is supported, the hosted checkout will be localized accordingly.", "example": "it", "nullable": true }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard, automatically inherited from the order's market.", "example": "EUR", "nullable": true }, "tax_included": { "type": "boolean", "description": "Indicates if taxes are included in the order amounts, automatically inherited from the order's price list.", "example": true, "nullable": true }, "tax_rate": { "type": "number", "description": "The tax rate for this order (if calculated).", "example": 0.22, "nullable": true }, "freight_taxable": { "type": "boolean", "description": "Indicates if taxes are applied to shipping costs.", "example": true, "nullable": true }, "payment_method_taxable": { "type": "boolean", "description": "Indicates if taxes are applied to payment methods costs.", "example": true, "nullable": true }, "adjustment_taxable": { "type": "boolean", "description": "Indicates if taxes are applied to positive adjustments.", "example": true, "nullable": true }, "gift_card_taxable": { "type": "boolean", "description": "Indicates if taxes are applied to purchased gift cards.", "example": false, "nullable": true }, "requires_billing_info": { "type": "boolean", "description": "Indicates if the billing address associated to this order requires billing info to be present.", "example": false, "nullable": true }, "country_code": { "type": "string", "description": "The international 2-letter country code as defined by the ISO 3166-1 standard, automatically inherited from the order's shipping or billing addresses.", "example": "IT", "nullable": true }, "shipping_country_code_lock": { "type": "string", "description": "The country code that you want the shipping address to be locked to. This can be useful to make sure the shipping address belongs to a given shipping country, e.g. the one selected in a country selector page. Not relevant if order contains only digital products.", "example": "IT", "nullable": true }, "coupon_code": { "type": "string", "description": "The coupon code to be used for the order. If valid, it triggers a promotion adding a discount line item to the order.", "example": "SUMMERDISCOUNT", "nullable": true }, "gift_card_code": { "type": "string", "description": "The gift card code (at least the first 8 characters) to be used for the order. If valid, it uses the gift card balance to pay for the order.", "example": "cc92c23e-967e-48b2-a323-59add603301f", "nullable": true }, "subtotal_amount_cents": { "type": "integer", "description": "The sum of all the SKU line items total amounts, in cents.", "example": 5000, "nullable": true }, "subtotal_amount_float": { "type": "number", "description": "The sum of all the SKU line items total amounts, float.", "example": 50.0, "nullable": true }, "formatted_subtotal_amount": { "type": "string", "description": "The sum of all the SKU line items total amounts, formatted.", "example": "€50,00", "nullable": true }, "shipping_amount_cents": { "type": "integer", "description": "The sum of all the shipping costs, in cents.", "example": 1200, "nullable": true }, "shipping_amount_float": { "type": "number", "description": "The sum of all the shipping costs, float.", "example": 12.0, "nullable": true }, "formatted_shipping_amount": { "type": "string", "description": "The sum of all the shipping costs, formatted.", "example": "€12,00", "nullable": true }, "payment_method_amount_cents": { "type": "integer", "description": "The payment method costs, in cents.", "example": 0, "nullable": true }, "payment_method_amount_float": { "type": "number", "description": "The payment method costs, float.", "example": 0.0, "nullable": true }, "formatted_payment_method_amount": { "type": "string", "description": "The payment method costs, formatted.", "example": "€0,00", "nullable": true }, "discount_amount_cents": { "type": "integer", "description": "The sum of all the discounts applied to the order, in cents (negative amount).", "example": -500, "nullable": true }, "discount_amount_float": { "type": "number", "description": "The sum of all the discounts applied to the order, float.", "example": -5.0, "nullable": true }, "formatted_discount_amount": { "type": "string", "description": "The sum of all the discounts applied to the order, formatted.", "example": "-€5,00", "nullable": true }, "adjustment_amount_cents": { "type": "integer", "description": "The sum of all the adjustments applied to the order, in cents.", "example": 1500, "nullable": true }, "adjustment_amount_float": { "type": "number", "description": "The sum of all the adjustments applied to the order, float.", "example": 15.0, "nullable": true }, "formatted_adjustment_amount": { "type": "string", "description": "The sum of all the adjustments applied to the order, formatted.", "example": "€15,00", "nullable": true }, "gift_card_amount_cents": { "type": "integer", "description": "The sum of all the gift_cards applied to the order, in cents.", "example": 1500, "nullable": true }, "gift_card_amount_float": { "type": "number", "description": "The sum of all the gift_cards applied to the order, float.", "example": 15.0, "nullable": true }, "formatted_gift_card_amount": { "type": "string", "description": "The sum of all the gift_cards applied to the order, formatted.", "example": "€15,00", "nullable": true }, "total_tax_amount_cents": { "type": "integer", "description": "The sum of all the taxes applied to the order, in cents.", "example": 1028, "nullable": true }, "total_tax_amount_float": { "type": "number", "description": "The sum of all the taxes applied to the order, float.", "example": 10.28, "nullable": true }, "formatted_total_tax_amount": { "type": "string", "description": "The sum of all the taxes applied to the order, formatted.", "example": "€10,28", "nullable": true }, "subtotal_tax_amount_cents": { "type": "integer", "description": "The taxes applied to the order's subtotal, in cents.", "example": 902, "nullable": true }, "subtotal_tax_amount_float": { "type": "number", "description": "The taxes applied to the order's subtotal, float.", "example": 9.02, "nullable": true }, "formatted_subtotal_tax_amount": { "type": "string", "description": "The taxes applied to the order's subtotal, formatted.", "example": "€9,02", "nullable": true }, "shipping_tax_amount_cents": { "type": "integer", "description": "The taxes applied to the order's shipping costs, in cents.", "example": 216, "nullable": true }, "shipping_tax_amount_float": { "type": "number", "description": "The taxes applied to the order's shipping costs, float.", "example": 2.16, "nullable": true }, "formatted_shipping_tax_amount": { "type": "string", "description": "The taxes applied to the order's shipping costs, formatted.", "example": "€2,16", "nullable": true }, "payment_method_tax_amount_cents": { "type": "integer", "description": "The taxes applied to the order's payment method costs, in cents.", "example": 0, "nullable": true }, "payment_method_tax_amount_float": { "type": "number", "description": "The taxes applied to the order's payment method costs, float.", "example": 0.0, "nullable": true }, "formatted_payment_method_tax_amount": { "type": "string", "description": "The taxes applied to the order's payment method costs, formatted.", "example": "€0,00", "nullable": true }, "adjustment_tax_amount_cents": { "type": "integer", "description": "The taxes applied to the order adjustments, in cents.", "example": 900, "nullable": true }, "adjustment_tax_amount_float": { "type": "number", "description": "The taxes applied to the order adjustments, float.", "example": 9.0, "nullable": true }, "formatted_adjustment_tax_amount": { "type": "string", "description": "The taxes applied to the order adjustments, formatted.", "example": "€9,00", "nullable": true }, "total_amount_cents": { "type": "integer", "description": "The order's total amount, in cents.", "example": 5700, "nullable": true }, "total_amount_float": { "type": "number", "description": "The order's total amount, float.", "example": 57.0, "nullable": true }, "formatted_total_amount": { "type": "string", "description": "The order's total amount, formatted.", "example": "€57,00", "nullable": true }, "total_taxable_amount_cents": { "type": "integer", "description": "The order's total taxable amount, in cents (without discounts).", "example": 4672, "nullable": true }, "total_taxable_amount_float": { "type": "number", "description": "The order's total taxable amount, float.", "example": 46.72, "nullable": true }, "formatted_total_taxable_amount": { "type": "string", "description": "The order's total taxable amount, formatted.", "example": "€46,72", "nullable": true }, "subtotal_taxable_amount_cents": { "type": "integer", "description": "The order's subtotal taxable amount, in cents (equal to subtotal_amount_cents when prices don't include taxes).", "example": 4098, "nullable": true }, "subtotal_taxable_amount_float": { "type": "number", "description": "The order's subtotal taxable amount, float.", "example": 40.98, "nullable": true }, "formatted_subtotal_taxable_amount": { "type": "string", "description": "The order's subtotal taxable amount, formatted.", "example": "€40,98", "nullable": true }, "shipping_taxable_amount_cents": { "type": "integer", "description": "The order's shipping taxable amount, in cents (equal to shipping_amount_cents when prices don't include taxes).", "example": 984, "nullable": true }, "shipping_taxable_amount_float": { "type": "number", "description": "The order's shipping taxable amount, float.", "example": 9.84, "nullable": true }, "formatted_shipping_taxable_amount": { "type": "string", "description": "The order's shipping taxable amount, formatted.", "example": "€9,84", "nullable": true }, "payment_method_taxable_amount_cents": { "type": "integer", "description": "The order's payment method taxable amount, in cents (equal to payment_method_amount_cents when prices don't include taxes).", "example": 0, "nullable": true }, "payment_method_taxable_amount_float": { "type": "number", "description": "The order's payment method taxable amount, float.", "example": 0.0, "nullable": true }, "formatted_payment_method_taxable_amount": { "type": "string", "description": "The order's payment method taxable amount, formatted.", "example": "€0,00", "nullable": true }, "adjustment_taxable_amount_cents": { "type": "integer", "description": "The order's adjustment taxable amount, in cents (equal to discount_adjustment_cents when prices don't include taxes).", "example": 120, "nullable": true }, "adjustment_taxable_amount_float": { "type": "number", "description": "The order's adjustment taxable amount, float.", "example": 1.2, "nullable": true }, "formatted_adjustment_taxable_amount": { "type": "string", "description": "The order's adjustment taxable amount, formatted.", "example": "€1,20", "nullable": true }, "total_amount_with_taxes_cents": { "type": "integer", "description": "The order's total amount (when prices include taxes) or the order's total + taxes amount (when prices don't include taxes, e.g. US Markets or B2B).", "example": 5700, "nullable": true }, "total_amount_with_taxes_float": { "type": "number", "description": "The order's total amount with taxes, float.", "example": 57.0, "nullable": true }, "formatted_total_amount_with_taxes": { "type": "string", "description": "The order's total amount with taxes, formatted.", "example": "€57,00", "nullable": true }, "fees_amount_cents": { "type": "integer", "description": "The fees amount that is applied by Commerce Layer, in cents.", "example": 0, "nullable": true }, "fees_amount_float": { "type": "number", "description": "The fees amount that is applied by Commerce Layer, float.", "example": 0.0, "nullable": true }, "formatted_fees_amount": { "type": "string", "description": "The fees amount that is applied by Commerce Layer, formatted.", "example": "€0,00", "nullable": true }, "duty_amount_cents": { "type": "integer", "description": "The duty amount that is calculated by external services, in cents.", "example": 0, "nullable": true }, "duty_amount_float": { "type": "number", "description": "The duty amount that is calculated by external services, float.", "example": 0.0, "nullable": true }, "formatted_duty_amount": { "type": "string", "description": "The duty amount that is calculated by external services, formatted.", "example": "€0,00", "nullable": true }, "place_total_amount_cents": { "type": "integer", "description": "The total amount at place time, in cents, which is used internally for editing.", "example": 0, "nullable": true }, "place_total_amount_float": { "type": "number", "description": "The total amount at place time, float.", "example": 0.0, "nullable": true }, "formatted_place_total_amount": { "type": "string", "description": "The total amount at place time, formatted.", "example": "€0,00", "nullable": true }, "skus_count": { "type": "integer", "description": "The total number of SKUs in the order's line items. This can be useful to display a preview of the customer shopping cart content.", "example": 2, "nullable": true }, "line_item_options_count": { "type": "integer", "description": "The total number of line item options. This can be useful to display a preview of the customer shopping cart content.", "example": 1, "nullable": true }, "shipments_count": { "type": "integer", "description": "The total number of shipments. This can be useful to manage the shipping method(s) selection during checkout.", "example": 1, "nullable": true }, "tax_calculations_count": { "type": "integer", "description": "The total number of tax calculations. This can be useful to monitor external tax service usage.", "example": 1, "nullable": true }, "validations_count": { "type": "integer", "description": "The total number of external validation performed. This can be useful to monitor if external validation has been triggered.", "example": 1, "nullable": true }, "errors_count": { "type": "integer", "description": "The total number of resource errors.", "example": 1, "nullable": true }, "payment_source_details": { "type": "object", "description": "An object that contains the shareable details of the order's payment source.", "example": { "foo": "bar" }, "nullable": true }, "token": { "type": "string", "description": "A unique token that can be shared more securely instead of the order's id.", "example": "1c0994cc4e996e8c6ee56a2198f66f3c", "nullable": true }, "cart_url": { "type": "string", "description": "The cart url on your site. If present, it will be used on our hosted checkout application.", "example": "https://yourdomain.com/cart", "nullable": true }, "return_url": { "type": "string", "description": "The return url on your site. If present, it will be used on our hosted checkout application.", "example": "https://yourdomain.com/", "nullable": true }, "terms_url": { "type": "string", "description": "The terms and conditions url on your site. If present, it will be used on our hosted checkout application.", "example": "https://yourdomain.com/terms", "nullable": true }, "privacy_url": { "type": "string", "description": "The privacy policy url on your site. If present, it will be used on our hosted checkout application.", "example": "https://yourdomain.com/privacy", "nullable": true }, "checkout_url": { "type": "string", "description": "The checkout url that was automatically generated for the order. Send the customers to this url to let them checkout the order securely on our hosted checkout application.", "example": "https://yourdomain.commercelayer.io/checkout/1c0994cc4e996e8c6ee56a2198f66f3c", "nullable": true }, "placed_at": { "type": "string", "description": "Time at which the order was placed.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "approved_at": { "type": "string", "description": "Time at which the order was approved.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "cancelled_at": { "type": "string", "description": "Time at which the order was cancelled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "payment_updated_at": { "type": "string", "description": "Time at which the order's payment status was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "fulfillment_updated_at": { "type": "string", "description": "Time at which the order's fulfillment status was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "refreshed_at": { "type": "string", "description": "Last time at which the order was refreshed.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "archived_at": { "type": "string", "description": "Time at which the resource has been archived.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "subscription_created_at": { "type": "string", "description": "Time at which the order has been marked to create a subscription from its recurring line items.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "expires_at": { "type": "string", "description": "The expiration date/time of this order. Cannot be passed by sales channels.", "example": "2018-01-02T12:00:00.000Z", "nullable": true }, "expiration_info": { "type": "object", "description": "The information related to the order expiration, in case expires_at is not null. Cannot be passed by sales channels.", "example": { "summary_message": "Your tickets are reserved for the remaining time.", "expired_message": "Your session has expired. Please start your checkout again.", "redirect_url": "https://yourshop.com/" }, "nullable": true }, "circuit_state": { "type": "string", "description": "The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made.", "example": "closed", "nullable": true }, "circuit_failure_count": { "type": "integer", "description": "The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback.", "example": 5, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "customer": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_address": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "billing_address": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "store": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "default_shipping_method": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "default_payment_method": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "available_payment_methods": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "available_customer_payment_sources": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer_payment_sources" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "available_free_skus": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "available_free_bundles": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "bundles" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_method": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_source": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_payments", "axerve_payments", "braintree_payments", "checkout_com_payments", "external_payments", "klarna_payments", "paypal_payments", "satispay_payments", "stripe_payments", "wire_transfers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/adyenPayment" }, { "$ref": "#/components/schemas/axervePayment" }, { "$ref": "#/components/schemas/braintreePayment" }, { "$ref": "#/components/schemas/checkoutComPayment" }, { "$ref": "#/components/schemas/externalPayment" }, { "$ref": "#/components/schemas/klarnaPayment" }, { "$ref": "#/components/schemas/paypalPayment" }, { "$ref": "#/components/schemas/satispayPayment" }, { "$ref": "#/components/schemas/stripePayment" }, { "$ref": "#/components/schemas/wireTransfer" } ] }, "discount_engine_item": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "discount_engine_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "line_items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "line_item_options": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_item_options" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_reservations": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_reservations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_line_items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_transfers": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_transfers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_options": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_options" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "transactions": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "authorizations", "voids", "captures", "refunds" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/authorization" }, { "$ref": "#/components/schemas/void" }, { "$ref": "#/components/schemas/capture" }, { "$ref": "#/components/schemas/refund" } ] }, "authorizations": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "authorizations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "captures": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "captures" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "voids": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "voids" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "refunds": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "refunds" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "returns": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "returns" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_subscription": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscriptions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_subscriptions": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscriptions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_factories": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_factories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_copies": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_copies" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "recurring_order_copies": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "recurring_order_copies" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "notifications": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "notifications" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "links": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "links" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "resource_errors": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "resource_errors" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "orderCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "attributes": { "type": "object", "properties": { "number": { "type": "string", "description": "The order identifier. Can be specified if unique within the organization (for enterprise plans only), default to numeric ID otherwise. Cannot be passed by sales channels.", "example": "1234" }, "affiliate_code": { "type": "string", "description": "The affiliate code, if any, to track commissions using any third party services.", "example": "xxxx-yyyy-zzzz" }, "autorefresh": { "type": "boolean", "description": "Save this attribute as 'false' if you want prevent the order to be refreshed automatically at each change (much faster).", "example": true }, "place_async": { "type": "boolean", "description": "Save this attribute as 'true' if you want perform the place asynchronously. Payment errors, if any, will be collected afterwards.", "example": true }, "guest": { "type": "boolean", "description": "Indicates if the order has been placed as guest.", "example": true }, "customer_email": { "type": "string", "description": "The email address of the associated customer. When creating or updating an order, this is a shortcut to find or create the associated customer by email.", "example": "john@example.com" }, "customer_password": { "type": "string", "description": "The password of the associated customer. When creating or updating an order, this is a shortcut to sign up the associated customer.", "example": "secret" }, "language_code": { "type": "string", "description": "The preferred language code (ISO 639-1) to be used when communicating with the customer. This can be useful when sending the order to 3rd party marketing tools and CRMs. If the language is supported, the hosted checkout will be localized accordingly.", "example": "it" }, "freight_taxable": { "type": "boolean", "description": "Indicates if taxes are applied to shipping costs.", "example": true }, "payment_method_taxable": { "type": "boolean", "description": "Indicates if taxes are applied to payment methods costs.", "example": true }, "adjustment_taxable": { "type": "boolean", "description": "Indicates if taxes are applied to positive adjustments.", "example": true }, "gift_card_taxable": { "type": "boolean", "description": "Indicates if taxes are applied to purchased gift cards.", "example": false }, "shipping_country_code_lock": { "type": "string", "description": "The country code that you want the shipping address to be locked to. This can be useful to make sure the shipping address belongs to a given shipping country, e.g. the one selected in a country selector page. Not relevant if order contains only digital products.", "example": "IT" }, "coupon_code": { "type": "string", "description": "The coupon code to be used for the order. If valid, it triggers a promotion adding a discount line item to the order.", "example": "SUMMERDISCOUNT" }, "gift_card_code": { "type": "string", "description": "The gift card code (at least the first 8 characters) to be used for the order. If valid, it uses the gift card balance to pay for the order.", "example": "cc92c23e-967e-48b2-a323-59add603301f" }, "cart_url": { "type": "string", "description": "The cart url on your site. If present, it will be used on our hosted checkout application.", "example": "https://yourdomain.com/cart" }, "return_url": { "type": "string", "description": "The return url on your site. If present, it will be used on our hosted checkout application.", "example": "https://yourdomain.com/" }, "terms_url": { "type": "string", "description": "The terms and conditions url on your site. If present, it will be used on our hosted checkout application.", "example": "https://yourdomain.com/terms" }, "privacy_url": { "type": "string", "description": "The privacy policy url on your site. If present, it will be used on our hosted checkout application.", "example": "https://yourdomain.com/privacy" }, "expires_at": { "type": "string", "description": "The expiration date/time of this order. Cannot be passed by sales channels.", "example": "2018-01-02T12:00:00.000Z" }, "expiration_info": { "type": "object", "description": "The information related to the order expiration, in case expires_at is not null. Cannot be passed by sales channels.", "example": { "summary_message": "Your tickets are reserved for the remaining time.", "expired_message": "Your session has expired. Please start your checkout again.", "redirect_url": "https://yourshop.com/" } }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } } }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "customer": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_address": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "billing_address": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "store": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_method": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_source": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_payments", "axerve_payments", "braintree_payments", "checkout_com_payments", "external_payments", "klarna_payments", "paypal_payments", "satispay_payments", "stripe_payments", "wire_transfers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/adyenPayment" }, { "$ref": "#/components/schemas/axervePayment" }, { "$ref": "#/components/schemas/braintreePayment" }, { "$ref": "#/components/schemas/checkoutComPayment" }, { "$ref": "#/components/schemas/externalPayment" }, { "$ref": "#/components/schemas/klarnaPayment" }, { "$ref": "#/components/schemas/paypalPayment" }, { "$ref": "#/components/schemas/satispayPayment" }, { "$ref": "#/components/schemas/stripePayment" }, { "$ref": "#/components/schemas/wireTransfer" } ] }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "orderUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "number": { "type": "string", "description": "The order identifier. Can be specified if unique within the organization (for enterprise plans only), default to numeric ID otherwise. Cannot be passed by sales channels.", "example": "1234", "nullable": true }, "affiliate_code": { "type": "string", "description": "The affiliate code, if any, to track commissions using any third party services.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "autorefresh": { "type": "boolean", "description": "Save this attribute as 'false' if you want prevent the order to be refreshed automatically at each change (much faster).", "example": true, "nullable": false }, "place_async": { "type": "boolean", "description": "Save this attribute as 'true' if you want perform the place asynchronously. Payment errors, if any, will be collected afterwards.", "example": true, "nullable": false }, "guest": { "type": "boolean", "description": "Indicates if the order has been placed as guest.", "example": true, "nullable": false }, "customer_email": { "type": "string", "description": "The email address of the associated customer. When creating or updating an order, this is a shortcut to find or create the associated customer by email.", "example": "john@example.com", "nullable": true }, "customer_password": { "type": "string", "description": "The password of the associated customer. When creating or updating an order, this is a shortcut to sign up the associated customer.", "example": "secret" }, "language_code": { "type": "string", "description": "The preferred language code (ISO 639-1) to be used when communicating with the customer. This can be useful when sending the order to 3rd party marketing tools and CRMs. If the language is supported, the hosted checkout will be localized accordingly.", "example": "it", "nullable": true }, "freight_taxable": { "type": "boolean", "description": "Indicates if taxes are applied to shipping costs.", "example": true, "nullable": false }, "payment_method_taxable": { "type": "boolean", "description": "Indicates if taxes are applied to payment methods costs.", "example": true, "nullable": false }, "adjustment_taxable": { "type": "boolean", "description": "Indicates if taxes are applied to positive adjustments.", "example": true, "nullable": false }, "gift_card_taxable": { "type": "boolean", "description": "Indicates if taxes are applied to purchased gift cards.", "example": false, "nullable": false }, "shipping_country_code_lock": { "type": "string", "description": "The country code that you want the shipping address to be locked to. This can be useful to make sure the shipping address belongs to a given shipping country, e.g. the one selected in a country selector page. Not relevant if order contains only digital products.", "example": "IT", "nullable": true }, "coupon_code": { "type": "string", "description": "The coupon code to be used for the order. If valid, it triggers a promotion adding a discount line item to the order.", "example": "SUMMERDISCOUNT", "nullable": true }, "gift_card_code": { "type": "string", "description": "The gift card code (at least the first 8 characters) to be used for the order. If valid, it uses the gift card balance to pay for the order.", "example": "cc92c23e-967e-48b2-a323-59add603301f", "nullable": true }, "cart_url": { "type": "string", "description": "The cart url on your site. If present, it will be used on our hosted checkout application.", "example": "https://yourdomain.com/cart", "nullable": true }, "return_url": { "type": "string", "description": "The return url on your site. If present, it will be used on our hosted checkout application.", "example": "https://yourdomain.com/", "nullable": true }, "terms_url": { "type": "string", "description": "The terms and conditions url on your site. If present, it will be used on our hosted checkout application.", "example": "https://yourdomain.com/terms", "nullable": true }, "privacy_url": { "type": "string", "description": "The privacy policy url on your site. If present, it will be used on our hosted checkout application.", "example": "https://yourdomain.com/privacy", "nullable": true }, "_archive": { "type": "boolean", "description": "Send this attribute if you want to archive the order.", "example": true, "nullable": false }, "_unarchive": { "type": "boolean", "description": "Send this attribute if you want to unarchive the order.", "example": true, "nullable": false }, "_pending": { "type": "boolean", "description": "Send this attribute if you want to move a draft or placing order to pending. Cannot be passed by sales channels.", "example": true, "nullable": false }, "_place": { "type": "boolean", "description": "Send this attribute if you want to place the order.", "example": true, "nullable": false }, "_cancel": { "type": "boolean", "description": "Send this attribute if you want to cancel a placed order. The order's authorization will be automatically voided.", "example": true, "nullable": false }, "_approve": { "type": "boolean", "description": "Send this attribute if you want to approve a placed order. Cannot be passed by sales channels.", "example": true, "nullable": false }, "_approve_and_capture": { "type": "boolean", "description": "Send this attribute if you want to approve and capture a placed order. Cannot be passed by sales channels.", "example": true, "nullable": false }, "_authorize": { "type": "boolean", "description": "Send this attribute if you want to authorize the order's payment source.", "example": true, "nullable": false }, "_authorization_amount_cents": { "type": "integer", "description": "Send this attribute as a value in cents if you want to overwrite the amount to be authorized.", "example": 500 }, "_capture": { "type": "boolean", "description": "Send this attribute if you want to capture an authorized order. Cannot be passed by sales channels.", "example": true, "nullable": false }, "_refund": { "type": "boolean", "description": "Send this attribute if you want to refund a captured order. Cannot be passed by sales channels.", "example": true, "nullable": false }, "_fulfill": { "type": "boolean", "description": "Send this attribute if you want to mark as fulfilled the order (shipments must be cancelled, shipped or delivered, alternatively order must be approved). Cannot be passed by sales channels.", "example": true, "nullable": false }, "_update_taxes": { "type": "boolean", "description": "Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the order's market).", "example": true, "nullable": false }, "_nullify_payment_source": { "type": "boolean", "description": "Send this attribute if you want to nullify the payment source for this order.", "example": false, "nullable": false }, "_fix_payment_source": { "type": "boolean", "description": "Send this attribute if you want to set the payment source associated with the last succeeded authorization. At the end of the fix the order should be placed and authorized and ready to be approved. A tentative to fix the payment source is done before approval automatically. Cannot be passed by sales channels.", "example": true, "nullable": false }, "_billing_address_clone_id": { "type": "string", "description": "The id of the address that you want to clone to create the order's billing address.", "example": "1234" }, "_shipping_address_clone_id": { "type": "string", "description": "The id of the address that you want to clone to create the order's shipping address.", "example": "1234" }, "_customer_payment_source_id": { "type": "string", "description": "The id of the customer payment source (i.e. credit card) that you want to use as the order's payment source.", "example": "1234" }, "_shipping_address_same_as_billing": { "type": "boolean", "description": "Send this attribute if you want the shipping address to be cloned from the order's billing address.", "example": true, "nullable": false }, "_billing_address_same_as_shipping": { "type": "boolean", "description": "Send this attribute if you want the billing address to be cloned from the order's shipping address.", "example": true, "nullable": false }, "_commit_invoice": { "type": "boolean", "description": "Send this attribute if you want commit the sales tax invoice to the associated tax calculator (currently supported by Avalara).", "example": true, "nullable": false }, "_refund_invoice": { "type": "boolean", "description": "Send this attribute if you want refund the sales tax invoice to the associated tax calculator (currently supported by Avalara).", "example": true, "nullable": false }, "_save_payment_source_to_customer_wallet": { "type": "boolean", "description": "Send this attribute if you want the order's payment source to be saved in the customer's wallet as a customer payment source.", "example": true, "nullable": false }, "_save_shipping_address_to_customer_address_book": { "type": "boolean", "description": "Send this attribute if you want the order's shipping address to be saved in the customer's address book as a customer address.", "example": true, "nullable": false }, "_save_billing_address_to_customer_address_book": { "type": "boolean", "description": "Send this attribute if you want the order's billing address to be saved in the customer's address book as a customer address.", "example": true, "nullable": false }, "_refresh": { "type": "boolean", "description": "Send this attribute if you want to manually refresh the order.", "example": true, "nullable": false }, "_refresh_prices": { "type": "boolean", "description": "Send this attribute if you want to refresh the prices of the line items associated to this order. Cannot be passed by sales channels.", "example": true, "nullable": false }, "_validate": { "type": "boolean", "description": "Send this attribute if you want to trigger the external validation for the order.", "example": true, "nullable": false }, "_create_subscriptions": { "type": "boolean", "description": "Send this attribute upon/after placing the order if you want to create order subscriptions from the line items that have a frequency.", "example": true, "nullable": false }, "_start_editing": { "type": "boolean", "description": "Send this attribute if you want to edit the order after it is placed. Remember you cannot exceed the original total amount. Cannot be passed by sales channels.", "example": true, "nullable": false }, "_stop_editing": { "type": "boolean", "description": "Send this attribute to stop the editing for the order and return back to placed status. Cannot be passed by sales channels.", "example": true, "nullable": false }, "expires_at": { "type": "string", "description": "The expiration date/time of this order. Cannot be passed by sales channels.", "example": "2018-01-02T12:00:00.000Z", "nullable": true }, "expiration_info": { "type": "object", "description": "The information related to the order expiration, in case expires_at is not null. Cannot be passed by sales channels.", "example": { "summary_message": "Your tickets are reserved for the remaining time.", "expired_message": "Your session has expired. Please start your checkout again.", "redirect_url": "https://yourshop.com/" }, "nullable": true }, "_reset_circuit": { "type": "boolean", "description": "Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.", "example": true, "nullable": false }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "customer": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_address": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "billing_address": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "store": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_method": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_source": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_payments", "axerve_payments", "braintree_payments", "checkout_com_payments", "external_payments", "klarna_payments", "paypal_payments", "satispay_payments", "stripe_payments", "wire_transfers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/adyenPayment" }, { "$ref": "#/components/schemas/axervePayment" }, { "$ref": "#/components/schemas/braintreePayment" }, { "$ref": "#/components/schemas/checkoutComPayment" }, { "$ref": "#/components/schemas/externalPayment" }, { "$ref": "#/components/schemas/klarnaPayment" }, { "$ref": "#/components/schemas/paypalPayment" }, { "$ref": "#/components/schemas/satispayPayment" }, { "$ref": "#/components/schemas/stripePayment" }, { "$ref": "#/components/schemas/wireTransfer" } ] }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "orderResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/order/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "market" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "customer": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "shipping_address": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_address" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "billing_address": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "billing_address" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "store": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "store" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "default_shipping_method": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "default_shipping_method" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "default_payment_method": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "default_payment_method" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "available_payment_methods": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "available_payment_methods" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "available_customer_payment_sources": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "available_customer_payment_sources" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "available_free_skus": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "available_free_skus" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "available_free_bundles": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "available_free_bundles" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_method": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_method" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_source": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_source" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "discount_engine_item": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "discount_engine_item" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "line_items": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "line_item_options": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_item_options" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_reservations": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_reservations" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_line_items": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_line_items" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_transfers": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_transfers" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "shipments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_options": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_options" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "transactions": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "transactions" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "authorizations": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "authorizations" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "captures": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "captures" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "voids": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "voids" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "refunds": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "refunds" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "returns": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "returns" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "order_subscription": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscription" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "order_subscriptions": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscriptions" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "order_factories": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_factories" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "order_copies": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_copies" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "recurring_order_copies": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "recurring_order_copies" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "notifications": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "notifications" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "links": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "links" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "resource_errors": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "resource_errors" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "orderResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/orderResponse/properties/data" } } } }, "organization": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "organization" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The organization's internal name.", "example": "The Blue Brand", "nullable": true }, "slug": { "type": "string", "description": "The organization's slug name.", "example": "the-blue-brand", "nullable": true }, "domain": { "type": "string", "description": "The organization's domain.", "example": "the-blue-brand.commercelayer.io", "nullable": true }, "support_phone": { "type": "string", "description": "The organization's support phone.", "example": "+01 30800857", "nullable": true }, "support_email": { "type": "string", "description": "The organization's support email.", "example": "support@bluebrand.com", "nullable": true }, "logo_url": { "type": "string", "description": "The URL to the organization's logo.", "example": "https://bluebrand.com/img/logo.svg", "nullable": true }, "favicon_url": { "type": "string", "description": "The URL to the organization's favicon.", "example": "https://bluebrand.com/img/favicon.ico", "nullable": true }, "primary_color": { "type": "string", "description": "The organization's primary color.", "example": "#C8984E", "nullable": true }, "gtm_id": { "type": "string", "description": "The organization's Google Tag Manager ID.", "example": "GTM-5FJXX6", "nullable": true }, "gtm_id_test": { "type": "string", "description": "The organization's Google Tag Manager ID for test.", "example": "GTM-5FJXX7", "nullable": true }, "config": { "type": "object", "description": "The organization's configuration.", "example": { "mfe": { "default": { "links": { "cart": "https://cart.example.com/:order_id?accessToken=:access_token", "checkout": "https://checkout.example.com/:order_id?accessToken=:accessToken", "identity": "https://example.com/login", "microstore": "https://example.com/microstore/?accessToken=:access_token", "my_account": "https://example.com/my-custom-account?accessToken=:access_token" }, "checkout": { "thankyou_page": "https://example.com/thanks/:lang/:orderId", "billing_countries": [ { "value": "ES", "label": "Espana" }, { "value": "IT", "label": "Italia" }, { "value": "US", "label": "Unites States of America" } ], "shipping_countries": [ { "value": "ES", "label": "Espana" }, { "value": "IT", "label": "Italia" }, { "value": "US", "label": "Unites States of America" } ], "billing_states": { "FR": [ { "value": "PA", "label": "Paris" }, { "value": "LY", "label": "Lyon" }, { "value": "NI", "label": "Nice" }, { "value": "MA", "label": "Marseille" }, { "value": "BO", "label": "Bordeaux" } ] }, "shipping_states": { "FR": [ { "value": "PA", "label": "Paris" }, { "value": "LY", "label": "Lyon" }, { "value": "NI", "label": "Nice" }, { "value": "MA", "label": "Marseille" }, { "value": "BO", "label": "Bordeaux" } ] }, "default_country": "US" }, "urls": { "privacy": "https://example.com/privacy/:lang", "terms": "https://example.com/terms/:lang" } }, "market:id:ZKcv13rT": { "links": { "cart": "https://example.com/custom-cart/:order_id?accessToken=:access_token" }, "checkout": { "thankyou_page": "https://example.com/thanks/:order_id" } } } }, "nullable": true }, "api_auth_redirect": { "type": "boolean", "description": "Enables the redirect on the new Auth API.", "example": true, "nullable": true }, "api_rules_engine": { "type": "boolean", "description": "Enables the rules engine for flex promotions and price list rules.", "example": false, "nullable": true }, "api_rules_engine_max_conditions_size": { "type": "integer", "description": "The fallback maximum number of conditions within a rules payload on a ruleable object, default is 150.", "example": 150, "nullable": true }, "api_rules_engine_max_rules_size": { "type": "integer", "description": "The fallback maximum number of rules within a rules payload on a ruleable object, default is 15.", "example": 15, "nullable": true }, "api_new_auth": { "type": "boolean", "description": "Forces the usage of the new Authentication API.", "example": true, "nullable": true }, "api_purge_single_resource": { "type": "boolean", "description": "Enables the purge of cached single resources when list is purged.", "example": false, "nullable": true }, "api_max_regex_length": { "type": "integer", "description": "The maximum length for the regular expressions, default is 5000.", "example": 5000, "nullable": true }, "addresses_avs_check": { "type": "boolean", "description": "Indicates if AVS checking will be enforced during payment workflow by passing specific attributes, default is true.", "example": true, "nullable": true }, "addresses_phone_required": { "type": "boolean", "description": "Indicates if the phone attribute is required for addresses, default is true.", "example": true, "nullable": true }, "orders_sales_channel_guest_only": { "type": "boolean", "description": "Indicates if a sales channel application without customer can read and update just guest orders.", "example": true, "nullable": true }, "orders_min_rebuild_shipments_lapse": { "type": "number", "description": "The minimum lapse in fraction of seconds to be observed between two consecutive shipments rebuilt. If shipments rebuilt is triggered within the minimum lapse, the update is performed, but no rebuilt is done.", "example": 0.0, "nullable": true }, "orders_min_refresh_lapse": { "type": "number", "description": "The minimum lapse in fraction of seconds to be observed between two consecutive order refreshes. If refresh is triggered within the minimum lapse, the update is performed, but no order refresh is done.", "example": 0.0, "nullable": true }, "orders_autorefresh_cutoff_test": { "type": "integer", "description": "The maximum number line items allowed for a test order before disabling the autorefresh option.", "example": 50, "nullable": true }, "orders_autorefresh_cutoff_live": { "type": "integer", "description": "The maximum number line items allowed for a live order before disabling the autorefresh option.", "example": 500, "nullable": true }, "orders_number_editable_test": { "type": "boolean", "description": "Enables orders number editing as a string in test (for enterprise plans only).", "example": false, "nullable": true }, "orders_number_editable_live": { "type": "boolean", "description": "Enables orders number editing as a string in live (for enterprise plans only).", "example": false, "nullable": true }, "orders_number_as_reference": { "type": "boolean", "description": "Enables to use the order number as payment reference on supported gateways.", "example": true, "nullable": true }, "orders_invalid_coupon_errors": { "type": "boolean", "description": "Enables raising of API errors in case the provided coupon code is invalid, default is true.", "example": true, "nullable": true }, "orders_invalid_gift_card_errors": { "type": "boolean", "description": "Enables raising of API errors in case the provided gift card code is invalid, default is true.", "example": true, "nullable": true }, "orders_validate_shipping_stock": { "type": "boolean", "description": "Enables the validation of the generated stock line items and stock transfers before placing the order, default is false.", "example": false, "nullable": true }, "bundles_max_items_count": { "type": "integer", "description": "The maximum number of SKUs allowed for bundles, default is 10.", "example": 10, "nullable": true }, "coupons_min_code_length": { "type": "integer", "description": "The minimum length for coupon code, default is 8.", "example": 8, "nullable": true }, "coupons_max_code_length": { "type": "integer", "description": "The maximum length for coupon code, default is 40.", "example": 40, "nullable": true }, "gift_cards_exact_code_matching": { "type": "boolean", "description": "Enables matching the gift card code by its exact value, instead of by its first charachters, default is false.", "example": false, "nullable": true }, "gift_cards_min_code_length": { "type": "integer", "description": "The minimum length for gift card code, default is 8.", "example": 8, "nullable": true }, "gift_cards_max_code_length": { "type": "integer", "description": "The maximum length for gift card code, default is 40.", "example": 40, "nullable": true }, "cleanups_max_concurrent_count": { "type": "integer", "description": "The maximum number of concurrent cleanups allowed for your organization, default is 10.", "example": 10, "nullable": true }, "exports_max_concurrent_count": { "type": "integer", "description": "The maximum number of concurrent exports allowed for your organization, default is 10.", "example": 10, "nullable": true }, "imports_max_concurrent_count": { "type": "integer", "description": "The maximum number of concurrent imports allowed for your organization, default is 10.", "example": 10, "nullable": true }, "imports_purge_cache": { "type": "boolean", "description": "Enables purging of cached resources upon succeeded imports.", "example": true, "nullable": true }, "imports_skip_errors": { "type": "boolean", "description": "Disables the interruption of the import in case its errors exceeds the 10% threshold, default is false.", "example": false, "nullable": true }, "inventory_models_max_stock_locations_cutoff": { "type": "integer", "description": "The maximum number for stock locations cutoff, default is 10.", "example": 10, "nullable": true }, "promotions_max_concurrent_count": { "type": "integer", "description": "The maximum number of active concurrent promotions allowed for your organization, default is 10.", "example": 10, "nullable": true }, "promotions_max_conditions_size": { "type": "integer", "description": "The maximum number of conditions within a rules payload on a promotion object, default is 150.", "example": 150, "nullable": true }, "promotions_max_rules_size": { "type": "integer", "description": "The maximum number of rules within a rules payload on a promotion object, default is 15.", "example": 15, "nullable": true }, "price_lists_max_conditions_size": { "type": "integer", "description": "The maximum number of conditions within a rules payload on a price list object, default is 150.", "example": 150, "nullable": true }, "price_lists_max_rules_size": { "type": "integer", "description": "The maximum number of rules within a rules payload on a price list object, default is 15.", "example": 15, "nullable": true }, "imports_trigger_webhooks": { "type": "integer", "description": "Enables triggering of webhooks during imports, default is false.", "example": 0, "nullable": true }, "discount_engines_enabled": { "type": "boolean", "description": "Enables the use of an external discount engine in place of the standard one, default is false.", "example": false, "nullable": true }, "discount_engines_errors": { "type": "boolean", "description": "Enables raising of API errors in case of discount engine failure, default is false.", "example": false, "nullable": true }, "tags_max_name_length": { "type": "integer", "description": "The maximum length for the tag name, default is 25.", "example": 25, "nullable": true }, "tags_max_allowed_number": { "type": "integer", "description": "The maximum allowed number of tags for each resource, default is 10.", "example": 10, "nullable": true }, "tax_calculators_errors": { "type": "boolean", "description": "Enables raising of API errors in case of tax calculation failure, default is false.", "example": false, "nullable": true }, "external_promotions_errors": { "type": "boolean", "description": "Enables raising of API errors in case of external promotion failure, default is false.", "example": false, "nullable": true }, "external_prices_errors": { "type": "boolean", "description": "Enables raising of API errors in case of external price failure, default is true.", "example": true, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "organizationResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "organization" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/organization/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "organizationResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/organizationResponse/properties/data" } } } }, "package": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "packages" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Unique name for the package.", "example": "Large (60x40x30)", "nullable": false }, "code": { "type": "string", "description": "The package identifying code.", "example": "YYYY 2000", "nullable": true }, "length": { "type": "number", "description": "The package length, used to automatically calculate the tax rates from the available carrier accounts.", "example": 40.0, "nullable": false }, "width": { "type": "number", "description": "The package width, used to automatically calculate the tax rates from the available carrier accounts.", "example": 40.0, "nullable": false }, "height": { "type": "number", "description": "The package height, used to automatically calculate the tax rates from the available carrier accounts.", "example": 25.0, "nullable": false }, "unit_of_length": { "type": "string", "description": "The unit of length. Can be one of 'cm', or 'in'.", "example": "gr", "nullable": false }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "stock_location": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "parcels": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "parcels" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "packageCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "packages" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Unique name for the package.", "example": "Large (60x40x30)" }, "code": { "type": "string", "description": "The package identifying code.", "example": "YYYY 2000" }, "length": { "type": "number", "description": "The package length, used to automatically calculate the tax rates from the available carrier accounts.", "example": 40.0 }, "width": { "type": "number", "description": "The package width, used to automatically calculate the tax rates from the available carrier accounts.", "example": 40.0 }, "height": { "type": "number", "description": "The package height, used to automatically calculate the tax rates from the available carrier accounts.", "example": 25.0 }, "unit_of_length": { "type": "string", "description": "The unit of length. Can be one of 'cm', or 'in'.", "example": "gr" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name", "length", "width", "height", "unit_of_length" ] }, "relationships": { "type": "object", "properties": { "stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "stock_location" ] } } } } }, "packageUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "packages" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Unique name for the package.", "example": "Large (60x40x30)", "nullable": false }, "code": { "type": "string", "description": "The package identifying code.", "example": "YYYY 2000", "nullable": true }, "length": { "type": "number", "description": "The package length, used to automatically calculate the tax rates from the available carrier accounts.", "example": 40.0, "nullable": false }, "width": { "type": "number", "description": "The package width, used to automatically calculate the tax rates from the available carrier accounts.", "example": 40.0, "nullable": false }, "height": { "type": "number", "description": "The package height, used to automatically calculate the tax rates from the available carrier accounts.", "example": 25.0, "nullable": false }, "unit_of_length": { "type": "string", "description": "The unit of length. Can be one of 'cm', or 'in'.", "example": "gr", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "packageResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "packages" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/package/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "stock_location": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_location" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "parcels": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "parcels" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "packageResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/packageResponse/properties/data" } } } }, "parcelLineItem": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "parcel_line_items" ] }, "attributes": { "type": "object", "properties": { "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": true }, "bundle_code": { "type": "string", "description": "The code of the associated bundle.", "example": "BUNDLEMM000000FFFFFFXLXX", "nullable": true }, "quantity": { "type": "integer", "description": "The parcel line item quantity.", "example": 4, "nullable": false }, "name": { "type": "string", "description": "The internal name of the associated line item.", "example": "Men's Black T-shirt with White Logo (XL)", "nullable": true }, "image_url": { "type": "string", "description": "The image_url of the associated line item.", "example": "https://img.yourdomain.com/skus/xYZkjABcde.png", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "parcel": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "parcels" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_line_item": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "parcelLineItemCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "parcel_line_items" ] }, "attributes": { "type": "object", "properties": { "quantity": { "type": "integer", "description": "The parcel line item quantity.", "example": 4 }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "quantity" ] }, "relationships": { "type": "object", "properties": { "parcel": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "parcels" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_line_item": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "parcel", "stock_line_item" ] } } } } }, "parcelLineItemUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "parcel_line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "parcelLineItemResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "parcel_line_items" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/parcelLineItem/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "parcel": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "parcel" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_line_item": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_line_item" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "parcelLineItemResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/parcelLineItemResponse/properties/data" } } } }, "parcel": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "parcels" ] }, "attributes": { "type": "object", "properties": { "number": { "type": "string", "description": "Unique identifier for the parcel.", "example": "#1234/S/001/P/001", "nullable": true }, "weight": { "type": "number", "description": "The parcel weight, used to automatically calculate the tax rates from the available carrier accounts.", "example": 1000.0, "nullable": false }, "unit_of_weight": { "type": "string", "description": "The unit of weight. One of 'gr', 'oz', or 'lb'.", "example": "gr", "nullable": false, "enum": [ "gr", "oz", "lb" ] }, "eel_pfc": { "type": "string", "description": "When shipping outside the US, you need to provide either an Exemption and Exclusion Legend (EEL) code or a Proof of Filing Citation (PFC). Which you need is based on the value of the goods being shipped. Value can be one of \"EEL\" o \"PFC\".", "example": "EEL", "nullable": true }, "contents_type": { "type": "string", "description": "The type of item you are sending.", "example": "merchandise", "nullable": true }, "contents_explanation": { "type": "string", "description": "If you specify 'other' in the 'contents_type' attribute, you must supply a brief description in this attribute.", "example": "", "nullable": true }, "customs_certify": { "type": "boolean", "description": "Indicates if the provided information is accurate.", "example": false, "nullable": true }, "customs_signer": { "type": "string", "description": "This is the name of the person who is certifying that the information provided on the customs form is accurate. Use a name of the person in your organization who is responsible for this.", "example": "John Doe", "nullable": true }, "non_delivery_option": { "type": "string", "description": "In case the shipment cannot be delivered, this option tells the carrier what you want to happen to the parcel. You can pass either 'return', or 'abandon'. The value defaults to 'return'. If you pass 'abandon', you will not receive the parcel back if it cannot be delivered.", "example": "return", "nullable": true }, "restriction_type": { "type": "string", "description": "Describes if your parcel requires any special treatment or quarantine when entering the country. Can be one of 'none', 'other', 'quarantine', or 'sanitary_phytosanitary_inspection'.", "example": "none", "nullable": true }, "restriction_comments": { "type": "string", "description": "If you specify 'other' in the restriction type, you must supply a brief description of what is required.", "example": "", "nullable": true }, "customs_info_required": { "type": "boolean", "description": "Indicates if the parcel requires customs info to get the shipping rates.", "example": false, "nullable": true }, "shipping_label_url": { "type": "string", "description": "The shipping label url, ready to be downloaded and printed.", "example": "https://bucket.s3-us-west-2.amazonaws.com/files/postage_label/20180101/123.pdf", "nullable": true }, "shipping_label_file_type": { "type": "string", "description": "The shipping label file type. One of 'application/pdf', 'application/zpl', 'application/epl2', or 'image/png'.", "example": "application/pdf", "nullable": true }, "shipping_label_size": { "type": "string", "description": "The shipping label size.", "example": "4x7", "nullable": true }, "shipping_label_resolution": { "type": "string", "description": "The shipping label resolution.", "example": "200", "nullable": true }, "tracking_number": { "type": "string", "description": "The tracking number associated to this parcel.", "example": "1Z4V2A000000000000", "nullable": true }, "tracking_status": { "type": "string", "description": "The tracking status for this parcel, automatically updated in real time by the shipping carrier.", "example": "delivered", "nullable": true }, "tracking_status_detail": { "type": "string", "description": "Additional information about the tracking status, automatically updated in real time by the shipping carrier.", "example": "arrived_at_destination", "nullable": true }, "tracking_status_updated_at": { "type": "string", "description": "Time at which the parcel's tracking status was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "tracking_details": { "type": "array", "description": "The parcel's full tracking history, automatically updated in real time by the shipping carrier.", "example": [ { "object": "TrackingDetail", "message": "Pre-Shipment information received", "status": "pre_transit", "datetime": "2018-02-27T16:02:17Z", "source": "DHLExpress", "tracking_location": { "object": "TrackingLocation" } } ], "nullable": true, "items": { "type": "object" } }, "carrier_weight_oz": { "type": "string", "description": "The weight of the parcel as measured by the carrier in ounces (if available).", "example": "42.32", "nullable": true }, "signed_by": { "type": "string", "description": "The name of the person who signed for the parcel (if available).", "example": "John Smith", "nullable": true }, "incoterm": { "type": "string", "description": "The type of Incoterm (if available).", "example": "EXW", "nullable": true }, "delivery_confirmation": { "type": "string", "description": "The type of delivery confirmation option upon delivery.", "example": "SIGNATURE", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "shipment": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "package": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "packages" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "parcel_line_items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "parcel_line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "parcelCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "parcels" ] }, "attributes": { "type": "object", "properties": { "weight": { "type": "number", "description": "The parcel weight, used to automatically calculate the tax rates from the available carrier accounts.", "example": 1000.0 }, "unit_of_weight": { "type": "string", "description": "The unit of weight. One of 'gr', 'oz', or 'lb'.", "example": "gr", "enum": [ "gr", "oz", "lb" ] }, "eel_pfc": { "type": "string", "description": "When shipping outside the US, you need to provide either an Exemption and Exclusion Legend (EEL) code or a Proof of Filing Citation (PFC). Which you need is based on the value of the goods being shipped. Value can be one of \"EEL\" o \"PFC\".", "example": "EEL" }, "contents_type": { "type": "string", "description": "The type of item you are sending.", "example": "merchandise" }, "contents_explanation": { "type": "string", "description": "If you specify 'other' in the 'contents_type' attribute, you must supply a brief description in this attribute.", "example": "" }, "customs_certify": { "type": "boolean", "description": "Indicates if the provided information is accurate.", "example": false }, "customs_signer": { "type": "string", "description": "This is the name of the person who is certifying that the information provided on the customs form is accurate. Use a name of the person in your organization who is responsible for this.", "example": "John Doe" }, "non_delivery_option": { "type": "string", "description": "In case the shipment cannot be delivered, this option tells the carrier what you want to happen to the parcel. You can pass either 'return', or 'abandon'. The value defaults to 'return'. If you pass 'abandon', you will not receive the parcel back if it cannot be delivered.", "example": "return" }, "restriction_type": { "type": "string", "description": "Describes if your parcel requires any special treatment or quarantine when entering the country. Can be one of 'none', 'other', 'quarantine', or 'sanitary_phytosanitary_inspection'.", "example": "none" }, "restriction_comments": { "type": "string", "description": "If you specify 'other' in the restriction type, you must supply a brief description of what is required.", "example": "" }, "customs_info_required": { "type": "boolean", "description": "Indicates if the parcel requires customs info to get the shipping rates.", "example": false }, "shipping_label_url": { "type": "string", "description": "The shipping label url, ready to be downloaded and printed.", "example": "https://bucket.s3-us-west-2.amazonaws.com/files/postage_label/20180101/123.pdf" }, "shipping_label_file_type": { "type": "string", "description": "The shipping label file type. One of 'application/pdf', 'application/zpl', 'application/epl2', or 'image/png'.", "example": "application/pdf" }, "shipping_label_size": { "type": "string", "description": "The shipping label size.", "example": "4x7" }, "shipping_label_resolution": { "type": "string", "description": "The shipping label resolution.", "example": "200" }, "tracking_number": { "type": "string", "description": "The tracking number associated to this parcel.", "example": "1Z4V2A000000000000" }, "tracking_status": { "type": "string", "description": "The tracking status for this parcel, automatically updated in real time by the shipping carrier.", "example": "delivered" }, "tracking_status_detail": { "type": "string", "description": "Additional information about the tracking status, automatically updated in real time by the shipping carrier.", "example": "arrived_at_destination" }, "tracking_status_updated_at": { "type": "string", "description": "Time at which the parcel's tracking status was last updated.", "example": "2018-01-01T12:00:00.000Z" }, "tracking_details": { "type": "array", "description": "The parcel's full tracking history, automatically updated in real time by the shipping carrier.", "example": [ { "object": "TrackingDetail", "message": "Pre-Shipment information received", "status": "pre_transit", "datetime": "2018-02-27T16:02:17Z", "source": "DHLExpress", "tracking_location": { "object": "TrackingLocation" } } ], "items": { "type": "object" } }, "carrier_weight_oz": { "type": "string", "description": "The weight of the parcel as measured by the carrier in ounces (if available).", "example": "42.32" }, "signed_by": { "type": "string", "description": "The name of the person who signed for the parcel (if available).", "example": "John Smith" }, "incoterm": { "type": "string", "description": "The type of Incoterm (if available).", "example": "EXW" }, "delivery_confirmation": { "type": "string", "description": "The type of delivery confirmation option upon delivery.", "example": "SIGNATURE" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "weight", "unit_of_weight" ] }, "relationships": { "type": "object", "properties": { "shipment": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "package": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "packages" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "shipment", "package" ] } } } } }, "parcelUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "parcels" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "weight": { "type": "number", "description": "The parcel weight, used to automatically calculate the tax rates from the available carrier accounts.", "example": 1000.0, "nullable": false }, "unit_of_weight": { "type": "string", "description": "The unit of weight. One of 'gr', 'oz', or 'lb'.", "example": "gr", "nullable": false, "enum": [ "gr", "oz", "lb" ] }, "eel_pfc": { "type": "string", "description": "When shipping outside the US, you need to provide either an Exemption and Exclusion Legend (EEL) code or a Proof of Filing Citation (PFC). Which you need is based on the value of the goods being shipped. Value can be one of \"EEL\" o \"PFC\".", "example": "EEL", "nullable": true }, "contents_type": { "type": "string", "description": "The type of item you are sending.", "example": "merchandise", "nullable": true }, "contents_explanation": { "type": "string", "description": "If you specify 'other' in the 'contents_type' attribute, you must supply a brief description in this attribute.", "example": "", "nullable": true }, "customs_certify": { "type": "boolean", "description": "Indicates if the provided information is accurate.", "example": false, "nullable": false }, "customs_signer": { "type": "string", "description": "This is the name of the person who is certifying that the information provided on the customs form is accurate. Use a name of the person in your organization who is responsible for this.", "example": "John Doe", "nullable": true }, "non_delivery_option": { "type": "string", "description": "In case the shipment cannot be delivered, this option tells the carrier what you want to happen to the parcel. You can pass either 'return', or 'abandon'. The value defaults to 'return'. If you pass 'abandon', you will not receive the parcel back if it cannot be delivered.", "example": "return", "nullable": true }, "restriction_type": { "type": "string", "description": "Describes if your parcel requires any special treatment or quarantine when entering the country. Can be one of 'none', 'other', 'quarantine', or 'sanitary_phytosanitary_inspection'.", "example": "none", "nullable": true }, "restriction_comments": { "type": "string", "description": "If you specify 'other' in the restriction type, you must supply a brief description of what is required.", "example": "", "nullable": true }, "customs_info_required": { "type": "boolean", "description": "Indicates if the parcel requires customs info to get the shipping rates.", "example": false, "nullable": false }, "shipping_label_url": { "type": "string", "description": "The shipping label url, ready to be downloaded and printed.", "example": "https://bucket.s3-us-west-2.amazonaws.com/files/postage_label/20180101/123.pdf", "nullable": true }, "shipping_label_file_type": { "type": "string", "description": "The shipping label file type. One of 'application/pdf', 'application/zpl', 'application/epl2', or 'image/png'.", "example": "application/pdf", "nullable": true }, "shipping_label_size": { "type": "string", "description": "The shipping label size.", "example": "4x7", "nullable": true }, "shipping_label_resolution": { "type": "string", "description": "The shipping label resolution.", "example": "200", "nullable": true }, "tracking_number": { "type": "string", "description": "The tracking number associated to this parcel.", "example": "1Z4V2A000000000000", "nullable": true }, "tracking_status": { "type": "string", "description": "The tracking status for this parcel, automatically updated in real time by the shipping carrier.", "example": "delivered", "nullable": true }, "tracking_status_detail": { "type": "string", "description": "Additional information about the tracking status, automatically updated in real time by the shipping carrier.", "example": "arrived_at_destination", "nullable": true }, "tracking_status_updated_at": { "type": "string", "description": "Time at which the parcel's tracking status was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "tracking_details": { "type": "array", "description": "The parcel's full tracking history, automatically updated in real time by the shipping carrier.", "example": [ { "object": "TrackingDetail", "message": "Pre-Shipment information received", "status": "pre_transit", "datetime": "2018-02-27T16:02:17Z", "source": "DHLExpress", "tracking_location": { "object": "TrackingLocation" } } ], "nullable": true, "items": { "type": "object" } }, "carrier_weight_oz": { "type": "string", "description": "The weight of the parcel as measured by the carrier in ounces (if available).", "example": "42.32", "nullable": true }, "signed_by": { "type": "string", "description": "The name of the person who signed for the parcel (if available).", "example": "John Smith", "nullable": true }, "incoterm": { "type": "string", "description": "The type of Incoterm (if available).", "example": "EXW", "nullable": true }, "delivery_confirmation": { "type": "string", "description": "The type of delivery confirmation option upon delivery.", "example": "SIGNATURE", "nullable": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "shipment": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "package": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "packages" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "parcelResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "parcels" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/parcel/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "shipment": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipment" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "package": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "package" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "parcel_line_items": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "parcel_line_items" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "parcelResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/parcelResponse/properties/data" } } } }, "paymentGateway": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateways" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway", "nullable": false }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true, "nullable": true }, "credential_keys": { "type": "object", "description": "The payment gateway's API credential keys last digits.", "example": { "api_key": "********BW989" }, "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "paymentGatewayResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateways" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/paymentGateway/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "paymentGatewayResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/paymentGatewayResponse/properties/data" } } } }, "paymentMethod": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment method's internal name.", "example": "Stripe Payment", "nullable": true }, "payment_source_type": { "type": "string", "description": "The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.", "example": "stripe_payments", "nullable": false, "enum": [ "adyen_payments", "axerve_payments", "braintree_payments", "checkout_com_payments", "external_payments", "klarna_payments", "paypal_payments", "satispay_payments", "stripe_payments", "wire_transfers" ] }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "moto": { "type": "boolean", "description": "Send this attribute if you want to mark the payment as MOTO, must be supported by payment gateway.", "example": false, "nullable": true }, "require_capture": { "type": "boolean", "description": "Send this attribute if you want to require the payment capture before fulfillment.", "example": true, "nullable": true }, "auto_place": { "type": "boolean", "description": "Send this attribute if you want to automatically place the order upon authorization performed asynchronously.", "example": true, "nullable": true }, "auto_capture": { "type": "boolean", "description": "Send this attribute if you want to automatically capture the payment upon authorization.", "example": false, "nullable": true }, "price_amount_cents": { "type": "integer", "description": "The payment method's price, in cents.", "example": 0, "nullable": false }, "price_amount_float": { "type": "number", "description": "The payment method's price, float.", "example": 0.0, "nullable": true }, "formatted_price_amount": { "type": "string", "description": "The payment method's price, formatted.", "example": "€0,00", "nullable": true }, "auto_capture_max_amount_cents": { "type": "integer", "description": "Send this attribute if you want to limit automatic capture to orders for which the total amount is equal or less than the specified value, in cents.", "example": 0, "nullable": true }, "auto_capture_max_amount_float": { "type": "number", "description": "The automatic capture max amount, float.", "example": 0.0, "nullable": true }, "formatted_auto_capture_max_amount": { "type": "string", "description": "The automatic capture max amount, formatted.", "example": "€0,00", "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_gateway": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "store": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "paymentMethodCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment method's internal name.", "example": "Stripe Payment" }, "payment_source_type": { "type": "string", "description": "The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.", "example": "stripe_payments", "enum": [ "adyen_payments", "axerve_payments", "braintree_payments", "checkout_com_payments", "external_payments", "klarna_payments", "paypal_payments", "satispay_payments", "stripe_payments", "wire_transfers" ] }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR" }, "moto": { "type": "boolean", "description": "Send this attribute if you want to mark the payment as MOTO, must be supported by payment gateway.", "example": false }, "require_capture": { "type": "boolean", "description": "Send this attribute if you want to require the payment capture before fulfillment.", "example": true }, "auto_place": { "type": "boolean", "description": "Send this attribute if you want to automatically place the order upon authorization performed asynchronously.", "example": true }, "auto_capture": { "type": "boolean", "description": "Send this attribute if you want to automatically capture the payment upon authorization.", "example": false }, "price_amount_cents": { "type": "integer", "description": "The payment method's price, in cents.", "example": 0 }, "auto_capture_max_amount_cents": { "type": "integer", "description": "Send this attribute if you want to limit automatic capture to orders for which the total amount is equal or less than the specified value, in cents.", "example": 0 }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "payment_source_type", "price_amount_cents" ] }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_gateway": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "store": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "payment_gateway" ] } } } } }, "paymentMethodUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment method's internal name.", "example": "Stripe Payment", "nullable": true }, "payment_source_type": { "type": "string", "description": "The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.", "example": "stripe_payments", "nullable": false, "enum": [ "adyen_payments", "axerve_payments", "braintree_payments", "checkout_com_payments", "external_payments", "klarna_payments", "paypal_payments", "satispay_payments", "stripe_payments", "wire_transfers" ] }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "moto": { "type": "boolean", "description": "Send this attribute if you want to mark the payment as MOTO, must be supported by payment gateway.", "example": false, "nullable": false }, "require_capture": { "type": "boolean", "description": "Send this attribute if you want to require the payment capture before fulfillment.", "example": true, "nullable": false }, "auto_place": { "type": "boolean", "description": "Send this attribute if you want to automatically place the order upon authorization performed asynchronously.", "example": true, "nullable": false }, "auto_capture": { "type": "boolean", "description": "Send this attribute if you want to automatically capture the payment upon authorization.", "example": false, "nullable": false }, "price_amount_cents": { "type": "integer", "description": "The payment method's price, in cents.", "example": 0, "nullable": false }, "auto_capture_max_amount_cents": { "type": "integer", "description": "Send this attribute if you want to limit automatic capture to orders for which the total amount is equal or less than the specified value, in cents.", "example": 0, "nullable": true }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_gateway": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "store": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "paymentMethodResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/paymentMethod/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "market" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_gateway": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateway" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "store": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "store" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "paymentMethodResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/paymentMethodResponse/properties/data" } } } }, "paymentOption": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_options" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment option's name. Wehn blank is inherited by payment source type.", "example": "Stripe Payment Option", "nullable": true }, "payment_source_type": { "type": "string", "description": "The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.", "example": "stripe_payments", "nullable": false, "enum": [ "adyen_payments", "axerve_payments", "braintree_payments", "checkout_com_payments", "external_payments", "klarna_payments", "paypal_payments", "satispay_payments", "stripe_payments", "wire_transfers" ] }, "data": { "type": "object", "description": "The payment options data to be added to the payment source payload. Check payment specific API for more details.", "example": { "application_fee_amount": 1000, "on_behalf_of": "pm_xxx" }, "nullable": false }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "paymentOptionCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_options" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment option's name. Wehn blank is inherited by payment source type.", "example": "Stripe Payment Option" }, "payment_source_type": { "type": "string", "description": "The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.", "example": "stripe_payments", "enum": [ "adyen_payments", "axerve_payments", "braintree_payments", "checkout_com_payments", "external_payments", "klarna_payments", "paypal_payments", "satispay_payments", "stripe_payments", "wire_transfers" ] }, "data": { "type": "object", "description": "The payment options data to be added to the payment source payload. Check payment specific API for more details.", "example": { "application_fee_amount": 1000, "on_behalf_of": "pm_xxx" } }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "payment_source_type", "data" ] }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "order" ] } } } } }, "paymentOptionUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_options" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment option's name. Wehn blank is inherited by payment source type.", "example": "Stripe Payment Option", "nullable": true }, "data": { "type": "object", "description": "The payment options data to be added to the payment source payload. Check payment specific API for more details.", "example": { "application_fee_amount": 1000, "on_behalf_of": "pm_xxx" }, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "paymentOptionResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_options" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/paymentOption/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "paymentOptionResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/paymentOptionResponse/properties/data" } } } }, "paypalGateway": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "paypal_gateways" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway", "nullable": false }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true, "nullable": true }, "credential_keys": { "type": "object", "description": "The payment gateway's API credential keys last digits.", "example": { "api_key": "********BW989" }, "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "paypal_payments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "paypal_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "paypalGatewayCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "paypal_gateways" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway" }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "_check": { "type": "boolean", "description": "Send this attribute if you want to check the credentials against the payment gateway's APIs.", "example": true }, "client_id": { "type": "string", "description": "The gateway client ID.", "example": "xxxx-yyyy-zzzz" }, "client_secret": { "type": "string", "description": "The gateway client secret.", "example": "xxxx-yyyy-zzzz" } }, "required": [ "name", "client_id", "client_secret" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "paypalGatewayUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "paypal_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway", "nullable": false }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true, "nullable": false }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "_check": { "type": "boolean", "description": "Send this attribute if you want to check the credentials against the payment gateway's APIs.", "example": true, "nullable": false }, "client_id": { "type": "string", "description": "The gateway client ID.", "example": "xxxx-yyyy-zzzz" }, "client_secret": { "type": "string", "description": "The gateway client secret.", "example": "xxxx-yyyy-zzzz" } } }, "relationships": { "type": "object", "properties": { } } } } } }, "paypalGatewayResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "paypal_gateways" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/paypalGateway/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "paypal_payments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "paypal_payments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "paypalGatewayResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/paypalGatewayResponse/properties/data" } } } }, "paypalPayment": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "paypal_payments" ] }, "attributes": { "type": "object", "properties": { "return_url": { "type": "string", "description": "The URL where the payer is redirected after they approve the payment.", "example": "https://yourdomain.com/thankyou", "nullable": false }, "cancel_url": { "type": "string", "description": "The URL where the payer is redirected after they cancel the payment.", "example": "https://yourdomain.com/checkout/payment", "nullable": false }, "note_to_payer": { "type": "string", "description": "A free-form field that you can use to send a note to the payer on PayPal.", "example": "Thank you for shopping with us!", "nullable": true }, "paypal_payer_id": { "type": "string", "description": "The id of the payer that PayPal passes in the return_url.", "example": "ABCDEFGHG123456", "nullable": true }, "name": { "type": "string", "description": "The PayPal payer id (if present).", "example": "ABCDEFGHG123456", "nullable": true }, "paypal_id": { "type": "string", "description": "The id of the PayPal payment object.", "example": "1234567890", "nullable": true }, "status": { "type": "string", "description": "The PayPal payment status. One of 'created', or 'approved'.", "example": "created", "nullable": true, "enum": [ "created", "approved" ] }, "approval_url": { "type": "string", "description": "The URL the customer should be redirected to approve the payment.", "example": "https://www.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-1234567890ABCDEFGHG", "nullable": true }, "mismatched_amounts": { "type": "boolean", "description": "Indicates if the order current amount differs form the one of the created payment intent.", "example": false, "nullable": true }, "payment_instrument": { "type": "object", "description": "Information about the payment instrument used in the transaction.", "example": { "issuer": "cl bank", "card_type": "visa" }, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_gateway": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "paypalPaymentCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "paypal_payments" ] }, "attributes": { "type": "object", "properties": { "return_url": { "type": "string", "description": "The URL where the payer is redirected after they approve the payment.", "example": "https://yourdomain.com/thankyou" }, "cancel_url": { "type": "string", "description": "The URL where the payer is redirected after they cancel the payment.", "example": "https://yourdomain.com/checkout/payment" }, "note_to_payer": { "type": "string", "description": "A free-form field that you can use to send a note to the payer on PayPal.", "example": "Thank you for shopping with us!" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "return_url", "cancel_url" ] }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "order" ] } } } } }, "paypalPaymentUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "paypal_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "paypal_payer_id": { "type": "string", "description": "The id of the payer that PayPal passes in the return_url.", "example": "ABCDEFGHG123456", "nullable": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "paypalPaymentResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "paypal_payments" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/paypalPayment/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_gateway": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateway" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "paypalPaymentResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/paypalPaymentResponse/properties/data" } } } }, "percentageDiscountPromotion": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "percentage_discount_promotions" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion", "nullable": false }, "type": { "type": "string", "description": "The promotion's type.", "example": "percentage_discount_promotions", "nullable": false, "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true, "nullable": true }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2, "nullable": true }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": false }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5, "nullable": true }, "total_usage_count": { "type": "integer", "description": "The number of times this promotion has been applied.", "example": 2, "nullable": true }, "total_usage_reached": { "type": "boolean", "description": "Indicates if the promotion has been applied the total number of allowed times.", "example": false, "nullable": true }, "active": { "type": "boolean", "description": "Indicates if the promotion is active (enabled and not expired).", "example": true, "nullable": true }, "status": { "type": "string", "description": "The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.", "example": "pending", "nullable": true, "enum": [ "disabled", "expired", "pending", "active", "inactive" ] }, "weight": { "type": "integer", "description": "The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.", "example": 112, "nullable": true }, "coupons_count": { "type": "integer", "description": "The total number of coupons created for this promotion.", "example": 2, "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "percentage": { "type": "integer", "description": "The discount percentage to be applied.", "example": 10, "nullable": false } } }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "promotion_rules": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupons": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "skus": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "percentageDiscountPromotionCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "percentage_discount_promotions" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion" }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR" }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2 }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z" }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z" }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5 }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "percentage": { "type": "integer", "description": "The discount percentage to be applied.", "example": 10 } }, "required": [ "name", "starts_at", "expires_at", "percentage" ] }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "percentageDiscountPromotionUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "percentage_discount_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion", "nullable": false }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true, "nullable": false }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2, "nullable": true }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": false }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5, "nullable": true }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "percentage": { "type": "integer", "description": "The discount percentage to be applied.", "example": 10, "nullable": false } } }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "percentageDiscountPromotionResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "percentage_discount_promotions" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/percentageDiscountPromotion/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "market" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "promotion_rules": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion_rules" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "order_amount_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_list_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "coupon_codes_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "custom_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_list": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "coupons": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "skus": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "percentageDiscountPromotionResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/percentageDiscountPromotionResponse/properties/data" } } } }, "pickup": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "pickups" ] }, "attributes": { "type": "object", "properties": { "type": { "type": "string", "description": "The pick up's type.", "example": "easypost_pickups", "nullable": false, "enum": [ "easypost_pickups" ] }, "status": { "type": "string", "description": "The pick up status.", "example": "unknown", "nullable": true }, "internal_id": { "type": "string", "description": "The pick up service internal ID.", "example": "pickup_13e5d7e2a7824432a07975bc553944bc", "nullable": false }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "shipment": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "parcels": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "parcels" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "pickupResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "pickups" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/pickup/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "shipment": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipment" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "parcels": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "parcels" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "pickupResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/pickupResponse/properties/data" } } } }, "priceFrequencyTier": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_frequency_tiers" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The price tier's name.", "example": "six pack", "nullable": false }, "type": { "type": "string", "description": "The price tier's type.", "example": "price_volume_tiers", "nullable": false, "enum": [ "price_volume_tiers", "price_frequency_tiers" ] }, "up_to": { "type": "integer", "description": "The tier upper limit, expressed as the line item frequency in days (or frequency label, ie 'monthly'). When 'null' it means infinity (useful to have an always matching tier).", "example": 7, "nullable": true }, "price_amount_cents": { "type": "integer", "description": "The price of this price tier, in cents.", "example": 1000, "nullable": false }, "price_amount_float": { "type": "number", "description": "The price of this price tier, float.", "example": 10.0, "nullable": true }, "formatted_price_amount": { "type": "string", "description": "The price of this price tier, formatted.", "example": "€10,00", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "price": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "prices" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "priceFrequencyTierCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_frequency_tiers" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The price tier's name.", "example": "six pack" }, "up_to": { "type": "integer", "description": "The tier upper limit, expressed as the line item frequency in days (or frequency label, ie 'monthly'). When 'null' it means infinity (useful to have an always matching tier).", "example": 7 }, "price_amount_cents": { "type": "integer", "description": "The price of this price tier, in cents.", "example": 1000 }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name", "price_amount_cents" ] }, "relationships": { "type": "object", "properties": { "price": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "prices" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "price" ] } } } } }, "priceFrequencyTierUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_frequency_tiers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The price tier's name.", "example": "six pack", "nullable": false }, "up_to": { "type": "integer", "description": "The tier upper limit, expressed as the line item frequency in days (or frequency label, ie 'monthly'). When 'null' it means infinity (useful to have an always matching tier).", "example": 7, "nullable": true }, "price_amount_cents": { "type": "integer", "description": "The price of this price tier, in cents.", "example": 1000, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "price": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "prices" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "priceFrequencyTierResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "price_frequency_tiers" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/priceFrequencyTier/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "price": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "priceFrequencyTierResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/priceFrequencyTierResponse/properties/data" } } } }, "priceListScheduler": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_list_schedulers" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The price list scheduler's internal name.", "example": "FW SALE 2023", "nullable": false }, "starts_at": { "type": "string", "description": "The activation date/time of this price list scheduler.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "expires_at": { "type": "string", "description": "The expiration date/time of this price list scheduler (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": false }, "active": { "type": "boolean", "description": "Indicates if the price list scheduler is active (enabled and not expired).", "example": true, "nullable": true }, "status": { "type": "string", "description": "The price list scheduler status. One of 'disabled', 'expired', 'pending', or 'active'.", "example": "pending", "nullable": true, "enum": [ "disabled", "expired", "pending", "active" ] }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "price_list": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "priceListSchedulerCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_list_schedulers" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The price list scheduler's internal name.", "example": "FW SALE 2023" }, "starts_at": { "type": "string", "description": "The activation date/time of this price list scheduler.", "example": "2018-01-01T12:00:00.000Z" }, "expires_at": { "type": "string", "description": "The expiration date/time of this price list scheduler (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z" }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name", "starts_at", "expires_at" ] }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "price_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "market", "price_list" ] } } } } }, "priceListSchedulerUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_list_schedulers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The price list scheduler's internal name.", "example": "FW SALE 2023", "nullable": false }, "starts_at": { "type": "string", "description": "The activation date/time of this price list scheduler.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "expires_at": { "type": "string", "description": "The expiration date/time of this price list scheduler (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": false }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "price_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "priceListSchedulerResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "price_list_schedulers" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/priceListScheduler/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "market" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "price_list": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_list" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "priceListSchedulerResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/priceListSchedulerResponse/properties/data" } } } }, "priceList": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_lists" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The price list's internal name.", "example": "EU Price list", "nullable": false }, "code": { "type": "string", "description": "A string that you can use to identify the price list (must be unique within the environment).", "example": "europe1", "nullable": true }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": false }, "tax_included": { "type": "boolean", "description": "Indicates if the associated prices include taxes.", "example": true, "nullable": true }, "rule_outcomes": { "type": "object", "description": "The rule outcomes.", "example": [ ], "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "rules": { "type": "object", "description": "The rules (using Rules Engine) to be applied.", "example": { }, "nullable": true }, "resource_payload": { "type": "object", "description": "The payload used to evaluate the rules.", "example": { }, "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "prices": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "prices" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "price_list_schedulers": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_list_schedulers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "priceListCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_lists" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The price list's internal name.", "example": "EU Price list" }, "code": { "type": "string", "description": "A string that you can use to identify the price list (must be unique within the environment).", "example": "europe1" }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR" }, "tax_included": { "type": "boolean", "description": "Indicates if the associated prices include taxes.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "rules": { "type": "object", "description": "The rules (using Rules Engine) to be applied.", "example": { } }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name", "currency_code" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "priceListUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The price list's internal name.", "example": "EU Price list", "nullable": false }, "code": { "type": "string", "description": "A string that you can use to identify the price list (must be unique within the environment).", "example": "europe1", "nullable": true }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": false }, "tax_included": { "type": "boolean", "description": "Indicates if the associated prices include taxes.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "rules": { "type": "object", "description": "The rules (using Rules Engine) to be applied.", "example": { }, "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "priceListResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "price_lists" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/priceList/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "prices": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "prices" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "price_list_schedulers": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_list_schedulers" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "priceListResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/priceListResponse/properties/data" } } } }, "priceTier": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_tiers" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The price tier's name.", "example": "six pack", "nullable": false }, "type": { "type": "string", "description": "The price tier's type.", "example": "price_volume_tiers", "nullable": false, "enum": [ "price_volume_tiers", "price_frequency_tiers" ] }, "up_to": { "type": "number", "description": "The tier upper limit. When 'null' it means infinity (useful to have an always matching tier).", "example": 20.5, "nullable": true }, "price_amount_cents": { "type": "integer", "description": "The price of this price tier, in cents.", "example": 1000, "nullable": false }, "price_amount_float": { "type": "number", "description": "The price of this price tier, float.", "example": 10.0, "nullable": true }, "formatted_price_amount": { "type": "string", "description": "The price of this price tier, formatted.", "example": "€10,00", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "price": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "prices" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "priceTierResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "price_tiers" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/priceTier/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "price": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "priceTierResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/priceTierResponse/properties/data" } } } }, "priceVolumeTier": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_volume_tiers" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The price tier's name.", "example": "six pack", "nullable": false }, "type": { "type": "string", "description": "The price tier's type.", "example": "price_volume_tiers", "nullable": false, "enum": [ "price_volume_tiers", "price_frequency_tiers" ] }, "up_to": { "type": "integer", "description": "The tier upper limit, expressed as the line item quantity. When 'null' it means infinity (useful to have an always matching tier).", "example": 15, "nullable": true }, "price_amount_cents": { "type": "integer", "description": "The price of this price tier, in cents.", "example": 1000, "nullable": false }, "price_amount_float": { "type": "number", "description": "The price of this price tier, float.", "example": 10.0, "nullable": true }, "formatted_price_amount": { "type": "string", "description": "The price of this price tier, formatted.", "example": "€10,00", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "price": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "prices" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "priceVolumeTierCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_volume_tiers" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The price tier's name.", "example": "six pack" }, "up_to": { "type": "integer", "description": "The tier upper limit, expressed as the line item quantity. When 'null' it means infinity (useful to have an always matching tier).", "example": 15 }, "price_amount_cents": { "type": "integer", "description": "The price of this price tier, in cents.", "example": 1000 }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name", "price_amount_cents" ] }, "relationships": { "type": "object", "properties": { "price": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "prices" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "price" ] } } } } }, "priceVolumeTierUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_volume_tiers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The price tier's name.", "example": "six pack", "nullable": false }, "up_to": { "type": "integer", "description": "The tier upper limit, expressed as the line item quantity. When 'null' it means infinity (useful to have an always matching tier).", "example": 15, "nullable": true }, "price_amount_cents": { "type": "integer", "description": "The price of this price tier, in cents.", "example": 1000, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "price": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "prices" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "priceVolumeTierResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "price_volume_tiers" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/priceVolumeTier/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "price": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "priceVolumeTierResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/priceVolumeTierResponse/properties/data" } } } }, "price": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "prices" ] }, "attributes": { "type": "object", "properties": { "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated price list.", "example": "EUR", "nullable": true }, "sku_code": { "type": "string", "description": "The code of the associated SKU. When creating a price, either a valid sku_code or a SKU relationship must be present.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": true }, "amount_cents": { "type": "integer", "description": "The SKU price amount for the associated price list, in cents.", "example": 10000, "nullable": false }, "amount_float": { "type": "number", "description": "The SKU price amount for the associated price list, float.", "example": 100.0, "nullable": true }, "formatted_amount": { "type": "string", "description": "The SKU price amount for the associated price list, formatted.", "example": "€100,00", "nullable": true }, "original_amount_cents": { "type": "integer", "description": "The SKU price amount for the associated price list, in cents before any applied rule.", "example": 10000, "nullable": true }, "formatted_original_amount": { "type": "string", "description": "The SKU price amount for the associated price list, in cents before any applied rule, formatted.", "example": "€100,00", "nullable": true }, "compare_at_amount_cents": { "type": "integer", "description": "The compared price amount, in cents. Useful to display a percentage discount.", "example": 13000, "nullable": true }, "compare_at_amount_float": { "type": "number", "description": "The compared price amount, float.", "example": 130.0, "nullable": true }, "formatted_compare_at_amount": { "type": "string", "description": "The compared price amount, formatted.", "example": "€130,00", "nullable": true }, "rule_outcomes": { "type": "object", "description": "The rule outcomes.", "example": [ ], "nullable": true }, "processed_at": { "type": "string", "description": "Time at which the resource was processed by API.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "rules": { "type": "object", "description": "The rules (using Rules Engine) to be applied.", "example": { }, "nullable": true }, "resource_payload": { "type": "object", "description": "The payload used to evaluate the rules.", "example": { }, "nullable": true }, "jwt_custom_claim": { "type": "object", "description": "The custom_claim attached to the current JWT (if any).", "example": { }, "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "price_list": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "price_tiers": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_tiers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "price_volume_tiers": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_volume_tiers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "price_frequency_tiers": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_frequency_tiers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "jwt_customer": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "jwt_markets": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "jwt_stock_locations": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "priceCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "prices" ] }, "attributes": { "type": "object", "properties": { "sku_code": { "type": "string", "description": "The code of the associated SKU. When creating a price, either a valid sku_code or a SKU relationship must be present.", "example": "TSHIRTMM000000FFFFFFXLXX" }, "amount_cents": { "type": "integer", "description": "The SKU price amount for the associated price list, in cents.", "example": 10000 }, "compare_at_amount_cents": { "type": "integer", "description": "The compared price amount, in cents. Useful to display a percentage discount.", "example": 13000 }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "rules": { "type": "object", "description": "The rules (using Rules Engine) to be applied.", "example": { } }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "amount_cents" ] }, "relationships": { "type": "object", "properties": { "price_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "price_tiers": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_tiers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "price_list", "sku" ] } } } } }, "priceUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "prices" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "sku_code": { "type": "string", "description": "The code of the associated SKU. When creating a price, either a valid sku_code or a SKU relationship must be present.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": true }, "amount_cents": { "type": "integer", "description": "The SKU price amount for the associated price list, in cents.", "example": 10000, "nullable": false }, "compare_at_amount_cents": { "type": "integer", "description": "The compared price amount, in cents. Useful to display a percentage discount.", "example": 13000, "nullable": true }, "processed_at": { "type": "string", "description": "Time at which the resource was processed by API.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "rules": { "type": "object", "description": "The rules (using Rules Engine) to be applied.", "example": { }, "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "price_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "price_tiers": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_tiers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "priceResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "prices" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/price/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "price_list": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_list" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "price_tiers": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_tiers" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "price_volume_tiers": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_volume_tiers" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "price_frequency_tiers": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "price_frequency_tiers" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "jwt_customer": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "jwt_customer" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "jwt_markets": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "jwt_markets" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "jwt_stock_locations": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "jwt_stock_locations" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "priceResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/priceResponse/properties/data" } } } }, "promotionRule": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion_rules" ] }, "attributes": { "type": "object", "properties": { "type": { "type": "string", "description": "The promotion rule's type.", "example": "coupon_codes_promotion_rules", "nullable": false, "enum": [ "order_amount_promotion_rules", "sku_list_promotion_rules", "coupon_codes_promotion_rules", "custom_promotion_rules" ] }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "promotion": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/percentageDiscountPromotion" }, { "$ref": "#/components/schemas/freeShippingPromotion" }, { "$ref": "#/components/schemas/buyXPayYPromotion" }, { "$ref": "#/components/schemas/freeGiftPromotion" }, { "$ref": "#/components/schemas/fixedPricePromotion" }, { "$ref": "#/components/schemas/externalPromotion" }, { "$ref": "#/components/schemas/fixedAmountPromotion" }, { "$ref": "#/components/schemas/flexPromotion" } ] }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "promotionRuleResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion_rules" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/promotionRule/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "promotion": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "promotionRuleResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/promotionRuleResponse/properties/data" } } } }, "promotion": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotions" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The promotion's internal name.", "example": "Personal promotion", "nullable": false }, "type": { "type": "string", "description": "The promotion's type.", "example": "percentage_discount_promotions", "nullable": false, "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "exclusive": { "type": "boolean", "description": "Indicates if the promotion will be applied exclusively, based on its priority score.", "example": true, "nullable": true }, "priority": { "type": "integer", "description": "The priority assigned to the promotion (lower means higher priority).", "example": 2, "nullable": true }, "starts_at": { "type": "string", "description": "The activation date/time of this promotion.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "expires_at": { "type": "string", "description": "The expiration date/time of this promotion (must be after starts_at).", "example": "2018-01-02T12:00:00.000Z", "nullable": false }, "total_usage_limit": { "type": "integer", "description": "The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.", "example": 5, "nullable": true }, "total_usage_count": { "type": "integer", "description": "The number of times this promotion has been applied.", "example": 2, "nullable": true }, "total_usage_reached": { "type": "boolean", "description": "Indicates if the promotion has been applied the total number of allowed times.", "example": false, "nullable": true }, "active": { "type": "boolean", "description": "Indicates if the promotion is active (enabled and not expired).", "example": true, "nullable": true }, "status": { "type": "string", "description": "The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.", "example": "pending", "nullable": true, "enum": [ "disabled", "expired", "pending", "active", "inactive" ] }, "weight": { "type": "integer", "description": "The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.", "example": 112, "nullable": true }, "coupons_count": { "type": "integer", "description": "The total number of coupons created for this promotion.", "example": 2, "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "promotion_rules": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_amount_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupon_codes_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "custom_promotion_rule": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "coupons": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "promotionResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "promotions" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/promotion/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "market" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "promotion_rules": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion_rules" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "order_amount_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_amount_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_list_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "coupon_codes_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupon_codes_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "custom_promotion_rule": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "custom_promotion_rule" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_list": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "coupons": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "coupons" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "promotionResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/promotionResponse/properties/data" } } } }, "recurringOrderCopy": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "recurring_order_copies" ] }, "attributes": { "type": "object", "properties": { "type": { "type": "string", "description": "The order factory's type.", "example": "recurring_order_copies", "nullable": false, "enum": [ "order_copies", "recurring_order_copies" ] }, "status": { "type": "string", "description": "The order factory status. One of 'pending' (default), 'in_progress', 'aborted', 'failed', or 'completed'.", "example": "in_progress", "nullable": false, "enum": [ "pending", "in_progress", "aborted", "failed", "completed" ] }, "started_at": { "type": "string", "description": "Time at which the order copy was started.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "completed_at": { "type": "string", "description": "Time at which the order copy was completed.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "failed_at": { "type": "string", "description": "Time at which the order copy has failed.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "errors_log": { "type": "object", "description": "Contains the order copy errors, if any.", "example": { "status": [ "cannot transition from draft to placed" ] }, "nullable": true }, "errors_count": { "type": "integer", "description": "Indicates the number of copy errors, if any.", "example": 2, "nullable": true }, "place_target_order": { "type": "boolean", "description": "Indicates if the target order must be placed upon copy.", "example": true, "nullable": true }, "reuse_wallet": { "type": "boolean", "description": "Indicates if the payment source within the source order customer's wallet must be copied.", "example": true, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "source_order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "target_order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_subscription": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscriptions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "recurringOrderCopyCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "recurring_order_copies" ] }, "attributes": { "type": "object", "properties": { "place_target_order": { "type": "boolean", "description": "Indicates if the target order must be placed upon copy.", "example": true }, "reuse_wallet": { "type": "boolean", "description": "Indicates if the payment source within the source order customer's wallet must be copied.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } } }, "relationships": { "type": "object", "properties": { "source_order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_subscription": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscriptions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "source_order", "order_subscription" ] } } } } }, "recurringOrderCopyUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "recurring_order_copies" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "recurringOrderCopyResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "recurring_order_copies" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/recurringOrderCopy/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "source_order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "source_order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "target_order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "target_order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "order_subscription": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscription" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "recurringOrderCopyResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/recurringOrderCopyResponse/properties/data" } } } }, "refund": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "refunds" ] }, "attributes": { "type": "object", "properties": { "number": { "type": "string", "description": "The transaction number, auto generated.", "example": "42/T/001", "nullable": false }, "type": { "type": "string", "description": "The transaction's type.", "example": "authorizations", "nullable": false, "enum": [ "authorizations", "voids", "captures", "refunds" ] }, "payment_method_type": { "type": "string", "description": "Information about the payment method used in the transaction.", "example": "credit card", "nullable": true }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated order.", "example": "EUR", "nullable": false }, "amount_cents": { "type": "integer", "description": "The transaction amount, in cents.", "example": 1500, "nullable": false }, "amount_float": { "type": "number", "description": "The transaction amount, float.", "example": 15.0, "nullable": false }, "formatted_amount": { "type": "string", "description": "The transaction amount, formatted.", "example": "€15,00", "nullable": false }, "succeeded": { "type": "boolean", "description": "Indicates if the transaction is successful.", "example": false, "nullable": false }, "message": { "type": "string", "description": "The message returned by the payment gateway.", "example": "Accepted", "nullable": true }, "error_code": { "type": "string", "description": "The error code, if any, returned by the payment gateway.", "example": "00001", "nullable": true }, "error_detail": { "type": "string", "description": "The error detail, if any, returned by the payment gateway.", "example": "Already settled", "nullable": true }, "token": { "type": "string", "description": "The token identifying the transaction, returned by the payment gateway.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "gateway_transaction_id": { "type": "string", "description": "The ID identifying the transaction, returned by the payment gateway.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_source": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_payments", "axerve_payments", "braintree_payments", "checkout_com_payments", "external_payments", "klarna_payments", "paypal_payments", "satispay_payments", "stripe_payments", "wire_transfers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/adyenPayment" }, { "$ref": "#/components/schemas/axervePayment" }, { "$ref": "#/components/schemas/braintreePayment" }, { "$ref": "#/components/schemas/checkoutComPayment" }, { "$ref": "#/components/schemas/externalPayment" }, { "$ref": "#/components/schemas/klarnaPayment" }, { "$ref": "#/components/schemas/paypalPayment" }, { "$ref": "#/components/schemas/satispayPayment" }, { "$ref": "#/components/schemas/stripePayment" }, { "$ref": "#/components/schemas/wireTransfer" } ] }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "reference_capture": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "captures" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "return": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "returns" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "refundUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "refunds" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "succeeded": { "type": "boolean", "description": "Indicates if the transaction is successful.", "example": false, "nullable": false }, "_forward": { "type": "boolean", "description": "Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "refundResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "refunds" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/refund/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_source": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_source" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "reference_capture": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "reference_capture" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "return": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "return" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "refundResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/refundResponse/properties/data" } } } }, "reservedStock": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "reserved_stocks" ] }, "attributes": { "type": "object", "properties": { "quantity": { "type": "integer", "description": "The stock item reserved quantity.", "example": 100, "nullable": false }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "stock_item": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_reservations": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_reservations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "reservedStockResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "reserved_stocks" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/reservedStock/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "stock_item": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_item" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_reservations": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_reservations" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "reservedStockResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/reservedStockResponse/properties/data" } } } }, "resourceError": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "resource_errors" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The resource attribute name related to the error.", "example": "number", "nullable": false }, "code": { "type": "string", "description": "The error code.", "example": "BLANK", "nullable": false }, "message": { "type": "string", "description": "The error message.", "example": "can't be blank", "nullable": false }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "resource": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders", "returns" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/order" }, { "$ref": "#/components/schemas/return" } ] }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "resourceErrorResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "resource_errors" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/resourceError/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "resource": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "resource" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "resourceErrorResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/resourceErrorResponse/properties/data" } } } }, "returnLineItem": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "return_line_items" ] }, "attributes": { "type": "object", "properties": { "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": true }, "bundle_code": { "type": "string", "description": "The code of the associated bundle.", "example": "BUNDLEMM000000FFFFFFXLXX", "nullable": true }, "quantity": { "type": "integer", "description": "The return line item quantity.", "example": 4, "nullable": false }, "name": { "type": "string", "description": "The name of the line item.", "example": "Men's Black T-shirt with White Logo (XL)", "nullable": true }, "image_url": { "type": "string", "description": "The image_url of the associated line item.", "example": "https://img.yourdomain.com/skus/xYZkjABcde.png", "nullable": true }, "total_amount_cents": { "type": "integer", "description": "Calculated as line item unit amount x returned quantity and applied discounts, if any.", "example": 8800, "nullable": true }, "total_amount_float": { "type": "number", "description": "The return line item total amount, float. This can be useful to track the purchase on thrid party systems, e.g Google Analyitcs Enhanced Ecommerce.", "example": 88.0, "nullable": false }, "formatted_total_amount": { "type": "string", "description": "The return line item total amount, formatted. This can be useful to display the amount with currency in you views.", "example": "€88,00", "nullable": true }, "return_reason": { "type": "object", "description": "Set of key-value pairs that you can use to add details about return reason.", "example": { "size": "was wrong" }, "nullable": true }, "restocked_at": { "type": "string", "description": "Time at which the return line item was restocked.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "return": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "returns" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "line_item": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "returnLineItemCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "return_line_items" ] }, "attributes": { "type": "object", "properties": { "quantity": { "type": "integer", "description": "The return line item quantity.", "example": 4 }, "return_reason": { "type": "object", "description": "Set of key-value pairs that you can use to add details about return reason.", "example": { "size": "was wrong" } }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "quantity" ] }, "relationships": { "type": "object", "properties": { "return": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "returns" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "line_item": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "return", "line_item" ] } } } } }, "returnLineItemUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "return_line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "quantity": { "type": "integer", "description": "The return line item quantity.", "example": 4, "nullable": false }, "_restock": { "type": "boolean", "description": "Send this attribute if you want to restock the line item.", "example": true, "nullable": false }, "return_reason": { "type": "object", "description": "Set of key-value pairs that you can use to add details about return reason.", "example": { "size": "was wrong" }, "nullable": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "returnLineItemResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "return_line_items" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/returnLineItem/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "return": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "return" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "line_item": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_item" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "returnLineItemResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/returnLineItemResponse/properties/data" } } } }, "return": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "returns" ] }, "attributes": { "type": "object", "properties": { "number": { "type": "string", "description": "Unique identifier for the return.", "example": "#1234/R/001", "nullable": true }, "status": { "type": "string", "description": "The return status. One of 'draft' (default), 'requested', 'approved', 'cancelled', 'shipped', 'rejected', 'received', or 'refunded'.", "example": "draft", "nullable": false, "enum": [ "draft", "requested", "approved", "cancelled", "shipped", "rejected", "received", "refunded" ] }, "customer_email": { "type": "string", "description": "The email address of the associated customer.", "example": "john@example.com", "nullable": true }, "skus_count": { "type": "integer", "description": "The total number of SKUs in the return's line items. This can be useful to display a preview of the return content.", "example": 2, "nullable": true }, "approved_at": { "type": "string", "description": "Time at which the return was approved.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "cancelled_at": { "type": "string", "description": "Time at which the return was cancelled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "shipped_at": { "type": "string", "description": "Time at which the return was shipped.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "rejected_at": { "type": "string", "description": "Time at which the return was rejected.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "received_at": { "type": "string", "description": "Time at which the return was received.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "refunded_at": { "type": "string", "description": "Time at which the return was refunded.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "archived_at": { "type": "string", "description": "Time at which the resource has been archived.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "estimated_refund_amount_cents": { "type": "integer", "description": "The amount to be refunded, estimated by associated return line items, in cents.", "example": 500, "nullable": true }, "estimated_refund_amount_float": { "type": "number", "description": "The amount to be refunded, estimated by associated return line items, float.", "example": 5.0, "nullable": true }, "formatted_estimated_refund_amount": { "type": "string", "description": "The amount to be refunded, estimated by associated return line items, formatted.", "example": "€5,00", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "customer": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_location": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "origin_address": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "destination_address": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "reference_capture": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "captures" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "reference_refund": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "refunds" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "return_line_items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "return_line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "resource_errors": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "resource_errors" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "returnCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "returns" ] }, "attributes": { "type": "object", "properties": { "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } } }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "reference_capture": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "captures" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "order" ] } } } } }, "returnUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "returns" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "_request": { "type": "boolean", "description": "Send this attribute if you want to activate this return.", "example": true, "nullable": false }, "_approve": { "type": "boolean", "description": "Send this attribute if you want to mark this return as approved.", "example": true, "nullable": false }, "_cancel": { "type": "boolean", "description": "Send this attribute if you want to mark this return as cancelled.", "example": true, "nullable": false }, "_ship": { "type": "boolean", "description": "Send this attribute if you want to mark this return as shipped.", "example": true, "nullable": false }, "_reject": { "type": "boolean", "description": "Send this attribute if you want to mark this return as rejected.", "example": true, "nullable": false }, "_receive": { "type": "boolean", "description": "Send this attribute if you want to mark this return as received.", "example": true, "nullable": false }, "_restock": { "type": "boolean", "description": "Send this attribute if you want to restock all of the return line items.", "example": true, "nullable": false }, "_archive": { "type": "boolean", "description": "Send this attribute if you want to archive the return.", "example": true, "nullable": false }, "_unarchive": { "type": "boolean", "description": "Send this attribute if you want to unarchive the return.", "example": true, "nullable": false }, "_refund": { "type": "boolean", "description": "Send this attribute if you want to create a refund for this return.", "example": true, "nullable": false }, "_refund_amount_cents": { "type": "integer", "description": "Send this attribute as a value in cents to specify the amount to be refunded.", "example": 500 }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "reference_capture": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "captures" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "returnResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "returns" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/return/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "customer": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_location": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_location" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "origin_address": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "origin_address" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "destination_address": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "destination_address" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "reference_capture": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "reference_capture" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "reference_refund": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "reference_refund" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "return_line_items": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "return_line_items" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "resource_errors": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "resource_errors" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "returnResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/returnResponse/properties/data" } } } }, "satispayGateway": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "satispay_gateways" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway", "nullable": false }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true, "nullable": true }, "credential_keys": { "type": "object", "description": "The payment gateway's API credential keys last digits.", "example": { "api_key": "********BW989" }, "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "token": { "type": "string", "description": "Activation code generated from the Satispay Dashboard.", "example": "623ECX", "nullable": false }, "key_id": { "type": "string", "description": "The Satispay API key auto generated basing on activation code.", "example": "xxxx-yyyy-zzzz", "nullable": false }, "webhook_endpoint_url": { "type": "string", "description": "The gateway webhook URL, generated automatically.", "example": "https://core.commercelayer.co/webhook_callbacks/satispay_gateways/xxxxx", "nullable": true } } }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "satispay_payments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "satispay_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "satispayGatewayCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "satispay_gateways" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway" }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "token": { "type": "string", "description": "Activation code generated from the Satispay Dashboard.", "example": "623ECX" } }, "required": [ "name", "token" ] }, "relationships": { "type": "object", "properties": { "satispay_payments": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "satispay_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "satispayGatewayUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "satispay_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway", "nullable": false }, "force_payments": { "type": "boolean", "description": "Indicates if the payment source is forced on the editable order upon receiving a successful event from the gateway.", "example": true, "nullable": false }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "satispay_payments": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "satispay_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "satispayGatewayResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "satispay_gateways" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/satispayGateway/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "satispay_payments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "satispay_payments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "satispayGatewayResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/satispayGatewayResponse/properties/data" } } } }, "satispayPayment": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "satispay_payments" ] }, "attributes": { "type": "object", "properties": { "payment_id": { "type": "string", "description": "The payment unique identifier.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "flow": { "type": "string", "description": "The Satispay payment flow, inspect gateway API details for more information.", "example": "MATCH_CODE", "nullable": true }, "status": { "type": "string", "description": "The Satispay payment status.", "example": "PENDING", "nullable": true }, "redirect_url": { "type": "string", "description": "The url to redirect the customer after the payment flow is completed.", "example": "http://commercelayer.dev/satispay/redirect", "nullable": true }, "payment_url": { "type": "string", "description": "Redirect url to the payment page.", "example": "https://online.satispay.com/pay/xxxx-yyyy-zzzz?redirect_url={redirect_url}", "nullable": true }, "payment_response": { "type": "object", "description": "The Satispay payment response, used to fetch internal data.", "example": { "foo": "bar" }, "nullable": true }, "payment_instrument": { "type": "object", "description": "Information about the payment instrument used in the transaction.", "example": { "issuer": "cl bank", "card_type": "visa" }, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_gateway": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "satispayPaymentCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "satispay_payments" ] }, "attributes": { "type": "object", "properties": { "flow": { "type": "string", "description": "The Satispay payment flow, inspect gateway API details for more information.", "example": "MATCH_CODE" }, "redirect_url": { "type": "string", "description": "The url to redirect the customer after the payment flow is completed.", "example": "http://commercelayer.dev/satispay/redirect" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } } }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "order" ] } } } } }, "satispayPaymentUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "satispay_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "redirect_url": { "type": "string", "description": "The url to redirect the customer after the payment flow is completed.", "example": "http://commercelayer.dev/satispay/redirect", "nullable": true }, "_refresh": { "type": "boolean", "description": "Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "satispayPaymentResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "satispay_payments" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/satispayPayment/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_gateway": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateway" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "satispayPaymentResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/satispayPaymentResponse/properties/data" } } } }, "shipment": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipments" ] }, "attributes": { "type": "object", "properties": { "number": { "type": "string", "description": "Unique identifier for the shipment. Cannot be passed by sales channels.", "example": "#1234/S/001", "nullable": false }, "status": { "type": "string", "description": "The shipment status. One of 'draft' (default), 'upcoming', 'cancelled', 'on_hold', 'picking', 'packing', 'ready_to_ship', 'shipped', or 'delivered'.", "example": "draft", "nullable": false, "enum": [ "draft", "upcoming", "cancelled", "on_hold", "picking", "packing", "ready_to_ship", "shipped", "delivered" ] }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard, automatically inherited from the associated order.", "example": "EUR", "nullable": true }, "cost_amount_cents": { "type": "integer", "description": "The cost of this shipment from the selected carrier account, in cents.", "example": 1000, "nullable": true }, "cost_amount_float": { "type": "number", "description": "The cost of this shipment from the selected carrier account, float.", "example": 10.0, "nullable": true }, "formatted_cost_amount": { "type": "string", "description": "The cost of this shipment from the selected carrier account, formatted.", "example": "€10,00", "nullable": true }, "skus_count": { "type": "integer", "description": "The total number of SKUs in the shipment's line items. This can be useful to display a preview of the shipment content.", "example": 2, "nullable": true }, "selected_rate_id": { "type": "string", "description": "The selected purchase rate from the available shipping rates.", "example": "rate_f89e4663c3ed47ee94d37763f6d21d54", "nullable": true }, "rates": { "type": "array", "description": "The available shipping rates.", "example": [ { "id": "rate_f89e4663c3ed47ee94d37763f6d21d54", "rate": "45.59", "carrier": "DHLExpress", "service": "MedicalExpress" } ], "nullable": true, "items": { "type": "object" } }, "purchase_error_code": { "type": "string", "description": "The shipping rate purchase error code, if any.", "example": "SHIPMENT.POSTAGE.FAILURE", "nullable": true }, "purchase_error_message": { "type": "string", "description": "The shipping rate purchase error message, if any.", "example": "Account not allowed for this service.", "nullable": true }, "get_rates_errors": { "type": "array", "description": "Any errors collected when fetching shipping rates.", "example": [ { "carrier": "DHLExpress", "message": "to_address.postal_code: Shorter than minimum length 3", "type": "rate_error" } ], "nullable": true, "items": { "type": "object" } }, "get_rates_started_at": { "type": "string", "description": "Time at which the getting of the shipping rates started.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "get_rates_completed_at": { "type": "string", "description": "Time at which the getting of the shipping rates completed.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "purchase_started_at": { "type": "string", "description": "Time at which the purchasing of the shipping rate started.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "purchase_completed_at": { "type": "string", "description": "Time at which the purchasing of the shipping rate completed.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "purchase_failed_at": { "type": "string", "description": "Time at which the purchasing of the shipping rate failed.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "on_hold_at": { "type": "string", "description": "Time at which the shipment was put on hold.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "picking_at": { "type": "string", "description": "Time at which the shipment was picking.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "packing_at": { "type": "string", "description": "Time at which the shipment was packing.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "ready_to_ship_at": { "type": "string", "description": "Time at which the shipment was ready to ship.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "shipped_at": { "type": "string", "description": "Time at which the shipment was shipped.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "delivered_at": { "type": "string", "description": "Time at which the shipment was delivered.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_category": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_categories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "inventory_stock_location": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_location": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "origin_address": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_address": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_method": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "delivery_lead_time": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "delivery_lead_times" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "pickup": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "pickups" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_line_items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_transfers": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_transfers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "line_items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "available_shipping_methods": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "carrier_accounts": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "carrier_accounts" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "parcels": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "parcels" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "shipmentCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipments" ] }, "attributes": { "type": "object", "properties": { "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } } }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_category": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_categories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "inventory_stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_address": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_method": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "order", "inventory_stock_location" ] } } } } }, "shipmentUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "number": { "type": "string", "description": "Unique identifier for the shipment. Cannot be passed by sales channels.", "example": "#1234/S/001", "nullable": false }, "_upcoming": { "type": "boolean", "description": "Send this attribute if you want to mark this shipment as upcoming. Cannot be passed by sales channels.", "example": true, "nullable": false }, "_cancel": { "type": "boolean", "description": "Send this attribute if you want to mark this shipment as cancelled (unless already shipped or delivered). Cannot be passed by sales channels.", "example": true, "nullable": false }, "_on_hold": { "type": "boolean", "description": "Send this attribute if you want to put this shipment on hold.", "example": true, "nullable": false }, "_picking": { "type": "boolean", "description": "Send this attribute if you want to start picking this shipment.", "example": true, "nullable": false }, "_packing": { "type": "boolean", "description": "Send this attribute if you want to start packing this shipment.", "example": true, "nullable": false }, "_ready_to_ship": { "type": "boolean", "description": "Send this attribute if you want to mark this shipment as ready to ship.", "example": true, "nullable": false }, "_ship": { "type": "boolean", "description": "Send this attribute if you want to mark this shipment as shipped.", "example": true, "nullable": false }, "_deliver": { "type": "boolean", "description": "Send this attribute if you want to mark this shipment as delivered.", "example": true, "nullable": false }, "_reserve_stock": { "type": "boolean", "description": "Send this attribute if you want to automatically reserve the stock for each of the associated stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels.", "example": true, "nullable": false }, "_release_stock": { "type": "boolean", "description": "Send this attribute if you want to automatically destroy the stock reservations for each of the associated stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels.", "example": true, "nullable": false }, "_decrement_stock": { "type": "boolean", "description": "Send this attribute if you want to automatically decrement and release the stock for each of the associated stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels.", "example": true, "nullable": false }, "_get_rates": { "type": "boolean", "description": "Send this attribute if you want get the shipping rates from the associated carrier accounts.", "example": true, "nullable": false }, "selected_rate_id": { "type": "string", "description": "The selected purchase rate from the available shipping rates.", "example": "rate_f89e4663c3ed47ee94d37763f6d21d54", "nullable": true }, "_purchase": { "type": "boolean", "description": "Send this attribute if you want to purchase this shipment with the selected rate.", "example": true, "nullable": false }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "shipping_category": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_categories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "inventory_stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_address": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_method": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "shipmentResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "shipments" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/shipment/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "shipping_category": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_category" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "inventory_stock_location": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_stock_location" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_location": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_location" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "origin_address": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "origin_address" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "shipping_address": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_address" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "shipping_method": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_method" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "delivery_lead_time": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "delivery_lead_time" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "pickup": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "pickup" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_line_items": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_line_items" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_transfers": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_transfers" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "line_items": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "available_shipping_methods": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "available_shipping_methods" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "carrier_accounts": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "carrier_accounts" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "parcels": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "parcels" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "shipmentResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/shipmentResponse/properties/data" } } } }, "shippingCategory": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_categories" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The shipping category name.", "example": "Merchandise", "nullable": false }, "code": { "type": "string", "description": "A string that you can use to identify the shipping category (must be unique within the environment).", "example": "europe1", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "skus": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "shippingCategoryCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_categories" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The shipping category name.", "example": "Merchandise" }, "code": { "type": "string", "description": "A string that you can use to identify the shipping category (must be unique within the environment).", "example": "europe1" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "shippingCategoryUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_categories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The shipping category name.", "example": "Merchandise", "nullable": false }, "code": { "type": "string", "description": "A string that you can use to identify the shipping category (must be unique within the environment).", "example": "europe1", "nullable": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "shippingCategoryResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_categories" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/shippingCategory/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "skus": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "shippingCategoryResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/shippingCategoryResponse/properties/data" } } } }, "shippingMethodTier": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_method_tiers" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The shipping method tier's name.", "example": "Light shipping under 3kg", "nullable": false }, "type": { "type": "string", "description": "The shipping method tier's type.", "example": "shipping_weight_tiers", "nullable": false, "enum": [ "shipping_weight_tiers" ] }, "up_to": { "type": "number", "description": "The tier upper limit. When 'null' it means infinity (useful to have an always matching tier).", "example": 20.5, "nullable": true }, "price_amount_cents": { "type": "integer", "description": "The price of this shipping method tier, in cents.", "example": 1000, "nullable": false }, "price_amount_float": { "type": "number", "description": "The price of this shipping method tier, float.", "example": 10.0, "nullable": true }, "formatted_price_amount": { "type": "string", "description": "The price of this shipping method tier, formatted.", "example": "€10,00", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "shipping_method": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "shippingMethodTierResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_method_tiers" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/shippingMethodTier/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "shipping_method": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_method" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "shippingMethodTierResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/shippingMethodTierResponse/properties/data" } } } }, "shippingMethod": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_methods" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The shipping method's name.", "example": "Standard shipping", "nullable": false }, "scheme": { "type": "string", "description": "The shipping method's scheme. One of 'flat', 'weight_tiered', or 'external'.", "example": "flat", "nullable": true, "enum": [ "flat", "weight_tiered", "external" ] }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "external_prices_url": { "type": "string", "description": "The URL used to overwrite prices by an external source.", "example": "https://external_prices.yourbrand.com", "nullable": true }, "price_amount_cents": { "type": "integer", "description": "The price of this shipping method, in cents.", "example": 1000, "nullable": false }, "price_amount_float": { "type": "number", "description": "The price of this shipping method, float.", "example": 10.0, "nullable": true }, "formatted_price_amount": { "type": "string", "description": "The price of this shipping method, formatted.", "example": "€10,00", "nullable": true }, "free_over_amount_cents": { "type": "integer", "description": "Apply free shipping if the order amount is over this value, in cents.", "example": 9900, "nullable": true }, "free_over_amount_float": { "type": "number", "description": "Apply free shipping if the order amount is over this value, float.", "example": 99.0, "nullable": true }, "formatted_free_over_amount": { "type": "string", "description": "Apply free shipping if the order amount is over this value, formatted.", "example": "€99,00", "nullable": true }, "use_subtotal": { "type": "boolean", "description": "Send this attribute if you want to compare the free over amount with order's subtotal (excluding discounts, if any).", "example": true, "nullable": true }, "price_amount_for_shipment_cents": { "type": "integer", "description": "The calculated price (zero or price amount) when associated to a shipment, in cents.", "example": 0, "nullable": true }, "price_amount_for_shipment_float": { "type": "number", "description": "The calculated price (zero or price amount) when associated to a shipment, float.", "example": 0.0, "nullable": true }, "formatted_price_amount_for_shipment": { "type": "string", "description": "The calculated price (zero or price amount) when associated to a shipment, formatted.", "example": "€0,00", "nullable": true }, "min_weight": { "type": "number", "description": "The minimum weight for which this shipping method is available.", "example": 3.0, "nullable": true }, "max_weight": { "type": "number", "description": "The maximum weight for which this shipping method is available.", "example": 300.0, "nullable": true }, "unit_of_weight": { "type": "string", "description": "The unit of weight. One of 'gr', 'oz', or 'lb'.", "example": "gr", "nullable": true, "enum": [ "gr", "oz", "lb" ] }, "tax_code": { "type": "string", "description": "The freight tax identifier code, specific for a particular tax calculator.", "example": "FR010000", "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "circuit_state": { "type": "string", "description": "The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made.", "example": "closed", "nullable": true }, "circuit_failure_count": { "type": "integer", "description": "The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback.", "example": 5, "nullable": true }, "shared_secret": { "type": "string", "description": "The shared secret used to sign the external request payload.", "example": "1c0994cc4e996e8c6ee56a2198f66f3c", "nullable": false }, "external_includes": { "type": "array", "description": "List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.", "example": [ "order.line_item_options" ], "nullable": true, "items": { "type": "string" } }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_zone": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_zones" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_category": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_categories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_location": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "delivery_lead_time_for_shipment": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "delivery_lead_times" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_method_tiers": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_method_tiers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_weight_tiers": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_weight_tiers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "notifications": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "notifications" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "shippingMethodCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_methods" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The shipping method's name.", "example": "Standard shipping" }, "scheme": { "type": "string", "description": "The shipping method's scheme. One of 'flat', 'weight_tiered', or 'external'.", "example": "flat", "enum": [ "flat", "weight_tiered", "external" ] }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR" }, "external_prices_url": { "type": "string", "description": "The URL used to overwrite prices by an external source.", "example": "https://external_prices.yourbrand.com" }, "price_amount_cents": { "type": "integer", "description": "The price of this shipping method, in cents.", "example": 1000 }, "free_over_amount_cents": { "type": "integer", "description": "Apply free shipping if the order amount is over this value, in cents.", "example": 9900 }, "use_subtotal": { "type": "boolean", "description": "Send this attribute if you want to compare the free over amount with order's subtotal (excluding discounts, if any).", "example": true }, "min_weight": { "type": "number", "description": "The minimum weight for which this shipping method is available.", "example": 3.0 }, "max_weight": { "type": "number", "description": "The maximum weight for which this shipping method is available.", "example": 300.0 }, "unit_of_weight": { "type": "string", "description": "The unit of weight. One of 'gr', 'oz', or 'lb'.", "example": "gr", "enum": [ "gr", "oz", "lb" ] }, "tax_code": { "type": "string", "description": "The freight tax identifier code, specific for a particular tax calculator.", "example": "FR010000" }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "external_includes": { "type": "array", "description": "List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.", "example": [ "order.line_item_options" ], "items": { "type": "string" } }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name", "price_amount_cents" ] }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_zone": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_zones" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_category": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_categories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_method_tiers": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_method_tiers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "shippingMethodUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The shipping method's name.", "example": "Standard shipping", "nullable": false }, "scheme": { "type": "string", "description": "The shipping method's scheme. One of 'flat', 'weight_tiered', or 'external'.", "example": "flat", "nullable": true, "enum": [ "flat", "weight_tiered", "external" ] }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "external_prices_url": { "type": "string", "description": "The URL used to overwrite prices by an external source.", "example": "https://external_prices.yourbrand.com", "nullable": true }, "price_amount_cents": { "type": "integer", "description": "The price of this shipping method, in cents.", "example": 1000, "nullable": false }, "free_over_amount_cents": { "type": "integer", "description": "Apply free shipping if the order amount is over this value, in cents.", "example": 9900, "nullable": true }, "use_subtotal": { "type": "boolean", "description": "Send this attribute if you want to compare the free over amount with order's subtotal (excluding discounts, if any).", "example": true, "nullable": false }, "min_weight": { "type": "number", "description": "The minimum weight for which this shipping method is available.", "example": 3.0, "nullable": true }, "max_weight": { "type": "number", "description": "The maximum weight for which this shipping method is available.", "example": 300.0, "nullable": true }, "unit_of_weight": { "type": "string", "description": "The unit of weight. One of 'gr', 'oz', or 'lb'.", "example": "gr", "nullable": true, "enum": [ "gr", "oz", "lb" ] }, "tax_code": { "type": "string", "description": "The freight tax identifier code, specific for a particular tax calculator.", "example": "FR010000", "nullable": true }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "_reset_circuit": { "type": "boolean", "description": "Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.", "example": true, "nullable": false }, "external_includes": { "type": "array", "description": "List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided.", "example": [ "order.line_item_options" ], "nullable": true, "items": { "type": "string" } }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_zone": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_zones" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_category": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_categories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipping_method_tiers": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_method_tiers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "shippingMethodResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_methods" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/shippingMethod/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "market" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "shipping_zone": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_zone" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "shipping_category": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_category" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_location": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_location" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "delivery_lead_time_for_shipment": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "delivery_lead_time_for_shipment" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "shipping_method_tiers": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_method_tiers" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "shipping_weight_tiers": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_weight_tiers" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "notifications": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "notifications" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "shippingMethodResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/shippingMethodResponse/properties/data" } } } }, "shippingWeightTier": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_weight_tiers" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The shipping method tier's name.", "example": "Light shipping under 3kg", "nullable": false }, "type": { "type": "string", "description": "The shipping method tier's type.", "example": "shipping_weight_tiers", "nullable": false, "enum": [ "shipping_weight_tiers" ] }, "up_to": { "type": "number", "description": "The tier upper limit. When 'null' it means infinity (useful to have an always matching tier).", "example": 20.5, "nullable": true }, "price_amount_cents": { "type": "integer", "description": "The price of this shipping method tier, in cents.", "example": 1000, "nullable": false }, "price_amount_float": { "type": "number", "description": "The price of this shipping method tier, float.", "example": 10.0, "nullable": true }, "formatted_price_amount": { "type": "string", "description": "The price of this shipping method tier, formatted.", "example": "€10,00", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "shipping_method": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "shippingWeightTierCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_weight_tiers" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The shipping method tier's name.", "example": "Light shipping under 3kg" }, "up_to": { "type": "number", "description": "The tier upper limit. When 'null' it means infinity (useful to have an always matching tier).", "example": 20.5 }, "price_amount_cents": { "type": "integer", "description": "The price of this shipping method tier, in cents.", "example": 1000 }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name", "price_amount_cents" ] }, "relationships": { "type": "object", "properties": { "shipping_method": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "shipping_method" ] } } } } }, "shippingWeightTierUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_weight_tiers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The shipping method tier's name.", "example": "Light shipping under 3kg", "nullable": false }, "up_to": { "type": "number", "description": "The tier upper limit. When 'null' it means infinity (useful to have an always matching tier).", "example": 20.5, "nullable": true }, "price_amount_cents": { "type": "integer", "description": "The price of this shipping method tier, in cents.", "example": 1000, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "shipping_method": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "shippingWeightTierResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_weight_tiers" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/shippingWeightTier/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "shipping_method": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_method" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "shippingWeightTierResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/shippingWeightTierResponse/properties/data" } } } }, "shippingZone": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_zones" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The shipping zone's internal name.", "example": "Europe (main countries)", "nullable": false }, "country_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the shipping address country code, max size is 5000.", "example": "AT|BE|BG|CZ|DK|EE|DE|HU|LV|LT", "nullable": true }, "not_country_code_regex": { "type": "string", "description": "The regex that will be evaluated as negative match for the shipping address country code, max size is 5000.", "example": "AT|BE|BG|CZ|DK|EE|DE", "nullable": true }, "state_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the shipping address state code, max size is 5000.", "example": "A[KLRZ]|C[AOT]|D[CE]|FL", "nullable": true }, "not_state_code_regex": { "type": "string", "description": "The regex that will be evaluated as negative match for the shipping address state code, max size is 5000.", "example": "A[KLRZ]|C[AOT]", "nullable": true }, "zip_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the shipping address zip code, max size is 5000.", "example": "(?i)(JE1|JE2|JE3|JE4|JE5)", "nullable": true }, "not_zip_code_regex": { "type": "string", "description": "The regex that will be evaluated as negative match for the shipping zip country code, max size is 5000.", "example": "(?i)(JE1|JE2|JE3)", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "shippingZoneCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_zones" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The shipping zone's internal name.", "example": "Europe (main countries)" }, "country_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the shipping address country code, max size is 5000.", "example": "AT|BE|BG|CZ|DK|EE|DE|HU|LV|LT" }, "not_country_code_regex": { "type": "string", "description": "The regex that will be evaluated as negative match for the shipping address country code, max size is 5000.", "example": "AT|BE|BG|CZ|DK|EE|DE" }, "state_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the shipping address state code, max size is 5000.", "example": "A[KLRZ]|C[AOT]|D[CE]|FL" }, "not_state_code_regex": { "type": "string", "description": "The regex that will be evaluated as negative match for the shipping address state code, max size is 5000.", "example": "A[KLRZ]|C[AOT]" }, "zip_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the shipping address zip code, max size is 5000.", "example": "(?i)(JE1|JE2|JE3|JE4|JE5)" }, "not_zip_code_regex": { "type": "string", "description": "The regex that will be evaluated as negative match for the shipping zip country code, max size is 5000.", "example": "(?i)(JE1|JE2|JE3)" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "shippingZoneUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_zones" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The shipping zone's internal name.", "example": "Europe (main countries)", "nullable": false }, "country_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the shipping address country code, max size is 5000.", "example": "AT|BE|BG|CZ|DK|EE|DE|HU|LV|LT", "nullable": true }, "not_country_code_regex": { "type": "string", "description": "The regex that will be evaluated as negative match for the shipping address country code, max size is 5000.", "example": "AT|BE|BG|CZ|DK|EE|DE", "nullable": true }, "state_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the shipping address state code, max size is 5000.", "example": "A[KLRZ]|C[AOT]|D[CE]|FL", "nullable": true }, "not_state_code_regex": { "type": "string", "description": "The regex that will be evaluated as negative match for the shipping address state code, max size is 5000.", "example": "A[KLRZ]|C[AOT]", "nullable": true }, "zip_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the shipping address zip code, max size is 5000.", "example": "(?i)(JE1|JE2|JE3|JE4|JE5)", "nullable": true }, "not_zip_code_regex": { "type": "string", "description": "The regex that will be evaluated as negative match for the shipping zip country code, max size is 5000.", "example": "(?i)(JE1|JE2|JE3)", "nullable": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "shippingZoneResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_zones" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/shippingZone/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "shippingZoneResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/shippingZoneResponse/properties/data" } } } }, "skuListItem": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_items" ] }, "attributes": { "type": "object", "properties": { "position": { "type": "integer", "description": "The SKU list item's position.", "example": 2, "nullable": true }, "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": true }, "quantity": { "type": "integer", "description": "The SKU quantity for this SKU list item.", "example": 1, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "sku_list": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "skuListItemCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_items" ] }, "attributes": { "type": "object", "properties": { "position": { "type": "integer", "description": "The SKU list item's position.", "example": 2 }, "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX" }, "quantity": { "type": "integer", "description": "The SKU quantity for this SKU list item.", "example": 1 }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } } }, "relationships": { "type": "object", "properties": { "sku_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "sku_list", "sku" ] } } } } }, "skuListItemUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "position": { "type": "integer", "description": "The SKU list item's position.", "example": 2, "nullable": true }, "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": true }, "quantity": { "type": "integer", "description": "The SKU quantity for this SKU list item.", "example": 1, "nullable": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "skuListItemResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_items" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/skuListItem/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "sku_list": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "skuListItemResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/skuListItemResponse/properties/data" } } } }, "skuListPromotionRule": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "attributes": { "type": "object", "properties": { "type": { "type": "string", "description": "The promotion rule's type.", "example": "coupon_codes_promotion_rules", "nullable": false, "enum": [ "order_amount_promotion_rules", "sku_list_promotion_rules", "coupon_codes_promotion_rules", "custom_promotion_rules" ] }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "all_skus": { "type": "boolean", "description": "Indicates if the rule is activated only when all of the SKUs of the list is also part of the order.", "example": true, "nullable": true }, "min_quantity": { "type": "integer", "description": "The min quantity of SKUs of the list that must be also part of the order. If positive, overwrites the 'all_skus' option. When the SKU list is manual, its items quantities are honoured.", "example": 3, "nullable": true } } }, "relationships": { "type": "object", "properties": { "promotion": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/percentageDiscountPromotion" }, { "$ref": "#/components/schemas/freeShippingPromotion" }, { "$ref": "#/components/schemas/buyXPayYPromotion" }, { "$ref": "#/components/schemas/freeGiftPromotion" }, { "$ref": "#/components/schemas/fixedPricePromotion" }, { "$ref": "#/components/schemas/externalPromotion" }, { "$ref": "#/components/schemas/fixedAmountPromotion" }, { "$ref": "#/components/schemas/flexPromotion" } ] }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "skus": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "skuListPromotionRuleCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "attributes": { "type": "object", "properties": { "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "all_skus": { "type": "boolean", "description": "Indicates if the rule is activated only when all of the SKUs of the list is also part of the order.", "example": true }, "min_quantity": { "type": "integer", "description": "The min quantity of SKUs of the list that must be also part of the order. If positive, overwrites the 'all_skus' option. When the SKU list is manual, its items quantities are honoured.", "example": 3 } } }, "relationships": { "type": "object", "properties": { "promotion": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/percentageDiscountPromotion" }, { "$ref": "#/components/schemas/freeShippingPromotion" }, { "$ref": "#/components/schemas/buyXPayYPromotion" }, { "$ref": "#/components/schemas/freeGiftPromotion" }, { "$ref": "#/components/schemas/fixedPricePromotion" }, { "$ref": "#/components/schemas/externalPromotion" }, { "$ref": "#/components/schemas/fixedAmountPromotion" }, { "$ref": "#/components/schemas/flexPromotion" } ] }, "sku_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "promotion" ] } } } } }, "skuListPromotionRuleUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "all_skus": { "type": "boolean", "description": "Indicates if the rule is activated only when all of the SKUs of the list is also part of the order.", "example": true, "nullable": false }, "min_quantity": { "type": "integer", "description": "The min quantity of SKUs of the list that must be also part of the order. If positive, overwrites the 'all_skus' option. When the SKU list is manual, its items quantities are honoured.", "example": 3, "nullable": true } } }, "relationships": { "type": "object", "properties": { "promotion": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "percentage_discount_promotions", "free_shipping_promotions", "buy_x_pay_y_promotions", "free_gift_promotions", "fixed_price_promotions", "external_promotions", "fixed_amount_promotions", "flex_promotions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/percentageDiscountPromotion" }, { "$ref": "#/components/schemas/freeShippingPromotion" }, { "$ref": "#/components/schemas/buyXPayYPromotion" }, { "$ref": "#/components/schemas/freeGiftPromotion" }, { "$ref": "#/components/schemas/fixedPricePromotion" }, { "$ref": "#/components/schemas/externalPromotion" }, { "$ref": "#/components/schemas/fixedAmountPromotion" }, { "$ref": "#/components/schemas/flexPromotion" } ] }, "sku_list": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "skuListPromotionRuleResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_promotion_rules" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/skuListPromotionRule/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "promotion": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "promotion" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_list": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "skus": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "skuListPromotionRuleResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/skuListPromotionRuleResponse/properties/data" } } } }, "skuList": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The SKU list's internal name.", "example": "Personal list", "nullable": false }, "slug": { "type": "string", "description": "The SKU list's internal slug.", "example": "personal-list-1", "nullable": false }, "description": { "type": "string", "description": "An internal description of the SKU list.", "example": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", "nullable": true }, "image_url": { "type": "string", "description": "The URL of an image that represents the SKU list.", "example": "https://img.yourdomain.com/skus/xYZkjABcde.png", "nullable": true }, "manual": { "type": "boolean", "description": "Indicates if the SKU list is populated manually.", "example": false, "nullable": true }, "sku_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the SKU codes, max size is 5000.", "example": "^(A|B).*$", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "customer": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "skus": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "bundles": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "bundles" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "links": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "links" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "skuListCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The SKU list's internal name.", "example": "Personal list" }, "description": { "type": "string", "description": "An internal description of the SKU list.", "example": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." }, "image_url": { "type": "string", "description": "The URL of an image that represents the SKU list.", "example": "https://img.yourdomain.com/skus/xYZkjABcde.png" }, "manual": { "type": "boolean", "description": "Indicates if the SKU list is populated manually.", "example": false }, "sku_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the SKU codes, max size is 5000.", "example": "^(A|B).*$" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { "customer": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "skuListUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The SKU list's internal name.", "example": "Personal list", "nullable": false }, "description": { "type": "string", "description": "An internal description of the SKU list.", "example": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", "nullable": true }, "image_url": { "type": "string", "description": "The URL of an image that represents the SKU list.", "example": "https://img.yourdomain.com/skus/xYZkjABcde.png", "nullable": true }, "manual": { "type": "boolean", "description": "Indicates if the SKU list is populated manually.", "example": false, "nullable": false }, "sku_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the SKU codes, max size is 5000.", "example": "^(A|B).*$", "nullable": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "customer": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "skuListResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/skuList/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "customer": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customer" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "skus": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_list_items": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_items" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "bundles": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "bundles" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "links": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "links" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "skuListResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/skuListResponse/properties/data" } } } }, "skuOption": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_options" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The SKU option's internal name.", "example": "Embossing", "nullable": false }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "description": { "type": "string", "description": "An internal description of the SKU option.", "example": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", "nullable": true }, "price_amount_cents": { "type": "integer", "description": "The price of this shipping method, in cents.", "example": 1000, "nullable": true }, "price_amount_float": { "type": "number", "description": "The price of this shipping method, float.", "example": 10.0, "nullable": true }, "formatted_price_amount": { "type": "string", "description": "The price of this shipping method, formatted.", "example": "€10,00", "nullable": true }, "delay_hours": { "type": "integer", "description": "The delay time (in hours) that should be added to the delivery lead time when this option is purchased.", "example": 48, "nullable": true }, "delay_days": { "type": "integer", "description": "The delay time, in days (rounded).", "example": 2, "nullable": true }, "sku_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the SKU codes, max size is 5000.", "example": "^(A|B).*$", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "skuOptionCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_options" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The SKU option's internal name.", "example": "Embossing" }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR" }, "description": { "type": "string", "description": "An internal description of the SKU option.", "example": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." }, "price_amount_cents": { "type": "integer", "description": "The price of this shipping method, in cents.", "example": 1000 }, "delay_hours": { "type": "integer", "description": "The delay time (in hours) that should be added to the delivery lead time when this option is purchased.", "example": 48 }, "sku_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the SKU codes, max size is 5000.", "example": "^(A|B).*$" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "skuOptionUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_options" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The SKU option's internal name.", "example": "Embossing", "nullable": false }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard.", "example": "EUR", "nullable": true }, "description": { "type": "string", "description": "An internal description of the SKU option.", "example": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", "nullable": true }, "price_amount_cents": { "type": "integer", "description": "The price of this shipping method, in cents.", "example": 1000, "nullable": true }, "delay_hours": { "type": "integer", "description": "The delay time (in hours) that should be added to the delivery lead time when this option is purchased.", "example": 48, "nullable": true }, "sku_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the SKU codes, max size is 5000.", "example": "^(A|B).*$", "nullable": true }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "skuOptionResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_options" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/skuOption/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "market" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "skuOptionResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/skuOptionResponse/properties/data" } } } }, "sku": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "attributes": { "type": "object", "properties": { "code": { "type": "string", "description": "The SKU code, that uniquely identifies the SKU within the organization.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": false }, "name": { "type": "string", "description": "The internal name of the SKU.", "example": "Men's Black T-shirt with White Logo (XL)", "nullable": false }, "description": { "type": "string", "description": "An internal description of the SKU.", "example": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", "nullable": true }, "image_url": { "type": "string", "description": "The URL of an image that represents the SKU.", "example": "https://img.yourdomain.com/skus/xYZkjABcde.png", "nullable": true }, "pieces_per_pack": { "type": "integer", "description": "The number of pieces that compose the SKU. This is useful to describe sets and bundles.", "example": 6, "nullable": true }, "weight": { "type": "number", "description": "The weight of the SKU. If present, it will be used to calculate the shipping rates.", "example": 300.0, "nullable": true }, "unit_of_weight": { "type": "string", "description": "The unit of weight. One of 'gr', 'oz', or 'lb'.", "example": "gr", "nullable": true, "enum": [ "gr", "oz", "lb" ] }, "hs_tariff_number": { "type": "string", "description": "The Harmonized System Code used by customs to identify the products shipped across international borders.", "example": "4901.91.0020", "nullable": true }, "do_not_ship": { "type": "boolean", "description": "Indicates if the SKU doesn't generate shipments.", "example": false, "nullable": true }, "do_not_track": { "type": "boolean", "description": "Indicates if the SKU doesn't track the stock inventory.", "example": false, "nullable": true }, "inventory": { "type": "object", "description": "Aggregated information about the SKU's inventory. Returned only when retrieving a single SKU.", "example": { "available": true, "quantity": 10, "levels": [ { "quantity": 4, "delivery_lead_times": [ { "shipping_method": { "name": "Standard Shipping", "reference": null, "price_amount_cents": 700, "free_over_amount_cents": 9900, "formatted_price_amount": "€7,00", "formatted_free_over_amount": "€99,00" }, "min": { "hours": 72, "days": 3 }, "max": { "hours": 120, "days": 5 } }, { "shipping_method": { "name": "Express Delivery", "reference": null, "price_amount_cents": 1200, "free_over_amount_cents": null, "formatted_price_amount": "€12,00", "formatted_free_over_amount": null }, "min": { "hours": 48, "days": 2 }, "max": { "hours": 72, "days": 3 } } ] }, { "quantity": 6, "delivery_lead_times": [ { "shipping_method": { "name": "Standard Shipping", "reference": null, "price_amount_cents": 700, "free_over_amount_cents": 9900, "formatted_price_amount": "€7,00", "formatted_free_over_amount": "€99,00" }, "min": { "hours": 96, "days": 4 }, "max": { "hours": 144, "days": 6 } }, { "shipping_method": { "name": "Express Delivery", "reference": null, "price_amount_cents": 1200, "free_over_amount_cents": null, "formatted_price_amount": "€12,00", "formatted_free_over_amount": null }, "min": { "hours": 72, "days": 3 }, "max": { "hours": 96, "days": 4 } } ] } ] }, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "jwt_custom_claim": { "type": "object", "description": "The custom_claim attached to the current JWT (if any).", "example": { }, "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "shipping_category": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_categories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "prices": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "prices" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_reservations": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_reservations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "delivery_lead_times": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "delivery_lead_times" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_options": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_options" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_list_items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku_lists": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "links": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "links" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "jwt_customer": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "customers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "jwt_markets": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "jwt_stock_locations": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "skuCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "attributes": { "type": "object", "properties": { "code": { "type": "string", "description": "The SKU code, that uniquely identifies the SKU within the organization.", "example": "TSHIRTMM000000FFFFFFXLXX" }, "name": { "type": "string", "description": "The internal name of the SKU.", "example": "Men's Black T-shirt with White Logo (XL)" }, "description": { "type": "string", "description": "An internal description of the SKU.", "example": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." }, "image_url": { "type": "string", "description": "The URL of an image that represents the SKU.", "example": "https://img.yourdomain.com/skus/xYZkjABcde.png" }, "pieces_per_pack": { "type": "integer", "description": "The number of pieces that compose the SKU. This is useful to describe sets and bundles.", "example": 6 }, "weight": { "type": "number", "description": "The weight of the SKU. If present, it will be used to calculate the shipping rates.", "example": 300.0 }, "unit_of_weight": { "type": "string", "description": "The unit of weight. One of 'gr', 'oz', or 'lb'.", "example": "gr", "enum": [ "gr", "oz", "lb" ] }, "hs_tariff_number": { "type": "string", "description": "The Harmonized System Code used by customs to identify the products shipped across international borders.", "example": "4901.91.0020" }, "do_not_ship": { "type": "boolean", "description": "Indicates if the SKU doesn't generate shipments.", "example": false }, "do_not_track": { "type": "boolean", "description": "Indicates if the SKU doesn't track the stock inventory.", "example": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "code", "name" ] }, "relationships": { "type": "object", "properties": { "shipping_category": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_categories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "shipping_category" ] } } } } }, "skuUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "code": { "type": "string", "description": "The SKU code, that uniquely identifies the SKU within the organization.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": false }, "name": { "type": "string", "description": "The internal name of the SKU.", "example": "Men's Black T-shirt with White Logo (XL)", "nullable": false }, "description": { "type": "string", "description": "An internal description of the SKU.", "example": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", "nullable": true }, "image_url": { "type": "string", "description": "The URL of an image that represents the SKU.", "example": "https://img.yourdomain.com/skus/xYZkjABcde.png", "nullable": true }, "pieces_per_pack": { "type": "integer", "description": "The number of pieces that compose the SKU. This is useful to describe sets and bundles.", "example": 6, "nullable": true }, "weight": { "type": "number", "description": "The weight of the SKU. If present, it will be used to calculate the shipping rates.", "example": 300.0, "nullable": true }, "unit_of_weight": { "type": "string", "description": "The unit of weight. One of 'gr', 'oz', or 'lb'.", "example": "gr", "nullable": true, "enum": [ "gr", "oz", "lb" ] }, "hs_tariff_number": { "type": "string", "description": "The Harmonized System Code used by customs to identify the products shipped across international borders.", "example": "4901.91.0020", "nullable": true }, "do_not_ship": { "type": "boolean", "description": "Indicates if the SKU doesn't generate shipments.", "example": false, "nullable": false }, "do_not_track": { "type": "boolean", "description": "Indicates if the SKU doesn't track the stock inventory.", "example": false, "nullable": false }, "_add_tags": { "type": "string", "description": "Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "_remove_tags": { "type": "string", "description": "Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels." }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "shipping_category": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_categories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tags": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "skuResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/sku/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "shipping_category": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipping_category" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "prices": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "prices" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_items": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_items" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_reservations": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_reservations" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "delivery_lead_times": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "delivery_lead_times" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_options": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_options" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_list_items": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_list_items" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku_lists": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku_lists" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "links": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "links" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tags": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "jwt_customer": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "jwt_customer" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "jwt_markets": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "jwt_markets" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "jwt_stock_locations": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "jwt_stock_locations" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "skuResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/skuResponse/properties/data" } } } }, "stockItem": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_items" ] }, "attributes": { "type": "object", "properties": { "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": true }, "quantity": { "type": "integer", "description": "The stock item quantity.", "example": 100, "nullable": false }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "stock_location": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "reserved_stock": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "reserved_stocks" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_reservations": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_reservations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "stockItemCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_items" ] }, "attributes": { "type": "object", "properties": { "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX" }, "quantity": { "type": "integer", "description": "The stock item quantity.", "example": 100 }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "quantity" ] }, "relationships": { "type": "object", "properties": { "stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "stock_location" ] } } } } }, "stockItemUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": true }, "quantity": { "type": "integer", "description": "The stock item quantity.", "example": 100, "nullable": false }, "_validate": { "type": "boolean", "description": "Send this attribute if you want to validate the stock item quantity against the existing reserved stock one, returns an error in case the former is smaller. Cannot be passed by sales channels.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "stockItemResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_items" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/stockItem/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "stock_location": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_location" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "reserved_stock": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "reserved_stock" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_reservations": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_reservations" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "stockItemResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/stockItemResponse/properties/data" } } } }, "stockLineItem": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_line_items" ] }, "attributes": { "type": "object", "properties": { "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": true }, "bundle_code": { "type": "string", "description": "The code of the associated bundle.", "example": "BUNDLEMM000000FFFFFFXLXX", "nullable": true }, "quantity": { "type": "integer", "description": "The line item quantity.", "example": 4, "nullable": false }, "name": { "type": "string", "description": "The internal name of the associated line item.", "example": "Men's Black T-shirt with White Logo (XL)", "nullable": true }, "image_url": { "type": "string", "description": "The image_url of the associated line item.", "example": "https://img.yourdomain.com/skus/xYZkjABcde.png", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "shipment": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "line_item": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_item": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_reservation": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_reservations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "stockLineItemCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_line_items" ] }, "attributes": { "type": "object", "properties": { "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX" }, "quantity": { "type": "integer", "description": "The line item quantity.", "example": 4 }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "quantity" ] }, "relationships": { "type": "object", "properties": { "shipment": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "line_item": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_item": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "stockLineItemUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": true }, "quantity": { "type": "integer", "description": "The line item quantity.", "example": 4, "nullable": false }, "_reserve_stock": { "type": "boolean", "description": "Send this attribute if you want to automatically reserve the stock for this stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels.", "example": true, "nullable": false }, "_release_stock": { "type": "boolean", "description": "Send this attribute if you want to automatically destroy the stock reservation for this stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels.", "example": true, "nullable": false }, "_decrement_stock": { "type": "boolean", "description": "Send this attribute if you want to automatically decrement and release the stock this stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "shipment": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "line_item": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_item": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "stockLineItemResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_line_items" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/stockLineItem/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "shipment": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipment" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "line_item": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_item" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_item": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_item" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_reservation": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_reservation" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "stockLineItemResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/stockLineItemResponse/properties/data" } } } }, "stockLocation": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "attributes": { "type": "object", "properties": { "number": { "type": "integer", "description": "Unique identifier for the stock location (numeric).", "example": 1234, "nullable": true }, "name": { "type": "string", "description": "The stock location's internal name.", "example": "Primary warehouse", "nullable": false }, "code": { "type": "string", "description": "A string that you can use to identify the stock location (must be unique within the environment).", "example": "europe1", "nullable": true }, "label_format": { "type": "string", "description": "The shipping label format for this stock location. Can be one of 'PDF', 'ZPL', 'EPL2', or 'PNG'.", "example": "PDF", "nullable": true }, "suppress_etd": { "type": "boolean", "description": "Flag it if you want to skip the electronic invoice creation when generating the customs info for this stock location shipments.", "example": false, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "address": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "inventory_stock_locations": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "inventory_return_locations": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_return_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_transfers": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_transfers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "stockLocationCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The stock location's internal name.", "example": "Primary warehouse" }, "code": { "type": "string", "description": "A string that you can use to identify the stock location (must be unique within the environment).", "example": "europe1" }, "label_format": { "type": "string", "description": "The shipping label format for this stock location. Can be one of 'PDF', 'ZPL', 'EPL2', or 'PNG'.", "example": "PDF" }, "suppress_etd": { "type": "boolean", "description": "Flag it if you want to skip the electronic invoice creation when generating the customs info for this stock location shipments.", "example": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { "address": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "address" ] } } } } }, "stockLocationUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The stock location's internal name.", "example": "Primary warehouse", "nullable": false }, "code": { "type": "string", "description": "A string that you can use to identify the stock location (must be unique within the environment).", "example": "europe1", "nullable": true }, "label_format": { "type": "string", "description": "The shipping label format for this stock location. Can be one of 'PDF', 'ZPL', 'EPL2', or 'PNG'.", "example": "PDF", "nullable": true }, "suppress_etd": { "type": "boolean", "description": "Flag it if you want to skip the electronic invoice creation when generating the customs info for this stock location shipments.", "example": false, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "address": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "addresses" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "stockLocationResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/stockLocation/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "address": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "address" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "inventory_stock_locations": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_stock_locations" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "inventory_return_locations": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "inventory_return_locations" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_items": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_items" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_transfers": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_transfers" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "stockLocationResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/stockLocationResponse/properties/data" } } } }, "stockReservation": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_reservations" ] }, "attributes": { "type": "object", "properties": { "status": { "type": "string", "description": "The stock reservation status. One of 'draft' (default), or 'pending'.", "example": "draft", "nullable": false, "enum": [ "draft", "pending" ] }, "quantity": { "type": "integer", "description": "The stock reservation quantity.", "example": 4, "nullable": false }, "expires_at": { "type": "string", "description": "The expiration date/time of this stock reservation.", "example": "2018-01-02T12:00:00.000Z", "nullable": false }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "line_item": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_line_item": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_transfer": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_transfers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_item": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "reserved_stock": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "reserved_stocks" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "sku": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "stockReservationCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_reservations" ] }, "attributes": { "type": "object", "properties": { "quantity": { "type": "integer", "description": "The stock reservation quantity.", "example": 4 }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "quantity" ] }, "relationships": { "type": "object", "properties": { "stock_item": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "stock_item" ] } } } } }, "stockReservationUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_reservations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "quantity": { "type": "integer", "description": "The stock reservation quantity.", "example": 4, "nullable": false }, "_pending": { "type": "boolean", "description": "Send this attribute if you want to mark this stock reservation as pending.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "stockReservationResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_reservations" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/stockReservation/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "line_item": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_item" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_line_item": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_line_item" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_transfer": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_transfer" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_item": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_item" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "reserved_stock": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "reserved_stock" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "sku": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "stockReservationResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/stockReservationResponse/properties/data" } } } }, "stockTransfer": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_transfers" ] }, "attributes": { "type": "object", "properties": { "number": { "type": "string", "description": "Unique identifier for the stock transfer (numeric).", "example": "1234", "nullable": true }, "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": true }, "status": { "type": "string", "description": "The stock transfer status. One of 'draft' (default), 'upcoming', 'on_hold', 'picking', 'in_transit', 'completed', or 'cancelled'.", "example": "draft", "nullable": false, "enum": [ "draft", "upcoming", "on_hold", "picking", "in_transit", "completed", "cancelled" ] }, "quantity": { "type": "integer", "description": "The stock quantity to be transferred from the origin stock location to destination one. Updatable unless stock transfer is completed or cancelled and depending on origin stock availability.", "example": 2, "nullable": false }, "on_hold_at": { "type": "string", "description": "Time at which the stock transfer was put on hold.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "picking_at": { "type": "string", "description": "Time at which the stock transfer was picking.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "in_transit_at": { "type": "string", "description": "Time at which the stock transfer was in transit.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "completed_at": { "type": "string", "description": "Time at which the stock transfer was completed.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "cancelled_at": { "type": "string", "description": "Time at which the stock transfer was cancelled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "sku": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "origin_stock_location": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "destination_stock_location": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipment": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "line_item": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_reservation": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_reservations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "stockTransferCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_transfers" ] }, "attributes": { "type": "object", "properties": { "number": { "type": "string", "description": "Unique identifier for the stock transfer (numeric).", "example": "1234" }, "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX" }, "quantity": { "type": "integer", "description": "The stock quantity to be transferred from the origin stock location to destination one. Updatable unless stock transfer is completed or cancelled and depending on origin stock availability.", "example": 2 }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "quantity" ] }, "relationships": { "type": "object", "properties": { "sku": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "origin_stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "destination_stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipment": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "line_item": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "sku", "origin_stock_location", "destination_stock_location" ] } } } } }, "stockTransferUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_transfers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "number": { "type": "string", "description": "Unique identifier for the stock transfer (numeric).", "example": "1234", "nullable": true }, "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": true }, "quantity": { "type": "integer", "description": "The stock quantity to be transferred from the origin stock location to destination one. Updatable unless stock transfer is completed or cancelled and depending on origin stock availability.", "example": 2, "nullable": false }, "_upcoming": { "type": "boolean", "description": "Send this attribute if you want to mark this stock transfer as upcoming.", "example": true, "nullable": false }, "_on_hold": { "type": "boolean", "description": "Send this attribute if you want to put this stock transfer on hold.", "example": true, "nullable": false }, "_picking": { "type": "boolean", "description": "Send this attribute if you want to start picking this stock transfer.", "example": true, "nullable": false }, "_in_transit": { "type": "boolean", "description": "Send this attribute if you want to mark this stock transfer as in transit.", "example": true, "nullable": false }, "_complete": { "type": "boolean", "description": "Send this attribute if you want to complete this stock transfer.", "example": true, "nullable": false }, "_cancel": { "type": "boolean", "description": "Send this attribute if you want to cancel this stock transfer.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "sku": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "origin_stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "destination_stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "shipment": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "line_item": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "stockTransferResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_transfers" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/stockTransfer/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "sku": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "origin_stock_location": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "origin_stock_location" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "destination_stock_location": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "destination_stock_location" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "shipment": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "shipment" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "line_item": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "line_item" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_reservation": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_reservation" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "stockTransferResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/stockTransferResponse/properties/data" } } } }, "store": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stores" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The store's internal name.", "example": "Rome Shop", "nullable": false }, "code": { "type": "string", "description": "A string that you can use to identify the store (must be unique within the environment).", "example": "europe1", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "merchant": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "merchants" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_location": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "orders": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_methods": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "storeCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stores" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The store's internal name.", "example": "Rome Shop" }, "code": { "type": "string", "description": "A string that you can use to identify the store (must be unique within the environment).", "example": "europe1" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "merchant": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "merchants" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "market" ] } } } } }, "storeUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The store's internal name.", "example": "Rome Shop", "nullable": false }, "code": { "type": "string", "description": "A string that you can use to identify the store (must be unique within the environment).", "example": "europe1", "nullable": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "market": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "merchant": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "merchants" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stock_location": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_locations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "storeResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "stores" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/store/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "market": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "market" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "merchant": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "merchant" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stock_location": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stock_location" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "orders": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_methods": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "storeResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/storeResponse/properties/data" } } } }, "stripeGateway": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stripe_gateways" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway", "nullable": false }, "force_payments": { "type": "boolean", "example": false, "nullable": true }, "credential_keys": { "type": "object", "description": "The payment gateway's API credential keys last digits.", "example": { "api_key": "********BW989" }, "nullable": true }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "connected_account": { "type": "string", "description": "The account (if any) for which the funds of the PaymentIntent are intended.", "example": "acct_xxxx-yyyy-zzzz", "nullable": true }, "auto_payments": { "type": "boolean", "description": "Indicates if the gateway will accept payment methods enabled in the Stripe dashboard.", "example": true, "nullable": true }, "webhook_endpoint_id": { "type": "string", "description": "The gateway webhook endpoint ID, generated automatically.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "webhook_endpoint_secret": { "type": "string", "description": "The gateway webhook endpoint secret, generated automatically.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "webhook_endpoint_url": { "type": "string", "description": "The gateway webhook URL, generated automatically.", "example": "https://core.commercelayer.co/webhook_callbacks/stripe_gateways/xxxxx", "nullable": true } } }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "stripe_payments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stripe_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "stripeGatewayCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stripe_gateways" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway" }, "force_payments": { "type": "boolean", "example": false }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "_check": { "type": "boolean", "description": "Send this attribute if you want to check the credentials against the payment gateway's APIs.", "example": true }, "login": { "type": "string", "description": "The gateway login.", "example": "sk_live_xxxx-yyyy-zzzz" }, "publishable_key": { "type": "string", "description": "The gateway publishable API key.", "example": "pk_live_xxxx-yyyy-zzzz" }, "connected_account": { "type": "string", "description": "The account (if any) for which the funds of the PaymentIntent are intended.", "example": "acct_xxxx-yyyy-zzzz" }, "auto_payments": { "type": "boolean", "description": "Indicates if the gateway will accept payment methods enabled in the Stripe dashboard.", "example": true } }, "required": [ "name", "login" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "stripeGatewayUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stripe_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The payment gateway's internal name.", "example": "US payment gateway", "nullable": false }, "force_payments": { "type": "boolean", "example": false, "nullable": false }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "_check": { "type": "boolean", "description": "Send this attribute if you want to check the credentials against the payment gateway's APIs.", "example": true, "nullable": false }, "connected_account": { "type": "string", "description": "The account (if any) for which the funds of the PaymentIntent are intended.", "example": "acct_xxxx-yyyy-zzzz", "nullable": true }, "auto_payments": { "type": "boolean", "description": "Indicates if the gateway will accept payment methods enabled in the Stripe dashboard.", "example": true, "nullable": false } } }, "relationships": { "type": "object", "properties": { } } } } } }, "stripeGatewayResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "stripe_gateways" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/stripeGateway/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "payment_methods": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_methods" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "stripe_payments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stripe_payments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "stripeGatewayResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/stripeGatewayResponse/properties/data" } } } }, "stripePayment": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stripe_payments" ] }, "attributes": { "type": "object", "properties": { "stripe_id": { "type": "string", "description": "The Stripe payment intent ID. Required to identify a payment session on stripe.", "example": "pi_1234XXX", "nullable": true }, "client_secret": { "type": "string", "description": "The Stripe payment intent client secret. Required to create a charge through Stripe.js.", "example": "pi_1234XXX_secret_5678YYY", "nullable": true }, "connected_account": { "type": "string", "description": "The account (if any) for which the funds of the PaymentIntent are intended.", "example": "acct_xxxx-yyyy-zzzz", "nullable": true }, "charge_id": { "type": "string", "description": "The Stripe charge ID. Identifies money movement upon the payment intent confirmation.", "example": "ch_1234XXX", "nullable": true }, "publishable_key": { "type": "string", "description": "The Stripe publishable API key.", "example": "pk_live_xxxx-yyyy-zzzz", "nullable": true }, "on_behalf_of": { "type": "string", "description": "The Stripe account ID that these funds are intended for.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "transfer_group": { "type": "string", "description": "A string that identifies the resulting payment as part of a group.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "options": { "type": "object", "description": "Stripe payment options: 'customer', 'payment_method', 'return_url', etc. Check Stripe payment intent API for more details.", "example": { "customer": "cus_xxx", "payment_method": "pm_xxx" }, "nullable": true }, "payment_method": { "type": "object", "description": "Stripe 'payment_method', set by webhook.", "example": { "id": "pm_xxx" }, "nullable": true }, "mismatched_amounts": { "type": "boolean", "description": "Indicates if the order current amount differs form the one of the created payment intent.", "example": false, "nullable": true }, "return_url": { "type": "string", "description": "The URL to return to when a redirect payment is completed.", "example": "https://yourdomain.com/thankyou", "nullable": true }, "receipt_email": { "type": "string", "description": "The email address to send the receipt to.", "example": "john@example.com", "nullable": true }, "payment_instrument": { "type": "object", "description": "Information about the payment instrument used in the transaction.", "example": { "issuer": "cl bank", "card_type": "visa" }, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_gateway": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateways" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "stripePaymentCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stripe_payments" ] }, "attributes": { "type": "object", "properties": { "stripe_id": { "type": "string", "description": "The Stripe payment intent ID. Required to identify a payment session on stripe.", "example": "pi_1234XXX" }, "client_secret": { "type": "string", "description": "The Stripe payment intent client secret. Required to create a charge through Stripe.js.", "example": "pi_1234XXX_secret_5678YYY" }, "options": { "type": "object", "description": "Stripe payment options: 'customer', 'payment_method', 'return_url', etc. Check Stripe payment intent API for more details.", "example": { "customer": "cus_xxx", "payment_method": "pm_xxx" } }, "return_url": { "type": "string", "description": "The URL to return to when a redirect payment is completed.", "example": "https://yourdomain.com/thankyou" }, "receipt_email": { "type": "string", "description": "The email address to send the receipt to.", "example": "john@example.com" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } } }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "order" ] } } } } }, "stripePaymentUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stripe_payments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "options": { "type": "object", "description": "Stripe payment options: 'customer', 'payment_method', 'return_url', etc. Check Stripe payment intent API for more details.", "example": { "customer": "cus_xxx", "payment_method": "pm_xxx" }, "nullable": true }, "return_url": { "type": "string", "description": "The URL to return to when a redirect payment is completed.", "example": "https://yourdomain.com/thankyou", "nullable": true }, "_update": { "type": "boolean", "description": "Send this attribute if you want to update the created payment intent with fresh order data.", "example": true, "nullable": false }, "_refresh": { "type": "boolean", "description": "Send this attribute if you want to refresh the payment status, can be used as webhooks fallback logic.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "stripePaymentResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "stripe_payments" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/stripePayment/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_gateway": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_gateway" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "stripePaymentResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/stripePaymentResponse/properties/data" } } } }, "stripeTaxAccount": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stripe_tax_accounts" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax calculator's internal name.", "example": "Personal tax calculator", "nullable": false }, "type": { "type": "string", "description": "The tax calculator's type.", "example": "avalara_accounts", "nullable": false, "enum": [ "avalara_accounts", "stripe_tax_accounts", "vertex_accounts", "taxjar_accounts", "manual_tax_calculators", "external_tax_calculators" ] }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "commit_invoice": { "type": "boolean", "description": "Indicates if the transaction will be recorded and visible on the Stripe website.", "example": true, "nullable": true } } }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tax_categories": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_categories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "stripeTaxAccountCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stripe_tax_accounts" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax calculator's internal name.", "example": "Personal tax calculator" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "api_key": { "type": "string", "description": "The Stripe account API key.", "example": "STRIPE_API_KEY" }, "commit_invoice": { "type": "boolean", "description": "Indicates if the transaction will be recorded and visible on the Stripe website.", "example": true } }, "required": [ "name", "api_key" ] }, "relationships": { "type": "object", "properties": { "tax_categories": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_categories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "stripeTaxAccountUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "stripe_tax_accounts" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax calculator's internal name.", "example": "Personal tax calculator", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "api_key": { "type": "string", "description": "The Stripe account API key.", "example": "STRIPE_API_KEY" }, "commit_invoice": { "type": "boolean", "description": "Indicates if the transaction will be recorded and visible on the Stripe website.", "example": true, "nullable": false } } }, "relationships": { "type": "object", "properties": { "tax_categories": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_categories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "stripeTaxAccountResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "stripe_tax_accounts" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/stripeTaxAccount/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tax_categories": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_categories" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "stripeTaxAccountResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/stripeTaxAccountResponse/properties/data" } } } }, "subscriptionModel": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "subscription_models" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The subscription model's internal name.", "example": "EU Subscription Model", "nullable": false }, "strategy": { "type": "string", "description": "The subscription model's strategy used to generate order subscriptions: one between 'by_frequency' (default) and 'by_line_items'.", "example": "by_frequency", "nullable": true }, "frequencies": { "type": "array", "description": "An object that contains the frequencies available for this subscription model. Supported ones are 'hourly', 'daily', 'weekly', 'monthly', 'two-month', 'three-month', 'four-month', 'six-month', 'yearly', or your custom crontab expression (min unit is hour).", "example": [ "hourly", "10 * * * *", "weekly", "monthly", "two-month" ], "nullable": false, "items": { "type": "string" } }, "auto_activate": { "type": "boolean", "description": "Indicates if the created subscriptions will be activated considering the placed source order as its first run, default to true.", "example": true, "nullable": true }, "auto_cancel": { "type": "boolean", "description": "Indicates if the created subscriptions will be cancelled in case the source order is cancelled, default to false.", "example": false, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "order_subscriptions": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscriptions" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "subscriptionModelCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "subscription_models" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The subscription model's internal name.", "example": "EU Subscription Model" }, "strategy": { "type": "string", "description": "The subscription model's strategy used to generate order subscriptions: one between 'by_frequency' (default) and 'by_line_items'.", "example": "by_frequency" }, "frequencies": { "type": "array", "description": "An object that contains the frequencies available for this subscription model. Supported ones are 'hourly', 'daily', 'weekly', 'monthly', 'two-month', 'three-month', 'four-month', 'six-month', 'yearly', or your custom crontab expression (min unit is hour).", "example": [ "hourly", "10 * * * *", "weekly", "monthly", "two-month" ], "items": { "type": "string" } }, "auto_activate": { "type": "boolean", "description": "Indicates if the created subscriptions will be activated considering the placed source order as its first run, default to true.", "example": true }, "auto_cancel": { "type": "boolean", "description": "Indicates if the created subscriptions will be cancelled in case the source order is cancelled, default to false.", "example": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name", "frequencies" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "subscriptionModelUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "subscription_models" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The subscription model's internal name.", "example": "EU Subscription Model", "nullable": false }, "strategy": { "type": "string", "description": "The subscription model's strategy used to generate order subscriptions: one between 'by_frequency' (default) and 'by_line_items'.", "example": "by_frequency", "nullable": true }, "frequencies": { "type": "array", "description": "An object that contains the frequencies available for this subscription model. Supported ones are 'hourly', 'daily', 'weekly', 'monthly', 'two-month', 'three-month', 'four-month', 'six-month', 'yearly', or your custom crontab expression (min unit is hour).", "example": [ "hourly", "10 * * * *", "weekly", "monthly", "two-month" ], "nullable": false, "items": { "type": "string" } }, "auto_activate": { "type": "boolean", "description": "Indicates if the created subscriptions will be activated considering the placed source order as its first run, default to true.", "example": true, "nullable": false }, "auto_cancel": { "type": "boolean", "description": "Indicates if the created subscriptions will be cancelled in case the source order is cancelled, default to false.", "example": false, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "subscriptionModelResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "subscription_models" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/subscriptionModel/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "order_subscriptions": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order_subscriptions" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "subscriptionModelResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/subscriptionModelResponse/properties/data" } } } }, "tag": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tag name.", "example": "new_campaign", "nullable": false }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "tagCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tag name.", "example": "new_campaign" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "tagUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tag name.", "example": "new_campaign", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "tagResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "tags" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/tag/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "tagResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/tagResponse/properties/data" } } } }, "talonOneAccount": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "talon_one_accounts" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The discount engine's internal name.", "example": "Personal discount engine", "nullable": false }, "type": { "type": "string", "description": "The discount engine's type.", "example": "talon_one_accounts", "nullable": false, "enum": [ "talon_one_accounts" ] }, "manage_gift_cards": { "type": "boolean", "description": "Indicates if the discount engine manages both promotions and gift cards application at once.", "example": false, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "api_endpoint": { "type": "string", "description": "The API endpoint as computed by specified baseurl.", "example": "https://my_baseurl.talon.one/v2", "nullable": true } } }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "discount_engine_items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "discount_engine_items" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "talonOneAccountCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "talon_one_accounts" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The discount engine's internal name.", "example": "Personal discount engine" }, "manage_gift_cards": { "type": "boolean", "description": "Indicates if the discount engine manages both promotions and gift cards application at once.", "example": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "api_key": { "type": "string", "description": "The Talon.One account API key.", "example": "TALON_ONE_API_KEY" }, "baseurl": { "type": "string", "description": "The Talon.One API baseurl (excluding the talon.one suffix).", "example": "yourbaseurl" } }, "required": [ "name", "api_key", "baseurl" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "talonOneAccountUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "talon_one_accounts" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The discount engine's internal name.", "example": "Personal discount engine", "nullable": false }, "manage_gift_cards": { "type": "boolean", "description": "Indicates if the discount engine manages both promotions and gift cards application at once.", "example": false, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "api_key": { "type": "string", "description": "The Talon.One account API key.", "example": "TALON_ONE_API_KEY" }, "baseurl": { "type": "string", "description": "The Talon.One API baseurl (excluding the talon.one suffix).", "example": "yourbaseurl" } } }, "relationships": { "type": "object", "properties": { } } } } } }, "talonOneAccountResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "talon_one_accounts" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/talonOneAccount/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "discount_engine_items": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "discount_engine_items" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "talonOneAccountResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/talonOneAccountResponse/properties/data" } } } }, "taxCalculator": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_calculators" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax calculator's internal name.", "example": "Personal tax calculator", "nullable": false }, "type": { "type": "string", "description": "The tax calculator's type.", "example": "avalara_accounts", "nullable": false, "enum": [ "avalara_accounts", "stripe_tax_accounts", "vertex_accounts", "taxjar_accounts", "manual_tax_calculators", "external_tax_calculators" ] }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "taxCalculatorResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_calculators" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/taxCalculator/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "taxCalculatorResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/taxCalculatorResponse/properties/data" } } } }, "taxCategory": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_categories" ] }, "attributes": { "type": "object", "properties": { "code": { "type": "string", "description": "The tax category identifier code, specific for a particular tax calculator.", "example": "31000", "nullable": false }, "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "sku": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tax_calculator": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "avalara_accounts", "stripe_tax_accounts", "vertex_accounts", "taxjar_accounts", "manual_tax_calculators", "external_tax_calculators" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/avalaraAccount" }, { "$ref": "#/components/schemas/stripeTaxAccount" }, { "$ref": "#/components/schemas/vertexAccount" }, { "$ref": "#/components/schemas/taxjarAccount" }, { "$ref": "#/components/schemas/manualTaxCalculator" }, { "$ref": "#/components/schemas/externalTaxCalculator" } ] }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "taxCategoryCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_categories" ] }, "attributes": { "type": "object", "properties": { "code": { "type": "string", "description": "The tax category identifier code, specific for a particular tax calculator.", "example": "31000" }, "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "code" ] }, "relationships": { "type": "object", "properties": { "sku": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tax_calculator": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "avalara_accounts", "stripe_tax_accounts", "vertex_accounts", "taxjar_accounts", "manual_tax_calculators", "external_tax_calculators" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/avalaraAccount" }, { "$ref": "#/components/schemas/stripeTaxAccount" }, { "$ref": "#/components/schemas/vertexAccount" }, { "$ref": "#/components/schemas/taxjarAccount" }, { "$ref": "#/components/schemas/manualTaxCalculator" }, { "$ref": "#/components/schemas/externalTaxCalculator" } ] } }, "required": [ "sku", "tax_calculator" ] } } } } }, "taxCategoryUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_categories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "code": { "type": "string", "description": "The tax category identifier code, specific for a particular tax calculator.", "example": "31000", "nullable": false }, "sku_code": { "type": "string", "description": "The code of the associated SKU.", "example": "TSHIRTMM000000FFFFFFXLXX", "nullable": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "sku": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "skus" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "taxCategoryResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_categories" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/taxCategory/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "sku": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "sku" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tax_calculator": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_calculator" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "taxCategoryResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/taxCategoryResponse/properties/data" } } } }, "taxRule": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_rules" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax rule internal name.", "example": "Fixed 22%", "nullable": false }, "tax_rate": { "type": "number", "description": "The tax rate for this rule.", "example": 0.22, "nullable": true }, "freight_taxable": { "type": "boolean", "description": "Indicates if the freight is taxable.", "example": false, "nullable": true }, "payment_method_taxable": { "type": "boolean", "description": "Indicates if the payment method is taxable.", "example": false, "nullable": true }, "gift_card_taxable": { "type": "boolean", "description": "Indicates if gift cards are taxable.", "example": false, "nullable": true }, "adjustment_taxable": { "type": "boolean", "description": "Indicates if adjustemnts are taxable.", "example": false, "nullable": true }, "breakdown": { "type": "object", "description": "The breakdown for this tax rule (if calculated).", "example": { "41": { "tax_rate": 0.22 } }, "nullable": true }, "country_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the shipping address country code, max size is 5000.", "example": "AT|BE|BG|CZ|DK|EE|DE|HU|LV|LT", "nullable": true }, "not_country_code_regex": { "type": "string", "description": "The regex that will be evaluated as negative match for the shipping address country code, max size is 5000.", "example": "AT|BE|BG|CZ|DK|EE|DE", "nullable": true }, "state_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the shipping address state code, max size is 5000.", "example": "A[KLRZ]|C[AOT]|D[CE]|FL", "nullable": true }, "not_state_code_regex": { "type": "string", "description": "The regex that will be evaluated as negative match for the shipping address state code, max size is 5000.", "example": "A[KLRZ]|C[AOT]", "nullable": true }, "zip_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the shipping address zip code, max size is 5000.", "example": "(?i)(JE1|JE2|JE3|JE4|JE5)", "nullable": true }, "not_zip_code_regex": { "type": "string", "description": "The regex that will be evaluated as negative match for the shipping zip country code, max size is 5000.", "example": "(?i)(JE1|JE2|JE3)", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "manual_tax_calculator": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "manual_tax_calculators" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "taxRuleCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_rules" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax rule internal name.", "example": "Fixed 22%" }, "tax_rate": { "type": "number", "description": "The tax rate for this rule.", "example": 0.22 }, "freight_taxable": { "type": "boolean", "description": "Indicates if the freight is taxable.", "example": false }, "payment_method_taxable": { "type": "boolean", "description": "Indicates if the payment method is taxable.", "example": false }, "gift_card_taxable": { "type": "boolean", "description": "Indicates if gift cards are taxable.", "example": false }, "adjustment_taxable": { "type": "boolean", "description": "Indicates if adjustemnts are taxable.", "example": false }, "country_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the shipping address country code, max size is 5000.", "example": "AT|BE|BG|CZ|DK|EE|DE|HU|LV|LT" }, "not_country_code_regex": { "type": "string", "description": "The regex that will be evaluated as negative match for the shipping address country code, max size is 5000.", "example": "AT|BE|BG|CZ|DK|EE|DE" }, "state_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the shipping address state code, max size is 5000.", "example": "A[KLRZ]|C[AOT]|D[CE]|FL" }, "not_state_code_regex": { "type": "string", "description": "The regex that will be evaluated as negative match for the shipping address state code, max size is 5000.", "example": "A[KLRZ]|C[AOT]" }, "zip_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the shipping address zip code, max size is 5000.", "example": "(?i)(JE1|JE2|JE3|JE4|JE5)" }, "not_zip_code_regex": { "type": "string", "description": "The regex that will be evaluated as negative match for the shipping zip country code, max size is 5000.", "example": "(?i)(JE1|JE2|JE3)" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "name" ] }, "relationships": { "type": "object", "properties": { "manual_tax_calculator": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "manual_tax_calculators" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "manual_tax_calculator" ] } } } } }, "taxRuleUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_rules" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax rule internal name.", "example": "Fixed 22%", "nullable": false }, "tax_rate": { "type": "number", "description": "The tax rate for this rule.", "example": 0.22, "nullable": true }, "freight_taxable": { "type": "boolean", "description": "Indicates if the freight is taxable.", "example": false, "nullable": false }, "payment_method_taxable": { "type": "boolean", "description": "Indicates if the payment method is taxable.", "example": false, "nullable": false }, "gift_card_taxable": { "type": "boolean", "description": "Indicates if gift cards are taxable.", "example": false, "nullable": false }, "adjustment_taxable": { "type": "boolean", "description": "Indicates if adjustemnts are taxable.", "example": false, "nullable": false }, "country_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the shipping address country code, max size is 5000.", "example": "AT|BE|BG|CZ|DK|EE|DE|HU|LV|LT", "nullable": true }, "not_country_code_regex": { "type": "string", "description": "The regex that will be evaluated as negative match for the shipping address country code, max size is 5000.", "example": "AT|BE|BG|CZ|DK|EE|DE", "nullable": true }, "state_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the shipping address state code, max size is 5000.", "example": "A[KLRZ]|C[AOT]|D[CE]|FL", "nullable": true }, "not_state_code_regex": { "type": "string", "description": "The regex that will be evaluated as negative match for the shipping address state code, max size is 5000.", "example": "A[KLRZ]|C[AOT]", "nullable": true }, "zip_code_regex": { "type": "string", "description": "The regex that will be evaluated to match the shipping address zip code, max size is 5000.", "example": "(?i)(JE1|JE2|JE3|JE4|JE5)", "nullable": true }, "not_zip_code_regex": { "type": "string", "description": "The regex that will be evaluated as negative match for the shipping zip country code, max size is 5000.", "example": "(?i)(JE1|JE2|JE3)", "nullable": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "manual_tax_calculator": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "manual_tax_calculators" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "taxRuleResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_rules" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/taxRule/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "manual_tax_calculator": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "manual_tax_calculator" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "taxRuleResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/taxRuleResponse/properties/data" } } } }, "taxjarAccount": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "taxjar_accounts" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax calculator's internal name.", "example": "Personal tax calculator", "nullable": false }, "type": { "type": "string", "description": "The tax calculator's type.", "example": "avalara_accounts", "nullable": false, "enum": [ "avalara_accounts", "stripe_tax_accounts", "vertex_accounts", "taxjar_accounts", "manual_tax_calculators", "external_tax_calculators" ] }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "tax_categories": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_categories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "taxjarAccountCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "taxjar_accounts" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax calculator's internal name.", "example": "Personal tax calculator" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "api_key": { "type": "string", "description": "The TaxJar account API key.", "example": "TAXJAR_API_KEY" } }, "required": [ "name", "api_key" ] }, "relationships": { "type": "object", "properties": { "tax_categories": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_categories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "taxjarAccountUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "taxjar_accounts" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax calculator's internal name.", "example": "Personal tax calculator", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "api_key": { "type": "string", "description": "The TaxJar account API key.", "example": "TAXJAR_API_KEY" } } }, "relationships": { "type": "object", "properties": { "tax_categories": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_categories" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "taxjarAccountResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "taxjar_accounts" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/taxjarAccount/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "tax_categories": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "tax_categories" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "taxjarAccountResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/taxjarAccountResponse/properties/data" } } } }, "transaction": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "transactions" ] }, "attributes": { "type": "object", "properties": { "number": { "type": "string", "description": "The transaction number, auto generated.", "example": "42/T/001", "nullable": false }, "type": { "type": "string", "description": "The transaction's type.", "example": "authorizations", "nullable": false, "enum": [ "authorizations", "voids", "captures", "refunds" ] }, "payment_method_type": { "type": "string", "description": "Information about the payment method used in the transaction.", "example": "credit card", "nullable": true }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated order.", "example": "EUR", "nullable": false }, "amount_cents": { "type": "integer", "description": "The transaction amount, in cents.", "example": 1500, "nullable": false }, "amount_float": { "type": "number", "description": "The transaction amount, float.", "example": 15.0, "nullable": false }, "formatted_amount": { "type": "string", "description": "The transaction amount, formatted.", "example": "€15,00", "nullable": false }, "succeeded": { "type": "boolean", "description": "Indicates if the transaction is successful.", "example": false, "nullable": false }, "message": { "type": "string", "description": "The message returned by the payment gateway.", "example": "Accepted", "nullable": true }, "error_code": { "type": "string", "description": "The error code, if any, returned by the payment gateway.", "example": "00001", "nullable": true }, "error_detail": { "type": "string", "description": "The error detail, if any, returned by the payment gateway.", "example": "Already settled", "nullable": true }, "token": { "type": "string", "description": "The token identifying the transaction, returned by the payment gateway.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "gateway_transaction_id": { "type": "string", "description": "The ID identifying the transaction, returned by the payment gateway.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_source": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_payments", "axerve_payments", "braintree_payments", "checkout_com_payments", "external_payments", "klarna_payments", "paypal_payments", "satispay_payments", "stripe_payments", "wire_transfers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/adyenPayment" }, { "$ref": "#/components/schemas/axervePayment" }, { "$ref": "#/components/schemas/braintreePayment" }, { "$ref": "#/components/schemas/checkoutComPayment" }, { "$ref": "#/components/schemas/externalPayment" }, { "$ref": "#/components/schemas/klarnaPayment" }, { "$ref": "#/components/schemas/paypalPayment" }, { "$ref": "#/components/schemas/satispayPayment" }, { "$ref": "#/components/schemas/stripePayment" }, { "$ref": "#/components/schemas/wireTransfer" } ] }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "transactionResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "transactions" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/transaction/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_source": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_source" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "transactionResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/transactionResponse/properties/data" } } } }, "vertexAccount": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "vertex_accounts" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax calculator's internal name.", "example": "Personal tax calculator", "nullable": false }, "type": { "type": "string", "description": "The tax calculator's type.", "example": "avalara_accounts", "nullable": false, "enum": [ "avalara_accounts", "stripe_tax_accounts", "vertex_accounts", "taxjar_accounts", "manual_tax_calculators", "external_tax_calculators" ] }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "kind": { "type": "string", "description": "The Vertex account kind. One of 'cloud', 'on_demand', or 'on_premise'.", "example": "cloud", "nullable": true, "enum": [ "cloud", "on_demand", "on_premise" ] }, "baseurl": { "type": "string", "description": "The Vertex API baseurl, optional for 'cloud' kind.", "example": "yourbaseurl", "nullable": true }, "api_endpoint": { "type": "string", "description": "The API endpoint as computed by specified kind and baseurl.", "example": "https://my_baseurl.ondemand.vertexinc.com", "nullable": true }, "commit_invoice": { "type": "boolean", "description": "Indicates if the transaction will be recorded and visible on the Vertex website.", "example": true, "nullable": true }, "token_expires_at": { "type": "string", "description": "The expiration date/time of the access token.", "example": "2018-01-02T12:00:00.000Z", "nullable": true } } }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "vertexAccountCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "vertex_accounts" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax calculator's internal name.", "example": "Personal tax calculator" }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } }, "kind": { "type": "string", "description": "The Vertex account kind. One of 'cloud', 'on_demand', or 'on_premise'.", "example": "cloud", "enum": [ "cloud", "on_demand", "on_premise" ] }, "baseurl": { "type": "string", "description": "The Vertex API baseurl, optional for 'cloud' kind.", "example": "yourbaseurl" }, "client_id": { "type": "string", "description": "The Vertex account client ID.", "example": "xxx-yyy-zzz" }, "client_secret": { "type": "string", "description": "The Vertex account client secret.", "example": "xxx-yyy-zzz" }, "commit_invoice": { "type": "boolean", "description": "Indicates if the transaction will be recorded and visible on the Vertex website.", "example": true } }, "required": [ "name", "client_id", "client_secret" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "vertexAccountUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "vertex_accounts" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "The tax calculator's internal name.", "example": "Personal tax calculator", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true }, "kind": { "type": "string", "description": "The Vertex account kind. One of 'cloud', 'on_demand', or 'on_premise'.", "example": "cloud", "nullable": true, "enum": [ "cloud", "on_demand", "on_premise" ] }, "baseurl": { "type": "string", "description": "The Vertex API baseurl, optional for 'cloud' kind.", "example": "yourbaseurl", "nullable": true }, "client_id": { "type": "string", "description": "The Vertex account client ID.", "example": "xxx-yyy-zzz" }, "client_secret": { "type": "string", "description": "The Vertex account client secret.", "example": "xxx-yyy-zzz" }, "commit_invoice": { "type": "boolean", "description": "Indicates if the transaction will be recorded and visible on the Vertex website.", "example": true, "nullable": false }, "_refresh_token": { "type": "boolean", "description": "Send this attribute if you want to manually refresh the access token.", "example": true, "nullable": false } } }, "relationships": { "type": "object", "properties": { } } } } } }, "vertexAccountResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "vertex_accounts" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/vertexAccount/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "markets": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "markets" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "vertexAccountResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/vertexAccountResponse/properties/data" } } } }, "void": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "voids" ] }, "attributes": { "type": "object", "properties": { "number": { "type": "string", "description": "The transaction number, auto generated.", "example": "42/T/001", "nullable": false }, "type": { "type": "string", "description": "The transaction's type.", "example": "authorizations", "nullable": false, "enum": [ "authorizations", "voids", "captures", "refunds" ] }, "payment_method_type": { "type": "string", "description": "Information about the payment method used in the transaction.", "example": "credit card", "nullable": true }, "currency_code": { "type": "string", "description": "The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated order.", "example": "EUR", "nullable": false }, "amount_cents": { "type": "integer", "description": "The transaction amount, in cents.", "example": 1500, "nullable": false }, "amount_float": { "type": "number", "description": "The transaction amount, float.", "example": 15.0, "nullable": false }, "formatted_amount": { "type": "string", "description": "The transaction amount, formatted.", "example": "€15,00", "nullable": false }, "succeeded": { "type": "boolean", "description": "Indicates if the transaction is successful.", "example": false, "nullable": false }, "message": { "type": "string", "description": "The message returned by the payment gateway.", "example": "Accepted", "nullable": true }, "error_code": { "type": "string", "description": "The error code, if any, returned by the payment gateway.", "example": "00001", "nullable": true }, "error_detail": { "type": "string", "description": "The error detail, if any, returned by the payment gateway.", "example": "Already settled", "nullable": true }, "token": { "type": "string", "description": "The token identifying the transaction, returned by the payment gateway.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "gateway_transaction_id": { "type": "string", "description": "The ID identifying the transaction, returned by the payment gateway.", "example": "xxxx-yyyy-zzzz", "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "payment_source": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "adyen_payments", "axerve_payments", "braintree_payments", "checkout_com_payments", "external_payments", "klarna_payments", "paypal_payments", "satispay_payments", "stripe_payments", "wire_transfers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } }, "oneOf": [ { "$ref": "#/components/schemas/adyenPayment" }, { "$ref": "#/components/schemas/axervePayment" }, { "$ref": "#/components/schemas/braintreePayment" }, { "$ref": "#/components/schemas/checkoutComPayment" }, { "$ref": "#/components/schemas/externalPayment" }, { "$ref": "#/components/schemas/klarnaPayment" }, { "$ref": "#/components/schemas/paypalPayment" }, { "$ref": "#/components/schemas/satispayPayment" }, { "$ref": "#/components/schemas/stripePayment" }, { "$ref": "#/components/schemas/wireTransfer" } ] }, "attachments": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "events": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "reference_authorization": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "authorizations" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "voidUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "voids" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "succeeded": { "type": "boolean", "description": "Indicates if the transaction is successful.", "example": false, "nullable": false }, "_forward": { "type": "boolean", "description": "Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "voidResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "voids" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/void/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "payment_source": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "payment_source" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "attachments": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "attachments" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "events": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "events" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "reference_authorization": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "reference_authorization" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "voidResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/voidResponse/properties/data" } } } }, "webhook": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "webhooks" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Unique name for the webhook.", "example": "myorg-orders.place", "nullable": true }, "topic": { "type": "string", "description": "The identifier of the resource/event that will trigger the webhook.", "example": "orders.place", "nullable": false }, "callback_url": { "type": "string", "description": "URI where the webhook subscription should send the POST request when the event occurs.", "example": "https://yourapp.com/webhooks", "nullable": false }, "include_resources": { "type": "array", "description": "List of related resources that should be included in the webhook body.", "example": [ "customer", "shipping_address", "billing_address" ], "nullable": true, "items": { "type": "string" } }, "disabled_at": { "type": "string", "description": "Time at which this resource was disabled.", "example": "2018-01-01T12:00:00.000Z", "nullable": true }, "circuit_state": { "type": "string", "description": "The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made.", "example": "closed", "nullable": true }, "circuit_failure_count": { "type": "integer", "description": "The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback.", "example": 5, "nullable": true }, "shared_secret": { "type": "string", "description": "The shared secret used to sign the external request payload.", "example": "1c0994cc4e996e8c6ee56a2198f66f3c", "nullable": false }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "last_event_callbacks": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_callbacks" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "webhookCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "webhooks" ] }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Unique name for the webhook.", "example": "myorg-orders.place" }, "topic": { "type": "string", "description": "The identifier of the resource/event that will trigger the webhook.", "example": "orders.place" }, "callback_url": { "type": "string", "description": "URI where the webhook subscription should send the POST request when the event occurs.", "example": "https://yourapp.com/webhooks" }, "include_resources": { "type": "array", "description": "List of related resources that should be included in the webhook body.", "example": [ "customer", "shipping_address", "billing_address" ], "items": { "type": "string" } }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } }, "required": [ "topic", "callback_url" ] }, "relationships": { "type": "object", "properties": { } } } } } }, "webhookUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "webhooks" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Unique name for the webhook.", "example": "myorg-orders.place", "nullable": true }, "topic": { "type": "string", "description": "The identifier of the resource/event that will trigger the webhook.", "example": "orders.place", "nullable": false }, "callback_url": { "type": "string", "description": "URI where the webhook subscription should send the POST request when the event occurs.", "example": "https://yourapp.com/webhooks", "nullable": false }, "include_resources": { "type": "array", "description": "List of related resources that should be included in the webhook body.", "example": [ "customer", "shipping_address", "billing_address" ], "nullable": true, "items": { "type": "string" } }, "_disable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as disabled.", "example": true, "nullable": false }, "_enable": { "type": "boolean", "description": "Send this attribute if you want to mark this resource as enabled.", "example": true, "nullable": false }, "_reset_circuit": { "type": "boolean", "description": "Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.", "example": true, "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { } } } } } }, "webhookResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "webhooks" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/webhook/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "last_event_callbacks": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "last_event_callbacks" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "webhookResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/webhookResponse/properties/data" } } } }, "wireTransfer": { "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "wire_transfers" ] }, "attributes": { "type": "object", "properties": { "payment_instrument": { "type": "object", "description": "Information about the payment instrument used in the transaction.", "example": { "issuer": "cl bank", "card_type": "visa" }, "nullable": true }, "created_at": { "type": "string", "description": "Time at which the resource was created.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "updated_at": { "type": "string", "description": "Time at which the resource was last updated.", "example": "2018-01-01T12:00:00.000Z", "nullable": false }, "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } }, "event_stores": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "wireTransferCreate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "wire_transfers" ] }, "attributes": { "type": "object", "properties": { "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE" }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN" }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" } } } }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } }, "required": [ "order" ] } } } } }, "wireTransferUpdate": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "required": [ "type", "id", "attributes" ], "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "wire_transfers" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "attributes": { "type": "object", "properties": { "reference": { "type": "string", "description": "A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.", "example": "ANY-EXTERNAL-REFEFERNCE", "nullable": true }, "reference_origin": { "type": "string", "description": "Any identifier of the third party system that defines the reference code.", "example": "ANY-EXTERNAL-REFEFERNCE-ORIGIN", "nullable": true }, "metadata": { "type": "object", "description": "Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.", "example": { "foo": "bar" }, "nullable": true } } }, "relationships": { "type": "object", "properties": { "order": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "orders" ] }, "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" } } } } } } } } } } }, "wireTransferResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the resource (hash).", "example": "XAyRWNUzyN" }, "type": { "type": "string", "description": "The resource's type", "enum": [ "wire_transfers" ] }, "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" } } }, "attributes": { "$ref": "#/components/schemas/wireTransfer/properties/data/properties/attributes" }, "relationships": { "type": "object", "properties": { "order": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "order" ] }, "id": { "type": "string", "description": "The resource ID" } } } } }, "event_stores": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "description": "URL" }, "related": { "type": "string", "description": "URL" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "description": "The resource's type", "enum": [ "event_stores" ] }, "id": { "type": "string", "description": "The resource ID" } } } } } } } } } } }, "wireTransferResponseList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/wireTransferResponse/properties/data" } } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "tags": [ { "name": "singleton", "description": "singleton resource" }, { "name": "addresses", "description": "resource type" }, { "name": "has_one", "description": "relationship kind" }, { "name": "has_many", "description": "relationship kind" }, { "name": "adjustments", "description": "resource type" }, { "name": "adyen_gateways", "description": "resource type" }, { "name": "adyen_payments", "description": "resource type" }, { "name": "application", "description": "resource type" }, { "name": "attachments", "description": "resource type" }, { "name": "authorizations", "description": "resource type" }, { "name": "avalara_accounts", "description": "resource type" }, { "name": "axerve_gateways", "description": "resource type" }, { "name": "axerve_payments", "description": "resource type" }, { "name": "bing_geocoders", "description": "resource type" }, { "name": "braintree_gateways", "description": "resource type" }, { "name": "braintree_payments", "description": "resource type" }, { "name": "bundles", "description": "resource type" }, { "name": "buy_x_pay_y_promotions", "description": "resource type" }, { "name": "captures", "description": "resource type" }, { "name": "carrier_accounts", "description": "resource type" }, { "name": "checkout_com_gateways", "description": "resource type" }, { "name": "checkout_com_payments", "description": "resource type" }, { "name": "cleanups", "description": "resource type" }, { "name": "coupon_codes_promotion_rules", "description": "resource type" }, { "name": "coupon_recipients", "description": "resource type" }, { "name": "coupons", "description": "resource type" }, { "name": "custom_promotion_rules", "description": "resource type" }, { "name": "customer_addresses", "description": "resource type" }, { "name": "customer_groups", "description": "resource type" }, { "name": "customer_password_resets", "description": "resource type" }, { "name": "customer_payment_sources", "description": "resource type" }, { "name": "customer_subscriptions", "description": "resource type" }, { "name": "customers", "description": "resource type" }, { "name": "delivery_lead_times", "description": "resource type" }, { "name": "discount_engine_items", "description": "resource type" }, { "name": "discount_engines", "description": "resource type" }, { "name": "easypost_pickups", "description": "resource type" }, { "name": "event_callbacks", "description": "resource type" }, { "name": "event_stores", "description": "resource type" }, { "name": "events", "description": "resource type" }, { "name": "exports", "description": "resource type" }, { "name": "external_gateways", "description": "resource type" }, { "name": "external_payments", "description": "resource type" }, { "name": "external_promotions", "description": "resource type" }, { "name": "external_tax_calculators", "description": "resource type" }, { "name": "fixed_amount_promotions", "description": "resource type" }, { "name": "fixed_price_promotions", "description": "resource type" }, { "name": "flex_promotions", "description": "resource type" }, { "name": "free_gift_promotions", "description": "resource type" }, { "name": "free_shipping_promotions", "description": "resource type" }, { "name": "geocoders", "description": "resource type" }, { "name": "gift_card_recipients", "description": "resource type" }, { "name": "gift_cards", "description": "resource type" }, { "name": "google_geocoders", "description": "resource type" }, { "name": "imports", "description": "resource type" }, { "name": "in_stock_subscriptions", "description": "resource type" }, { "name": "inventory_models", "description": "resource type" }, { "name": "inventory_return_locations", "description": "resource type" }, { "name": "inventory_stock_locations", "description": "resource type" }, { "name": "klarna_gateways", "description": "resource type" }, { "name": "klarna_payments", "description": "resource type" }, { "name": "line_item_options", "description": "resource type" }, { "name": "line_items", "description": "resource type" }, { "name": "links", "description": "resource type" }, { "name": "manual_gateways", "description": "resource type" }, { "name": "manual_tax_calculators", "description": "resource type" }, { "name": "markets", "description": "resource type" }, { "name": "merchants", "description": "resource type" }, { "name": "notifications", "description": "resource type" }, { "name": "order_amount_promotion_rules", "description": "resource type" }, { "name": "order_copies", "description": "resource type" }, { "name": "order_factories", "description": "resource type" }, { "name": "order_subscription_items", "description": "resource type" }, { "name": "order_subscriptions", "description": "resource type" }, { "name": "orders", "description": "resource type" }, { "name": "organization", "description": "resource type" }, { "name": "packages", "description": "resource type" }, { "name": "parcel_line_items", "description": "resource type" }, { "name": "parcels", "description": "resource type" }, { "name": "payment_gateways", "description": "resource type" }, { "name": "payment_methods", "description": "resource type" }, { "name": "payment_options", "description": "resource type" }, { "name": "paypal_gateways", "description": "resource type" }, { "name": "paypal_payments", "description": "resource type" }, { "name": "percentage_discount_promotions", "description": "resource type" }, { "name": "pickups", "description": "resource type" }, { "name": "price_frequency_tiers", "description": "resource type" }, { "name": "price_list_schedulers", "description": "resource type" }, { "name": "price_lists", "description": "resource type" }, { "name": "price_tiers", "description": "resource type" }, { "name": "price_volume_tiers", "description": "resource type" }, { "name": "prices", "description": "resource type" }, { "name": "promotion_rules", "description": "resource type" }, { "name": "promotions", "description": "resource type" }, { "name": "recurring_order_copies", "description": "resource type" }, { "name": "refunds", "description": "resource type" }, { "name": "reserved_stocks", "description": "resource type" }, { "name": "resource_errors", "description": "resource type" }, { "name": "return_line_items", "description": "resource type" }, { "name": "returns", "description": "resource type" }, { "name": "satispay_gateways", "description": "resource type" }, { "name": "satispay_payments", "description": "resource type" }, { "name": "shipments", "description": "resource type" }, { "name": "shipping_categories", "description": "resource type" }, { "name": "shipping_method_tiers", "description": "resource type" }, { "name": "shipping_methods", "description": "resource type" }, { "name": "shipping_weight_tiers", "description": "resource type" }, { "name": "shipping_zones", "description": "resource type" }, { "name": "sku_list_items", "description": "resource type" }, { "name": "sku_list_promotion_rules", "description": "resource type" }, { "name": "sku_lists", "description": "resource type" }, { "name": "sku_options", "description": "resource type" }, { "name": "skus", "description": "resource type" }, { "name": "stock_items", "description": "resource type" }, { "name": "stock_line_items", "description": "resource type" }, { "name": "stock_locations", "description": "resource type" }, { "name": "stock_reservations", "description": "resource type" }, { "name": "stock_transfers", "description": "resource type" }, { "name": "stores", "description": "resource type" }, { "name": "stripe_gateways", "description": "resource type" }, { "name": "stripe_payments", "description": "resource type" }, { "name": "stripe_tax_accounts", "description": "resource type" }, { "name": "subscription_models", "description": "resource type" }, { "name": "tags", "description": "resource type" }, { "name": "talon_one_accounts", "description": "resource type" }, { "name": "tax_calculators", "description": "resource type" }, { "name": "tax_categories", "description": "resource type" }, { "name": "tax_rules", "description": "resource type" }, { "name": "taxjar_accounts", "description": "resource type" }, { "name": "transactions", "description": "resource type" }, { "name": "vertex_accounts", "description": "resource type" }, { "name": "voids", "description": "resource type" }, { "name": "webhooks", "description": "resource type" }, { "name": "wire_transfers", "description": "resource type" } ], "security": [ { "bearerAuth": [ ] } ] }