{"items":[{"type":"link","label":"Commerce (Orders & Inventory)","link":"/apis/commerce/commerce-v1","routeSlug":"/apis/commerce/commerce-v1","content":{"contentType":"overview","meta":{"name":"Commerce (Orders & Inventory)"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"commerce-v1.json","url":"/_bundle/apis/commerce/commerce-v1.json?download"},{"kind":"download","label":"commerce-v1.yaml","url":"/_bundle/apis/commerce/commerce-v1.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Commerce (Orders & Inventory) (v1-2025-04-18)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Orders & Inventory, or Commerce, API is focused on the processing and fulfillment of Orders. Additionally, you can use"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this API to manage your inventory, merchandise, and online store."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Like most of the other Rhythm apps, the Commerce API includes endpoints for Query Definitions. These endpoints are commonly"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used to retrieve saved queries, which can then be executed using the Query endpoints of the System API."},"children":[]}]}]}]}],"sectionId":"/apis/commerce/commerce-v1"}],"sectionId":"/apis/commerce/commerce-v1"}]}]}},{"type":"group","label":"Cancellation Fees","link":"/apis/commerce/commerce-v1/cancellation-fees","routeSlug":"/apis/commerce/commerce-v1/cancellation-fees","items":[{"label":"Gets all of the cancellation fees in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellation-fees/listcancellationfees","routeSlug":"/apis/commerce/commerce-v1/cancellation-fees/listcancellationfees","metadata":{"seo":{"title":"Gets all of the cancellation fees in the system.","description":"This method will scan all cancellation fees and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCancellationFees","name":"Gets all of the cancellation fees in the system.","isWebhook":false,"pointer":"/paths/~1cancellationFees~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the cancellation fees in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all cancellation fees and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1cancellationFees~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1cancellationFees~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cancellationFees/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/cancellationFees/{tenantId}","href":"cancellation-fees/listcancellationfees","openApiOperationId":"listCancellationFees","summary":"Gets all of the cancellation fees in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cancellation feeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_460"}},"schemaId":"schema_460","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1cancellationFees~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_460","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_460"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cancellation-fees/listcancellationfees"}],"panels":[]}]},"httpPath":"/cancellationFees/{tenantId}"},{"label":"Creates a new cancellation fee record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellation-fees/createcancellationfee","routeSlug":"/apis/commerce/commerce-v1/cancellation-fees/createcancellationfee","metadata":{"seo":{"title":"Creates a new cancellation fee record that does not already exist.","description":"This method will auto-generate an ID and create a new cancellation fee. If an ID is specified for the cancellation fee, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCancellationFee","name":"Creates a new cancellation fee record that does not already exist.","isWebhook":false,"pointer":"/paths/~1cancellationFees~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new cancellation fee record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new cancellation fee. If an ID is specified for the cancellation fee, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1cancellationFees~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancellationFee"}},"schemaId":"components/schemas/CancellationFee","pointer":"/paths/~1cancellationFees~1{tenantId}/post/requestBody","description":"The cancellation fee that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cancellationFees/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CancellationFee"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/cancellationFees/{tenantId}","href":"cancellation-fees/createcancellationfee","openApiOperationId":"createCancellationFee","summary":"Creates a new cancellation fee record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CancellationFee","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancellationFee"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cancellation fee was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CancellationFee"}},"schemaId":"components/schemas/CancellationFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The cancellation fee you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The cancellation fee could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add cancellation fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1cancellationFees~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CancellationFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CancellationFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cancellation-fees/createcancellationfee"}],"panels":[]}]},"httpPath":"/cancellationFees/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellation-fees/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/cancellation-fees/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1cancellationFees~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1cancellationFees~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1cancellationFees~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cancellationFees/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/cancellationFees/{tenantId}/batch","href":"cancellation-fees/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The cancellation fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve cancellation fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1cancellationFees~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cancellation-fees/executebatchoperations"}],"panels":[]}]},"httpPath":"/cancellationFees/{tenantId}/batch"},{"label":"Returns a cancellation fee from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellation-fees/deletecancellationfee","routeSlug":"/apis/commerce/commerce-v1/cancellation-fees/deletecancellationfee","metadata":{"seo":{"title":"Returns a cancellation fee from the system by its ID.","description":"This method will delete a cancellation fee with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCancellationFee","name":"Returns a cancellation fee from the system by its ID.","isWebhook":false,"pointer":"/paths/~1cancellationFees~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a cancellation fee from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a cancellation fee with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the cancellation fee to delete.","required":true}],"pointer":"/paths/~1cancellationFees~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/cancellationFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/cancellationFees/{tenantId}/{id}","href":"cancellation-fees/deletecancellationfee","openApiOperationId":"deleteCancellationFee","summary":"Returns a cancellation fee from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cancellation fee was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The cancellation fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The cancellation fee could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete cancellation fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1cancellationFees~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cancellation-fees/deletecancellationfee"}],"panels":[]}]},"httpPath":"/cancellationFees/{tenantId}/{id}"},{"label":"Returns a cancellation fee from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellation-fees/getcancellationfee","routeSlug":"/apis/commerce/commerce-v1/cancellation-fees/getcancellationfee","metadata":{"seo":{"title":"Returns a cancellation fee from the system by its ID.","description":"This method will look up a cancellation fee by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCancellationFee","name":"Returns a cancellation fee from the system by its ID.","isWebhook":false,"pointer":"/paths/~1cancellationFees~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a cancellation fee from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a cancellation fee by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the cancellation fee to return.","required":true}],"pointer":"/paths/~1cancellationFees~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1cancellationFees~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cancellationFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/cancellationFees/{tenantId}/{id}","href":"cancellation-fees/getcancellationfee","openApiOperationId":"getCancellationFee","summary":"Returns a cancellation fee from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cancellation fee was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CancellationFee"}},"schemaId":"components/schemas/CancellationFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The cancellation fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve cancellation fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1cancellationFees~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CancellationFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CancellationFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cancellation-fees/getcancellationfee"}],"panels":[]}]},"httpPath":"/cancellationFees/{tenantId}/{id}"},{"label":"Partially updates a cancellation fee with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellation-fees/patchcancellationfee","routeSlug":"/apis/commerce/commerce-v1/cancellation-fees/patchcancellationfee","metadata":{"seo":{"title":"Partially updates a cancellation fee with the specified ID.","description":"This method will patch an existing cancellation fee with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCancellationFee","name":"Partially updates a cancellation fee with the specified ID.","isWebhook":false,"pointer":"/paths/~1cancellationFees~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a cancellation fee with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing cancellation fee with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the cancellation fee to patch.","required":true}],"pointer":"/paths/~1cancellationFees~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1cancellationFees~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/cancellationFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/cancellationFees/{tenantId}/{id}","href":"cancellation-fees/patchcancellationfee","openApiOperationId":"patchCancellationFee","summary":"Partially updates a cancellation fee with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cancellation fee was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CancellationFee"}},"schemaId":"components/schemas/CancellationFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The cancellation fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The cancellation fee could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve cancellation fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1cancellationFees~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CancellationFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CancellationFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cancellation-fees/patchcancellationfee"}],"panels":[]}]},"httpPath":"/cancellationFees/{tenantId}/{id}"},{"label":"Updates a cancellation fee with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellation-fees/updatecancellationfee","routeSlug":"/apis/commerce/commerce-v1/cancellation-fees/updatecancellationfee","metadata":{"seo":{"title":"Updates a cancellation fee with the specified ID.","description":"This method will update an existing cancellation fee with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCancellationFee","name":"Updates a cancellation fee with the specified ID.","isWebhook":false,"pointer":"/paths/~1cancellationFees~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a cancellation fee with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing cancellation fee with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the cancellation fee to update.","required":true}],"pointer":"/paths/~1cancellationFees~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancellationFee"}},"schemaId":"components/schemas/CancellationFee","pointer":"/paths/~1cancellationFees~1{tenantId}~1{id}/put/requestBody","description":"The updated cancellation fee that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/cancellationFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CancellationFee"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/cancellationFees/{tenantId}/{id}","href":"cancellation-fees/updatecancellationfee","openApiOperationId":"updateCancellationFee","summary":"Updates a cancellation fee with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CancellationFee","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancellationFee"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cancellation fee was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CancellationFee"}},"schemaId":"components/schemas/CancellationFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The cancellation fee supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The cancellation fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The cancellation fee could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve cancellation fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1cancellationFees~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CancellationFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CancellationFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cancellation-fees/updatecancellationfee"}],"panels":[]}]},"httpPath":"/cancellationFees/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Cancellation Fees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancellation Fees","showPageActions":true},{"nodeType":"markdoc","content":"Cancellation Fees"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/cancellationFees/{tenantId}","summary":"Gets all of the cancellation fees in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cancellation-fees/listcancellationfees","deprecated":false},{"title":"/cancellationFees/{tenantId}","summary":"Creates a new cancellation fee record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cancellation-fees/createcancellationfee","deprecated":false},{"title":"/cancellationFees/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cancellation-fees/executebatchoperations","deprecated":false},{"title":"/cancellationFees/{tenantId}/{id}","summary":"Returns a cancellation fee from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cancellation-fees/deletecancellationfee","deprecated":false},{"title":"/cancellationFees/{tenantId}/{id}","summary":"Returns a cancellation fee from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cancellation-fees/getcancellationfee","deprecated":false},{"title":"/cancellationFees/{tenantId}/{id}","summary":"Partially updates a cancellation fee with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/cancellation-fees/patchcancellationfee","deprecated":false},{"title":"/cancellationFees/{tenantId}/{id}","summary":"Updates a cancellation fee with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cancellation-fees/updatecancellationfee","deprecated":false}]}]}]}]}},{"type":"group","label":"Cancellations","link":"/apis/commerce/commerce-v1/cancellations","routeSlug":"/apis/commerce/commerce-v1/cancellations","items":[{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellations/warmupstepfunctions","routeSlug":"/apis/commerce/commerce-v1/cancellations/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"warmUpStepFunctions","name":"Initiates workflow to warm up inventory transactions","isWebhook":false,"pointer":"/paths/~1cancellations~1warmUpStepFunctions/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates workflow to warm up inventory transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cancellations/warmUpStepFunctions","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/cancellations/warmUpStepFunctions","href":"cancellations/warmupstepfunctions","openApiOperationId":"warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Request limit exceeded... please try your request again in a few seconds","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1cancellations~1warmUpStepFunctions/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cancellations/warmupstepfunctions"}],"panels":[]}]},"httpPath":"/cancellations/warmUpStepFunctions"},{"label":"Processes a cancellation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellations/processcancellation","routeSlug":"/apis/commerce/commerce-v1/cancellations/processcancellation","metadata":{"seo":{"title":"Processes a cancellation","description":"This method will auto-generate an ID and create a new cancellation. If an ID is specified for the cancellation, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processCancellation","name":"Processes a cancellation","isWebhook":false,"pointer":"/paths/~1cancellations~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Processes a cancellation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new cancellation. If an ID is specified for the cancellation, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1cancellations~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Cancellation"}},"schemaId":"components/schemas/Cancellation","pointer":"/paths/~1cancellations~1{tenantId}/post/requestBody","description":"The cancellation that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cancellations/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Cancellation"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/cancellations/{tenantId}","href":"cancellations/processcancellation","openApiOperationId":"processCancellation","summary":"Processes a cancellation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Cancellation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Cancellation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cancellation was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The cancellation you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The cancellation could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add cancellation based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1cancellations~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cancellations/processcancellation"}],"panels":[]}]},"httpPath":"/cancellations/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellations/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/cancellations/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1cancellations~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1cancellations~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1cancellations~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cancellations/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/cancellations/{tenantId}/batch","href":"cancellations/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The cancellation could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve cancellation based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1cancellations~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cancellations/executebatchoperations"}],"panels":[]}]},"httpPath":"/cancellations/{tenantId}/batch"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellations/listcancellationsbyorderid","routeSlug":"/apis/commerce/commerce-v1/cancellations/listcancellationsbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCancellationsByOrderId","name":"Returns a list of records with the specified order_id","isWebhook":false,"pointer":"/paths/~1cancellations~1{tenantId}~1order~1{order_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified order_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified order_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"order_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1cancellations~1{tenantId}~1order~1{order_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1cancellations~1{tenantId}~1order~1{order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cancellations/{tenantId}/order/{order_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/cancellations/{tenantId}/order/{order_id}","href":"cancellations/listcancellationsbyorderid","openApiOperationId":"listCancellationsByOrderId","summary":"Returns a list of records with the specified order_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCancellationsResponse"}},"schemaId":"components/schemas/ListCancellationsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1cancellations~1{tenantId}~1order~1{order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCancellationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCancellationsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cancellations/listcancellationsbyorderid"}],"panels":[]}]},"httpPath":"/cancellations/{tenantId}/order/{order_id}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellations/previewemail","routeSlug":"/apis/commerce/commerce-v1/cancellations/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewEmail","name":"Sends out a preview of the CRC notification email","isWebhook":false,"pointer":"/paths/~1cancellations~1{tenantId}~1previewEmail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the CRC notification email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the CRC notification email"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true}],"pointer":"/paths/~1cancellations~1{tenantId}~1previewEmail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"schemaId":"components/schemas/PreviewEmailRequest","pointer":"/paths/~1cancellations~1{tenantId}~1previewEmail/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cancellations/{tenantId}/previewEmail","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/cancellations/{tenantId}/previewEmail","href":"cancellations/previewemail","openApiOperationId":"previewEmail","summary":"Sends out a preview of the CRC notification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewEmailRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1cancellations~1{tenantId}~1previewEmail/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cancellations/previewemail"}],"panels":[]}]},"httpPath":"/cancellations/{tenantId}/previewEmail"},{"label":"Processes a cancellation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellations/processcancellationsync","routeSlug":"/apis/commerce/commerce-v1/cancellations/processcancellationsync","metadata":{"seo":{"title":"Processes a cancellation","description":"This method will auto-generate an ID and create a new cancellation. If an ID is specified for the cancellation, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processCancellationSync","name":"Processes a cancellation","isWebhook":false,"pointer":"/paths/~1cancellations~1{tenantId}~1sync/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Processes a cancellation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new cancellation. If an ID is specified for the cancellation, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1cancellations~1{tenantId}~1sync/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Cancellation"}},"schemaId":"components/schemas/Cancellation","pointer":"/paths/~1cancellations~1{tenantId}~1sync/post/requestBody","description":"The cancellation that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cancellations/{tenantId}/sync","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Cancellation"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/cancellations/{tenantId}/sync","href":"cancellations/processcancellationsync","openApiOperationId":"processCancellationSync","summary":"Processes a cancellation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Cancellation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Cancellation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cancellation was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Cancellation"}},"schemaId":"components/schemas/Cancellation","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The cancellation you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The cancellation could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add cancellation based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1cancellations~1{tenantId}~1sync/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Cancellation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Cancellation"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cancellations/processcancellationsync"}],"panels":[]}]},"httpPath":"/cancellations/{tenantId}/sync"},{"label":"Returns a cancellation from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellations/deletecancellation","routeSlug":"/apis/commerce/commerce-v1/cancellations/deletecancellation","metadata":{"seo":{"title":"Returns a cancellation from the system by its ID.","description":"This method will delete a cancellation with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCancellation","name":"Returns a cancellation from the system by its ID.","isWebhook":false,"pointer":"/paths/~1cancellations~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a cancellation from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a cancellation with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the cancellation to delete.","required":true}],"pointer":"/paths/~1cancellations~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/cancellations/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/cancellations/{tenantId}/{id}","href":"cancellations/deletecancellation","openApiOperationId":"deleteCancellation","summary":"Returns a cancellation from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cancellation was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The cancellation could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The cancellation could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete cancellation based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1cancellations~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cancellations/deletecancellation"}],"panels":[]}]},"httpPath":"/cancellations/{tenantId}/{id}"},{"label":"Returns a cancellation from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellations/getcancellation","routeSlug":"/apis/commerce/commerce-v1/cancellations/getcancellation","metadata":{"seo":{"title":"Returns a cancellation from the system by its ID.","description":"This method will look up a cancellation by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCancellation","name":"Returns a cancellation from the system by its ID.","isWebhook":false,"pointer":"/paths/~1cancellations~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a cancellation from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a cancellation by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the cancellation to return.","required":true}],"pointer":"/paths/~1cancellations~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1cancellations~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cancellations/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/cancellations/{tenantId}/{id}","href":"cancellations/getcancellation","openApiOperationId":"getCancellation","summary":"Returns a cancellation from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cancellation was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Cancellation"}},"schemaId":"components/schemas/Cancellation","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The cancellation could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve cancellation based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1cancellations~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Cancellation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Cancellation"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cancellations/getcancellation"}],"panels":[]}]},"httpPath":"/cancellations/{tenantId}/{id}"},{"label":"Partially updates a cancellation with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellations/patchcancellation","routeSlug":"/apis/commerce/commerce-v1/cancellations/patchcancellation","metadata":{"seo":{"title":"Partially updates a cancellation with the specified ID.","description":"This method will patch an existing cancellation with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCancellation","name":"Partially updates a cancellation with the specified ID.","isWebhook":false,"pointer":"/paths/~1cancellations~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a cancellation with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing cancellation with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the cancellation to patch.","required":true}],"pointer":"/paths/~1cancellations~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1cancellations~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/cancellations/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/cancellations/{tenantId}/{id}","href":"cancellations/patchcancellation","openApiOperationId":"patchCancellation","summary":"Partially updates a cancellation with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cancellation was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Cancellation"}},"schemaId":"components/schemas/Cancellation","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The cancellation could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The cancellation could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve cancellation based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1cancellations~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Cancellation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Cancellation"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cancellations/patchcancellation"}],"panels":[]}]},"httpPath":"/cancellations/{tenantId}/{id}"},{"label":"Updates a cancellation with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellations/updatecancellation","routeSlug":"/apis/commerce/commerce-v1/cancellations/updatecancellation","metadata":{"seo":{"title":"Updates a cancellation with the specified ID.","description":"This method will update an existing cancellation with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCancellation","name":"Updates a cancellation with the specified ID.","isWebhook":false,"pointer":"/paths/~1cancellations~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a cancellation with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing cancellation with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the cancellation to update.","required":true}],"pointer":"/paths/~1cancellations~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Cancellation"}},"schemaId":"components/schemas/Cancellation","pointer":"/paths/~1cancellations~1{tenantId}~1{id}/put/requestBody","description":"The updated cancellation that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/cancellations/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Cancellation"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/cancellations/{tenantId}/{id}","href":"cancellations/updatecancellation","openApiOperationId":"updateCancellation","summary":"Updates a cancellation with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Cancellation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Cancellation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cancellation was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Cancellation"}},"schemaId":"components/schemas/Cancellation","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The cancellation supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The cancellation could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The cancellation could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve cancellation based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1cancellations~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Cancellation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Cancellation"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cancellations/updatecancellation"}],"panels":[]}]},"httpPath":"/cancellations/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Cancellations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancellations","showPageActions":true},{"nodeType":"markdoc","content":"Cancellations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/cancellations/warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cancellations/warmupstepfunctions","deprecated":false},{"title":"/cancellations/{tenantId}","summary":"Processes a cancellation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cancellations/processcancellation","deprecated":false},{"title":"/cancellations/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cancellations/executebatchoperations","deprecated":false},{"title":"/cancellations/{tenantId}/order/{order_id}","summary":"Returns a list of records with the specified order_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cancellations/listcancellationsbyorderid","deprecated":false},{"title":"/cancellations/{tenantId}/previewEmail","summary":"Sends out a preview of the CRC notification email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cancellations/previewemail","deprecated":false},{"title":"/cancellations/{tenantId}/sync","summary":"Processes a cancellation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cancellations/processcancellationsync","deprecated":false},{"title":"/cancellations/{tenantId}/{id}","summary":"Returns a cancellation from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cancellations/deletecancellation","deprecated":false},{"title":"/cancellations/{tenantId}/{id}","summary":"Returns a cancellation from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cancellations/getcancellation","deprecated":false},{"title":"/cancellations/{tenantId}/{id}","summary":"Partially updates a cancellation with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/cancellations/patchcancellation","deprecated":false},{"title":"/cancellations/{tenantId}/{id}","summary":"Updates a cancellation with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cancellations/updatecancellation","deprecated":false}]}]}]}]}},{"type":"group","label":"Carts","link":"/apis/commerce/commerce-v1/carts","routeSlug":"/apis/commerce/commerce-v1/carts","items":[{"label":"Creates a new cart record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/carts/createcart","routeSlug":"/apis/commerce/commerce-v1/carts/createcart","metadata":{"seo":{"title":"Creates a new cart record that does not already exist.","description":"This method will auto-generate an ID and create a new cart. If an ID is specified for the cart, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCart","name":"Creates a new cart record that does not already exist.","isWebhook":false,"pointer":"/paths/~1carts~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new cart record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new cart. If an ID is specified for the cart, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1carts~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Cart"}},"schemaId":"components/schemas/Cart","pointer":"/paths/~1carts~1{tenantId}/post/requestBody","description":"The cart that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/carts/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Cart"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/carts/{tenantId}","href":"carts/createcart","openApiOperationId":"createCart","summary":"Creates a new cart record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Cart","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Cart"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cart was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Cart"}},"schemaId":"components/schemas/Cart","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The cart you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The cart could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add cart based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1carts~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Cart","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Cart"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/carts/createcart"}],"panels":[]}]},"httpPath":"/carts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/carts/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/carts/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1carts~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1carts~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1carts~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/carts/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/carts/{tenantId}/batch","href":"carts/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The cart could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve cart based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1carts~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/carts/executebatchoperations"}],"panels":[]}]},"httpPath":"/carts/{tenantId}/batch"},{"label":"Returns a cart from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/carts/deletecart","routeSlug":"/apis/commerce/commerce-v1/carts/deletecart","metadata":{"seo":{"title":"Returns a cart from the system by its ID.","description":"This method will delete a cart with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCart","name":"Returns a cart from the system by its ID.","isWebhook":false,"pointer":"/paths/~1carts~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a cart from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a cart with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the cart to delete.","required":true}],"pointer":"/paths/~1carts~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/carts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/carts/{tenantId}/{id}","href":"carts/deletecart","openApiOperationId":"deleteCart","summary":"Returns a cart from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cart was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The cart could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The cart could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete cart based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1carts~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/carts/deletecart"}],"panels":[]}]},"httpPath":"/carts/{tenantId}/{id}"},{"label":"Returns a cart from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/carts/getcart","routeSlug":"/apis/commerce/commerce-v1/carts/getcart","metadata":{"seo":{"title":"Returns a cart from the system by its ID.","description":"This method will look up a cart by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCart","name":"Returns a cart from the system by its ID.","isWebhook":false,"pointer":"/paths/~1carts~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a cart from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a cart by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the cart to return.","required":true}],"pointer":"/paths/~1carts~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1carts~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/carts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/carts/{tenantId}/{id}","href":"carts/getcart","openApiOperationId":"getCart","summary":"Returns a cart from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cart was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Cart"}},"schemaId":"components/schemas/Cart","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The cart could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve cart based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1carts~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Cart","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Cart"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/carts/getcart"}],"panels":[]}]},"httpPath":"/carts/{tenantId}/{id}"},{"label":"Partially updates a cart with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/carts/patchcart","routeSlug":"/apis/commerce/commerce-v1/carts/patchcart","metadata":{"seo":{"title":"Partially updates a cart with the specified ID.","description":"This method will patch an existing cart with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCart","name":"Partially updates a cart with the specified ID.","isWebhook":false,"pointer":"/paths/~1carts~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a cart with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing cart with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the cart to patch.","required":true}],"pointer":"/paths/~1carts~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1carts~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/carts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/carts/{tenantId}/{id}","href":"carts/patchcart","openApiOperationId":"patchCart","summary":"Partially updates a cart with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cart was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Cart"}},"schemaId":"components/schemas/Cart","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The cart could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The cart could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve cart based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1carts~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Cart","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Cart"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/carts/patchcart"}],"panels":[]}]},"httpPath":"/carts/{tenantId}/{id}"},{"label":"Updates a cart with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/carts/updatecart","routeSlug":"/apis/commerce/commerce-v1/carts/updatecart","metadata":{"seo":{"title":"Updates a cart with the specified ID.","description":"This method will update an existing cart with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCart","name":"Updates a cart with the specified ID.","isWebhook":false,"pointer":"/paths/~1carts~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a cart with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing cart with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the cart to update.","required":true}],"pointer":"/paths/~1carts~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Cart"}},"schemaId":"components/schemas/Cart","pointer":"/paths/~1carts~1{tenantId}~1{id}/put/requestBody","description":"The updated cart that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/carts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Cart"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/carts/{tenantId}/{id}","href":"carts/updatecart","openApiOperationId":"updateCart","summary":"Updates a cart with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Cart","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Cart"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cart was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Cart"}},"schemaId":"components/schemas/Cart","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The cart supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The cart could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The cart could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve cart based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1carts~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Cart","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Cart"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/carts/updatecart"}],"panels":[]}]},"httpPath":"/carts/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Carts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Carts","showPageActions":true},{"nodeType":"markdoc","content":"Carts"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/carts/{tenantId}","summary":"Creates a new cart record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/carts/createcart","deprecated":false},{"title":"/carts/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/carts/executebatchoperations","deprecated":false},{"title":"/carts/{tenantId}/{id}","summary":"Returns a cart from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/carts/deletecart","deprecated":false},{"title":"/carts/{tenantId}/{id}","summary":"Returns a cart from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/carts/getcart","deprecated":false},{"title":"/carts/{tenantId}/{id}","summary":"Partially updates a cart with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/carts/patchcart","deprecated":false},{"title":"/carts/{tenantId}/{id}","summary":"Updates a cart with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/carts/updatecart","deprecated":false}]}]}]}]}},{"type":"group","label":"Coupon Code Gen Processes","link":"/apis/commerce/commerce-v1/coupon-code-gen-processes","routeSlug":"/apis/commerce/commerce-v1/coupon-code-gen-processes","items":[{"label":"Gets all of the coupon code gen processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-code-gen-processes/listcouponcodegenprocesses","routeSlug":"/apis/commerce/commerce-v1/coupon-code-gen-processes/listcouponcodegenprocesses","metadata":{"seo":{"title":"Gets all of the coupon code gen processes in the system.","description":"This method will scan all coupon code gen processes and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCouponCodeGenProcesses","name":"Gets all of the coupon code gen processes in the system.","isWebhook":false,"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the coupon code gen processes in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all coupon code gen processes and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/couponCodeGenProcesses/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/couponCodeGenProcesses/{tenantId}","href":"coupon-code-gen-processes/listcouponcodegenprocesses","openApiOperationId":"listCouponCodeGenProcesses","summary":"Gets all of the coupon code gen processes in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The coupon code gen processeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_463"}},"schemaId":"schema_463","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_463","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_463"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupon-code-gen-processes/listcouponcodegenprocesses"}],"panels":[]}]},"httpPath":"/couponCodeGenProcesses/{tenantId}"},{"label":"Creates a new coupon code gen process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-code-gen-processes/createcouponcodegenprocess","routeSlug":"/apis/commerce/commerce-v1/coupon-code-gen-processes/createcouponcodegenprocess","metadata":{"seo":{"title":"Creates a new coupon code gen process record that does not already exist.","description":"This method will auto-generate an ID and create a new coupon code gen process. If an ID is specified for the coupon code gen process, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCouponCodeGenProcess","name":"Creates a new coupon code gen process record that does not already exist.","isWebhook":false,"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new coupon code gen process record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new coupon code gen process. If an ID is specified for the coupon code gen process, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CouponCodeGenProcess"}},"schemaId":"components/schemas/CouponCodeGenProcess","pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}/post/requestBody","description":"The coupon code gen process that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/couponCodeGenProcesses/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CouponCodeGenProcess"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/couponCodeGenProcesses/{tenantId}","href":"coupon-code-gen-processes/createcouponcodegenprocess","openApiOperationId":"createCouponCodeGenProcess","summary":"Creates a new coupon code gen process record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CouponCodeGenProcess","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CouponCodeGenProcess"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The coupon code gen process was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponCodeGenProcess"}},"schemaId":"components/schemas/CouponCodeGenProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The coupon code gen process you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The coupon code gen process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add coupon code gen process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CouponCodeGenProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponCodeGenProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupon-code-gen-processes/createcouponcodegenprocess"}],"panels":[]}]},"httpPath":"/couponCodeGenProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-code-gen-processes/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/coupon-code-gen-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/couponCodeGenProcesses/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/couponCodeGenProcesses/{tenantId}/batch","href":"coupon-code-gen-processes/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The coupon code gen process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve coupon code gen process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupon-code-gen-processes/executebatchoperations"}],"panels":[]}]},"httpPath":"/couponCodeGenProcesses/{tenantId}/batch"},{"label":"Returns a coupon code gen process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-code-gen-processes/deletecouponcodegenprocess","routeSlug":"/apis/commerce/commerce-v1/coupon-code-gen-processes/deletecouponcodegenprocess","metadata":{"seo":{"title":"Returns a coupon code gen process from the system by its ID.","description":"This method will delete a coupon code gen process with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCouponCodeGenProcess","name":"Returns a coupon code gen process from the system by its ID.","isWebhook":false,"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a coupon code gen process from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a coupon code gen process with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the coupon code gen process to delete.","required":true}],"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/couponCodeGenProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/couponCodeGenProcesses/{tenantId}/{id}","href":"coupon-code-gen-processes/deletecouponcodegenprocess","openApiOperationId":"deleteCouponCodeGenProcess","summary":"Returns a coupon code gen process from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The coupon code gen process was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The coupon code gen process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The coupon code gen process could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete coupon code gen process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupon-code-gen-processes/deletecouponcodegenprocess"}],"panels":[]}]},"httpPath":"/couponCodeGenProcesses/{tenantId}/{id}"},{"label":"Returns a coupon code gen process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-code-gen-processes/getcouponcodegenprocess","routeSlug":"/apis/commerce/commerce-v1/coupon-code-gen-processes/getcouponcodegenprocess","metadata":{"seo":{"title":"Returns a coupon code gen process from the system by its ID.","description":"This method will look up a coupon code gen process by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCouponCodeGenProcess","name":"Returns a coupon code gen process from the system by its ID.","isWebhook":false,"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a coupon code gen process from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a coupon code gen process by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the coupon code gen process to return.","required":true}],"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/couponCodeGenProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/couponCodeGenProcesses/{tenantId}/{id}","href":"coupon-code-gen-processes/getcouponcodegenprocess","openApiOperationId":"getCouponCodeGenProcess","summary":"Returns a coupon code gen process from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The coupon code gen process was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponCodeGenProcess"}},"schemaId":"components/schemas/CouponCodeGenProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The coupon code gen process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve coupon code gen process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CouponCodeGenProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponCodeGenProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupon-code-gen-processes/getcouponcodegenprocess"}],"panels":[]}]},"httpPath":"/couponCodeGenProcesses/{tenantId}/{id}"},{"label":"Partially updates a coupon code gen process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-code-gen-processes/patchcouponcodegenprocess","routeSlug":"/apis/commerce/commerce-v1/coupon-code-gen-processes/patchcouponcodegenprocess","metadata":{"seo":{"title":"Partially updates a coupon code gen process with the specified ID.","description":"This method will patch an existing coupon code gen process with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCouponCodeGenProcess","name":"Partially updates a coupon code gen process with the specified ID.","isWebhook":false,"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a coupon code gen process with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing coupon code gen process with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the coupon code gen process to patch.","required":true}],"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/couponCodeGenProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/couponCodeGenProcesses/{tenantId}/{id}","href":"coupon-code-gen-processes/patchcouponcodegenprocess","openApiOperationId":"patchCouponCodeGenProcess","summary":"Partially updates a coupon code gen process with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The coupon code gen process was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponCodeGenProcess"}},"schemaId":"components/schemas/CouponCodeGenProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The coupon code gen process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The coupon code gen process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve coupon code gen process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CouponCodeGenProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponCodeGenProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupon-code-gen-processes/patchcouponcodegenprocess"}],"panels":[]}]},"httpPath":"/couponCodeGenProcesses/{tenantId}/{id}"},{"label":"Updates a coupon code gen process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-code-gen-processes/updatecouponcodegenprocess","routeSlug":"/apis/commerce/commerce-v1/coupon-code-gen-processes/updatecouponcodegenprocess","metadata":{"seo":{"title":"Updates a coupon code gen process with the specified ID.","description":"This method will update an existing coupon code gen process with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCouponCodeGenProcess","name":"Updates a coupon code gen process with the specified ID.","isWebhook":false,"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a coupon code gen process with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing coupon code gen process with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the coupon code gen process to update.","required":true}],"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CouponCodeGenProcess"}},"schemaId":"components/schemas/CouponCodeGenProcess","pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}~1{id}/put/requestBody","description":"The updated coupon code gen process that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/couponCodeGenProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CouponCodeGenProcess"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/couponCodeGenProcesses/{tenantId}/{id}","href":"coupon-code-gen-processes/updatecouponcodegenprocess","openApiOperationId":"updateCouponCodeGenProcess","summary":"Updates a coupon code gen process with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CouponCodeGenProcess","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CouponCodeGenProcess"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The coupon code gen process was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponCodeGenProcess"}},"schemaId":"components/schemas/CouponCodeGenProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The coupon code gen process supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The coupon code gen process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The coupon code gen process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve coupon code gen process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1couponCodeGenProcesses~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CouponCodeGenProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponCodeGenProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupon-code-gen-processes/updatecouponcodegenprocess"}],"panels":[]}]},"httpPath":"/couponCodeGenProcesses/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Coupon Code Gen Processes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Coupon Code Gen Processes","showPageActions":true},{"nodeType":"markdoc","content":"Coupon Code Gen Processes"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/couponCodeGenProcesses/{tenantId}","summary":"Gets all of the coupon code gen processes in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/coupon-code-gen-processes/listcouponcodegenprocesses","deprecated":false},{"title":"/couponCodeGenProcesses/{tenantId}","summary":"Creates a new coupon code gen process record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coupon-code-gen-processes/createcouponcodegenprocess","deprecated":false},{"title":"/couponCodeGenProcesses/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coupon-code-gen-processes/executebatchoperations","deprecated":false},{"title":"/couponCodeGenProcesses/{tenantId}/{id}","summary":"Returns a coupon code gen process from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/coupon-code-gen-processes/deletecouponcodegenprocess","deprecated":false},{"title":"/couponCodeGenProcesses/{tenantId}/{id}","summary":"Returns a coupon code gen process from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/coupon-code-gen-processes/getcouponcodegenprocess","deprecated":false},{"title":"/couponCodeGenProcesses/{tenantId}/{id}","summary":"Partially updates a coupon code gen process with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/coupon-code-gen-processes/patchcouponcodegenprocess","deprecated":false},{"title":"/couponCodeGenProcesses/{tenantId}/{id}","summary":"Updates a coupon code gen process with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/coupon-code-gen-processes/updatecouponcodegenprocess","deprecated":false}]}]}]}]}},{"type":"group","label":"Coupon Codes","link":"/apis/commerce/commerce-v1/coupon-codes","routeSlug":"/apis/commerce/commerce-v1/coupon-codes","items":[{"label":"Returns a list of records with the specified tenant_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/listcodesbytenantid","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/listcodesbytenantid","metadata":{"seo":{"title":"Returns a list of records with the specified tenant_id","description":"Returns a list of records with the specified tenant_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCodesByTenantId","name":"Returns a list of records with the specified tenant_id","isWebhook":false,"pointer":"/paths/~1couponCodes~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified tenant_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified tenant_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true}],"pointer":"/paths/~1couponCodes~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1couponCodes~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/couponCodes/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/couponCodes/{tenantId}","href":"coupon-codes/listcodesbytenantid","openApiOperationId":"listCodesByTenantId","summary":"Returns a list of records with the specified tenant_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCouponCodesResponse"}},"schemaId":"components/schemas/ListCouponCodesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1couponCodes~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCouponCodesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCouponCodesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupon-codes/listcodesbytenantid"}],"panels":[]}]},"httpPath":"/couponCodes/{tenantId}"},{"label":"Creates a new coupon code record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/createcouponcode","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/createcouponcode","metadata":{"seo":{"title":"Creates a new coupon code record that does not already exist.","description":"This method will auto-generate an ID and create a new coupon code. If an ID is specified for the coupon code, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCouponCode","name":"Creates a new coupon code record that does not already exist.","isWebhook":false,"pointer":"/paths/~1couponCodes~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new coupon code record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new coupon code. If an ID is specified for the coupon code, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1couponCodes~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CouponCode"}},"schemaId":"components/schemas/CouponCode","pointer":"/paths/~1couponCodes~1{tenantId}/post/requestBody","description":"The coupon code that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/couponCodes/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CouponCode"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/couponCodes/{tenantId}","href":"coupon-codes/createcouponcode","openApiOperationId":"createCouponCode","summary":"Creates a new coupon code record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CouponCode","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CouponCode"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The coupon code was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponCode"}},"schemaId":"components/schemas/CouponCode","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The coupon code you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The coupon code could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add coupon code based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1couponCodes~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CouponCode","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponCode"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupon-codes/createcouponcode"}],"panels":[]}]},"httpPath":"/couponCodes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1couponCodes~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1couponCodes~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1couponCodes~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/couponCodes/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/couponCodes/{tenantId}/batch","href":"coupon-codes/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The coupon code could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve coupon code based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1couponCodes~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupon-codes/executebatchoperations"}],"panels":[]}]},"httpPath":"/couponCodes/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/listcodesbycontactid","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/listcodesbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCodesByContactId","name":"Returns a list of records with the specified contact_id","isWebhook":false,"pointer":"/paths/~1couponCodes~1{tenantId}~1contact~1{contact_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified contact_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified contact_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"contact_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1couponCodes~1{tenantId}~1contact~1{contact_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1couponCodes~1{tenantId}~1contact~1{contact_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/couponCodes/{tenantId}/contact/{contact_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"contact_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/couponCodes/{tenantId}/contact/{contact_id}","href":"coupon-codes/listcodesbycontactid","openApiOperationId":"listCodesByContactId","summary":"Returns a list of records with the specified contact_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCouponCodesResponse"}},"schemaId":"components/schemas/ListCouponCodesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1couponCodes~1{tenantId}~1contact~1{contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCouponCodesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCouponCodesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupon-codes/listcodesbycontactid"}],"panels":[]}]},"httpPath":"/couponCodes/{tenantId}/contact/{contact_id}"},{"label":"Returns a list of records with the specified coupon_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/listcodesbycouponid","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/listcodesbycouponid","metadata":{"seo":{"title":"Returns a list of records with the specified coupon_id","description":"Returns a list of records with the specified coupon_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCodesByCouponId","name":"Returns a list of records with the specified coupon_id","isWebhook":false,"pointer":"/paths/~1couponCodes~1{tenantId}~1coupon~1{coupon_type}~1{coupon_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified coupon_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified coupon_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"coupon_type","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The coupon_type to use to for record lookup"},"children":[]}]}]}],"required":true},{"name":"coupon_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The coupon_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1couponCodes~1{tenantId}~1coupon~1{coupon_type}~1{coupon_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1couponCodes~1{tenantId}~1coupon~1{coupon_type}~1{coupon_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/couponCodes/{tenantId}/coupon/{coupon_type}/{coupon_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"coupon_type","in":"path","required":true,"schemaId":"schema_459"},{"name":"coupon_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/couponCodes/{tenantId}/coupon/{coupon_type}/{coupon_id}","href":"coupon-codes/listcodesbycouponid","openApiOperationId":"listCodesByCouponId","summary":"Returns a list of records with the specified coupon_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCouponCodesResponse"}},"schemaId":"components/schemas/ListCouponCodesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1couponCodes~1{tenantId}~1coupon~1{coupon_type}~1{coupon_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCouponCodesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCouponCodesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupon-codes/listcodesbycouponid"}],"panels":[]}]},"httpPath":"/couponCodes/{tenantId}/coupon/{coupon_type}/{coupon_id}"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/listcodesbyorderid","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/listcodesbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCodesByOrderId","name":"Returns a list of records with the specified order_id","isWebhook":false,"pointer":"/paths/~1couponCodes~1{tenantId}~1order~1{order_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified order_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified order_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"order_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1couponCodes~1{tenantId}~1order~1{order_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1couponCodes~1{tenantId}~1order~1{order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/couponCodes/{tenantId}/order/{order_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/couponCodes/{tenantId}/order/{order_id}","href":"coupon-codes/listcodesbyorderid","openApiOperationId":"listCodesByOrderId","summary":"Returns a list of records with the specified order_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCouponCodesResponse"}},"schemaId":"components/schemas/ListCouponCodesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1couponCodes~1{tenantId}~1order~1{order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCouponCodesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCouponCodesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupon-codes/listcodesbyorderid"}],"panels":[]}]},"httpPath":"/couponCodes/{tenantId}/order/{order_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/listcodesbyorganizationid","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/listcodesbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCodesByOrganizationId","name":"Returns a list of records with the specified organization_id","isWebhook":false,"pointer":"/paths/~1couponCodes~1{tenantId}~1organization~1{organization_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified organization_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified organization_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"organization_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1couponCodes~1{tenantId}~1organization~1{organization_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1couponCodes~1{tenantId}~1organization~1{organization_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/couponCodes/{tenantId}/organization/{organization_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"organization_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/couponCodes/{tenantId}/organization/{organization_id}","href":"coupon-codes/listcodesbyorganizationid","openApiOperationId":"listCodesByOrganizationId","summary":"Returns a list of records with the specified organization_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCouponCodesResponse"}},"schemaId":"components/schemas/ListCouponCodesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1couponCodes~1{tenantId}~1organization~1{organization_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCouponCodesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCouponCodesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupon-codes/listcodesbyorganizationid"}],"panels":[]}]},"httpPath":"/couponCodes/{tenantId}/organization/{organization_id}"},{"label":"Sends out a preview of the email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/previewemail","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/previewemail","metadata":{"seo":{"title":"Sends out a preview of the email","description":"Sends out a preview of the email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewEmail","name":"Sends out a preview of the email","isWebhook":false,"pointer":"/paths/~1couponCodes~1{tenantId}~1previewEmail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the email"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true}],"pointer":"/paths/~1couponCodes~1{tenantId}~1previewEmail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"schemaId":"components/schemas/PreviewEmailRequest","pointer":"/paths/~1couponCodes~1{tenantId}~1previewEmail/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/couponCodes/{tenantId}/previewEmail","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/couponCodes/{tenantId}/previewEmail","href":"coupon-codes/previewemail","openApiOperationId":"previewEmail","summary":"Sends out a preview of the email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewEmailRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1couponCodes~1{tenantId}~1previewEmail/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupon-codes/previewemail"}],"panels":[]}]},"httpPath":"/couponCodes/{tenantId}/previewEmail"},{"label":"Returns a coupon code from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/deletecouponcode","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/deletecouponcode","metadata":{"seo":{"title":"Returns a coupon code from the system by its ID.","description":"This method will delete a coupon code with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCouponCode","name":"Returns a coupon code from the system by its ID.","isWebhook":false,"pointer":"/paths/~1couponCodes~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a coupon code from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a coupon code with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the coupon code to delete.","required":true}],"pointer":"/paths/~1couponCodes~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/couponCodes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/couponCodes/{tenantId}/{id}","href":"coupon-codes/deletecouponcode","openApiOperationId":"deleteCouponCode","summary":"Returns a coupon code from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The coupon code was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The coupon code could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The coupon code could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete coupon code based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1couponCodes~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupon-codes/deletecouponcode"}],"panels":[]}]},"httpPath":"/couponCodes/{tenantId}/{id}"},{"label":"Returns a coupon code from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/getcouponcode","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/getcouponcode","metadata":{"seo":{"title":"Returns a coupon code from the system by its ID.","description":"This method will look up a coupon code by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCouponCode","name":"Returns a coupon code from the system by its ID.","isWebhook":false,"pointer":"/paths/~1couponCodes~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a coupon code from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a coupon code by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the coupon code to return.","required":true}],"pointer":"/paths/~1couponCodes~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1couponCodes~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/couponCodes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/couponCodes/{tenantId}/{id}","href":"coupon-codes/getcouponcode","openApiOperationId":"getCouponCode","summary":"Returns a coupon code from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The coupon code was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponCode"}},"schemaId":"components/schemas/CouponCode","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The coupon code could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve coupon code based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1couponCodes~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CouponCode","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponCode"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupon-codes/getcouponcode"}],"panels":[]}]},"httpPath":"/couponCodes/{tenantId}/{id}"},{"label":"Partially updates a coupon code with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/patchcouponcode","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/patchcouponcode","metadata":{"seo":{"title":"Partially updates a coupon code with the specified ID.","description":"This method will patch an existing coupon code with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCouponCode","name":"Partially updates a coupon code with the specified ID.","isWebhook":false,"pointer":"/paths/~1couponCodes~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a coupon code with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing coupon code with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the coupon code to patch.","required":true}],"pointer":"/paths/~1couponCodes~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1couponCodes~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/couponCodes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/couponCodes/{tenantId}/{id}","href":"coupon-codes/patchcouponcode","openApiOperationId":"patchCouponCode","summary":"Partially updates a coupon code with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The coupon code was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponCode"}},"schemaId":"components/schemas/CouponCode","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The coupon code could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The coupon code could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve coupon code based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1couponCodes~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CouponCode","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponCode"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupon-codes/patchcouponcode"}],"panels":[]}]},"httpPath":"/couponCodes/{tenantId}/{id}"},{"label":"Updates a coupon code with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/updatecouponcode","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/updatecouponcode","metadata":{"seo":{"title":"Updates a coupon code with the specified ID.","description":"This method will update an existing coupon code with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCouponCode","name":"Updates a coupon code with the specified ID.","isWebhook":false,"pointer":"/paths/~1couponCodes~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a coupon code with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing coupon code with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the coupon code to update.","required":true}],"pointer":"/paths/~1couponCodes~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CouponCode"}},"schemaId":"components/schemas/CouponCode","pointer":"/paths/~1couponCodes~1{tenantId}~1{id}/put/requestBody","description":"The updated coupon code that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/couponCodes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CouponCode"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/couponCodes/{tenantId}/{id}","href":"coupon-codes/updatecouponcode","openApiOperationId":"updateCouponCode","summary":"Updates a coupon code with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CouponCode","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CouponCode"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The coupon code was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponCode"}},"schemaId":"components/schemas/CouponCode","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The coupon code supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The coupon code could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The coupon code could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve coupon code based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1couponCodes~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CouponCode","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponCode"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupon-codes/updatecouponcode"}],"panels":[]}]},"httpPath":"/couponCodes/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Coupon Codes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Coupon Codes","showPageActions":true},{"nodeType":"markdoc","content":"Coupon Codes"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/couponCodes/{tenantId}","summary":"Returns a list of records with the specified tenant_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/coupon-codes/listcodesbytenantid","deprecated":false},{"title":"/couponCodes/{tenantId}","summary":"Creates a new coupon code record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coupon-codes/createcouponcode","deprecated":false},{"title":"/couponCodes/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coupon-codes/executebatchoperations","deprecated":false},{"title":"/couponCodes/{tenantId}/contact/{contact_id}","summary":"Returns a list of records with the specified contact_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/coupon-codes/listcodesbycontactid","deprecated":false},{"title":"/couponCodes/{tenantId}/coupon/{coupon_type}/{coupon_id}","summary":"Returns a list of records with the specified coupon_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/coupon-codes/listcodesbycouponid","deprecated":false},{"title":"/couponCodes/{tenantId}/order/{order_id}","summary":"Returns a list of records with the specified order_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/coupon-codes/listcodesbyorderid","deprecated":false},{"title":"/couponCodes/{tenantId}/organization/{organization_id}","summary":"Returns a list of records with the specified organization_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/coupon-codes/listcodesbyorganizationid","deprecated":false},{"title":"/couponCodes/{tenantId}/previewEmail","summary":"Sends out a preview of the email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coupon-codes/previewemail","deprecated":false},{"title":"/couponCodes/{tenantId}/{id}","summary":"Returns a coupon code from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/coupon-codes/deletecouponcode","deprecated":false},{"title":"/couponCodes/{tenantId}/{id}","summary":"Returns a coupon code from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/coupon-codes/getcouponcode","deprecated":false},{"title":"/couponCodes/{tenantId}/{id}","summary":"Partially updates a coupon code with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/coupon-codes/patchcouponcode","deprecated":false},{"title":"/couponCodes/{tenantId}/{id}","summary":"Updates a coupon code with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/coupon-codes/updatecouponcode","deprecated":false}]}]}]}]}},{"type":"group","label":"Coupons","link":"/apis/commerce/commerce-v1/coupons","routeSlug":"/apis/commerce/commerce-v1/coupons","items":[{"label":"Gets all of the coupons in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupons/listcoupons","routeSlug":"/apis/commerce/commerce-v1/coupons/listcoupons","metadata":{"seo":{"title":"Gets all of the coupons in the system.","description":"This method will scan all coupons and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCoupons","name":"Gets all of the coupons in the system.","isWebhook":false,"pointer":"/paths/~1coupons~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the coupons in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all coupons and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1coupons~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1coupons~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/coupons/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/coupons/{tenantId}","href":"coupons/listcoupons","openApiOperationId":"listCoupons","summary":"Gets all of the coupons in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The couponswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_464"}},"schemaId":"schema_464","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1coupons~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_464","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_464"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/listcoupons"}],"panels":[]}]},"httpPath":"/coupons/{tenantId}"},{"label":"Creates a new coupon record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupons/createcoupon","routeSlug":"/apis/commerce/commerce-v1/coupons/createcoupon","metadata":{"seo":{"title":"Creates a new coupon record that does not already exist.","description":"This method will auto-generate an ID and create a new coupon. If an ID is specified for the coupon, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCoupon","name":"Creates a new coupon record that does not already exist.","isWebhook":false,"pointer":"/paths/~1coupons~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new coupon record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new coupon. If an ID is specified for the coupon, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1coupons~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Coupon"}},"schemaId":"components/schemas/Coupon","pointer":"/paths/~1coupons~1{tenantId}/post/requestBody","description":"The coupon that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/coupons/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Coupon"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/coupons/{tenantId}","href":"coupons/createcoupon","openApiOperationId":"createCoupon","summary":"Creates a new coupon record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Coupon","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Coupon"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The coupon was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}},"schemaId":"components/schemas/Coupon","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The coupon you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The coupon could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add coupon based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1coupons~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Coupon","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/createcoupon"}],"panels":[]}]},"httpPath":"/coupons/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupons/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/coupons/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1coupons~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1coupons~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1coupons~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/coupons/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/coupons/{tenantId}/batch","href":"coupons/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The coupon could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve coupon based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1coupons~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/executebatchoperations"}],"panels":[]}]},"httpPath":"/coupons/{tenantId}/batch"},{"label":"Returns a coupon from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupons/deletecoupon","routeSlug":"/apis/commerce/commerce-v1/coupons/deletecoupon","metadata":{"seo":{"title":"Returns a coupon from the system by its ID.","description":"This method will delete a coupon with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCoupon","name":"Returns a coupon from the system by its ID.","isWebhook":false,"pointer":"/paths/~1coupons~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a coupon from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a coupon with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the coupon to delete.","required":true}],"pointer":"/paths/~1coupons~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/coupons/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/coupons/{tenantId}/{id}","href":"coupons/deletecoupon","openApiOperationId":"deleteCoupon","summary":"Returns a coupon from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The coupon was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The coupon could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The coupon could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete coupon based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1coupons~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/deletecoupon"}],"panels":[]}]},"httpPath":"/coupons/{tenantId}/{id}"},{"label":"Returns a coupon from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupons/getcoupon","routeSlug":"/apis/commerce/commerce-v1/coupons/getcoupon","metadata":{"seo":{"title":"Returns a coupon from the system by its ID.","description":"This method will look up a coupon by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCoupon","name":"Returns a coupon from the system by its ID.","isWebhook":false,"pointer":"/paths/~1coupons~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a coupon from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a coupon by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the coupon to return.","required":true}],"pointer":"/paths/~1coupons~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1coupons~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/coupons/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/coupons/{tenantId}/{id}","href":"coupons/getcoupon","openApiOperationId":"getCoupon","summary":"Returns a coupon from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The coupon was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}},"schemaId":"components/schemas/Coupon","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The coupon could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve coupon based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1coupons~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Coupon","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/getcoupon"}],"panels":[]}]},"httpPath":"/coupons/{tenantId}/{id}"},{"label":"Partially updates a coupon with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupons/patchcoupon","routeSlug":"/apis/commerce/commerce-v1/coupons/patchcoupon","metadata":{"seo":{"title":"Partially updates a coupon with the specified ID.","description":"This method will patch an existing coupon with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCoupon","name":"Partially updates a coupon with the specified ID.","isWebhook":false,"pointer":"/paths/~1coupons~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a coupon with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing coupon with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the coupon to patch.","required":true}],"pointer":"/paths/~1coupons~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1coupons~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/coupons/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/coupons/{tenantId}/{id}","href":"coupons/patchcoupon","openApiOperationId":"patchCoupon","summary":"Partially updates a coupon with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The coupon was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}},"schemaId":"components/schemas/Coupon","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The coupon could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The coupon could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve coupon based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1coupons~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Coupon","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/patchcoupon"}],"panels":[]}]},"httpPath":"/coupons/{tenantId}/{id}"},{"label":"Updates a coupon with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupons/updatecoupon","routeSlug":"/apis/commerce/commerce-v1/coupons/updatecoupon","metadata":{"seo":{"title":"Updates a coupon with the specified ID.","description":"This method will update an existing coupon with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCoupon","name":"Updates a coupon with the specified ID.","isWebhook":false,"pointer":"/paths/~1coupons~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a coupon with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing coupon with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the coupon to update.","required":true}],"pointer":"/paths/~1coupons~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Coupon"}},"schemaId":"components/schemas/Coupon","pointer":"/paths/~1coupons~1{tenantId}~1{id}/put/requestBody","description":"The updated coupon that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/coupons/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Coupon"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/coupons/{tenantId}/{id}","href":"coupons/updatecoupon","openApiOperationId":"updateCoupon","summary":"Updates a coupon with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Coupon","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Coupon"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The coupon was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}},"schemaId":"components/schemas/Coupon","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The coupon supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The coupon could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The coupon could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve coupon based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1coupons~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Coupon","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/updatecoupon"}],"panels":[]}]},"httpPath":"/coupons/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Coupons"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Coupons","showPageActions":true},{"nodeType":"markdoc","content":"Coupons"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/coupons/{tenantId}","summary":"Gets all of the coupons in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/coupons/listcoupons","deprecated":false},{"title":"/coupons/{tenantId}","summary":"Creates a new coupon record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coupons/createcoupon","deprecated":false},{"title":"/coupons/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coupons/executebatchoperations","deprecated":false},{"title":"/coupons/{tenantId}/{id}","summary":"Returns a coupon from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/coupons/deletecoupon","deprecated":false},{"title":"/coupons/{tenantId}/{id}","summary":"Returns a coupon from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/coupons/getcoupon","deprecated":false},{"title":"/coupons/{tenantId}/{id}","summary":"Partially updates a coupon with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/coupons/patchcoupon","deprecated":false},{"title":"/coupons/{tenantId}/{id}","summary":"Updates a coupon with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/coupons/updatecoupon","deprecated":false}]}]}]}]}},{"type":"group","label":"Discount Products","link":"/apis/commerce/commerce-v1/discount-products","routeSlug":"/apis/commerce/commerce-v1/discount-products","items":[{"label":"Gets all of the discount products in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/discount-products/listdiscountproducts","routeSlug":"/apis/commerce/commerce-v1/discount-products/listdiscountproducts","metadata":{"seo":{"title":"Gets all of the discount products in the system.","description":"This method will scan all discount products and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDiscountProducts","name":"Gets all of the discount products in the system.","isWebhook":false,"pointer":"/paths/~1discountProducts~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the discount products in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all discount products and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1discountProducts~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1discountProducts~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/discountProducts/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/discountProducts/{tenantId}","href":"discount-products/listdiscountproducts","openApiOperationId":"listDiscountProducts","summary":"Gets all of the discount products in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The discount productswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_465"}},"schemaId":"schema_465","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1discountProducts~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_465","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_465"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discount-products/listdiscountproducts"}],"panels":[]}]},"httpPath":"/discountProducts/{tenantId}"},{"label":"Creates a new discount product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/discount-products/creatediscountproduct","routeSlug":"/apis/commerce/commerce-v1/discount-products/creatediscountproduct","metadata":{"seo":{"title":"Creates a new discount product record that does not already exist.","description":"This method will auto-generate an ID and create a new discount product. If an ID is specified for the discount product, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDiscountProduct","name":"Creates a new discount product record that does not already exist.","isWebhook":false,"pointer":"/paths/~1discountProducts~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new discount product record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new discount product. If an ID is specified for the discount product, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1discountProducts~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DiscountProduct"}},"schemaId":"components/schemas/DiscountProduct","pointer":"/paths/~1discountProducts~1{tenantId}/post/requestBody","description":"The discount product that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/discountProducts/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DiscountProduct"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/discountProducts/{tenantId}","href":"discount-products/creatediscountproduct","openApiOperationId":"createDiscountProduct","summary":"Creates a new discount product record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DiscountProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DiscountProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The discount product was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DiscountProduct"}},"schemaId":"components/schemas/DiscountProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The discount product you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The discount product could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add discount product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1discountProducts~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DiscountProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DiscountProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discount-products/creatediscountproduct"}],"panels":[]}]},"httpPath":"/discountProducts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/discount-products/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/discount-products/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1discountProducts~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1discountProducts~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1discountProducts~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/discountProducts/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/discountProducts/{tenantId}/batch","href":"discount-products/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The discount product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve discount product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1discountProducts~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discount-products/executebatchoperations"}],"panels":[]}]},"httpPath":"/discountProducts/{tenantId}/batch"},{"label":"Returns a discount product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/discount-products/deletediscountproduct","routeSlug":"/apis/commerce/commerce-v1/discount-products/deletediscountproduct","metadata":{"seo":{"title":"Returns a discount product from the system by its ID.","description":"This method will delete a discount product with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDiscountProduct","name":"Returns a discount product from the system by its ID.","isWebhook":false,"pointer":"/paths/~1discountProducts~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a discount product from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a discount product with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the discount product to delete.","required":true}],"pointer":"/paths/~1discountProducts~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/discountProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/discountProducts/{tenantId}/{id}","href":"discount-products/deletediscountproduct","openApiOperationId":"deleteDiscountProduct","summary":"Returns a discount product from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The discount product was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The discount product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The discount product could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete discount product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1discountProducts~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discount-products/deletediscountproduct"}],"panels":[]}]},"httpPath":"/discountProducts/{tenantId}/{id}"},{"label":"Returns a discount product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/discount-products/getdiscountproduct","routeSlug":"/apis/commerce/commerce-v1/discount-products/getdiscountproduct","metadata":{"seo":{"title":"Returns a discount product from the system by its ID.","description":"This method will look up a discount product by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDiscountProduct","name":"Returns a discount product from the system by its ID.","isWebhook":false,"pointer":"/paths/~1discountProducts~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a discount product from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a discount product by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the discount product to return.","required":true}],"pointer":"/paths/~1discountProducts~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1discountProducts~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/discountProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/discountProducts/{tenantId}/{id}","href":"discount-products/getdiscountproduct","openApiOperationId":"getDiscountProduct","summary":"Returns a discount product from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The discount product was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DiscountProduct"}},"schemaId":"components/schemas/DiscountProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The discount product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve discount product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1discountProducts~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DiscountProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DiscountProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discount-products/getdiscountproduct"}],"panels":[]}]},"httpPath":"/discountProducts/{tenantId}/{id}"},{"label":"Partially updates a discount product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/discount-products/patchdiscountproduct","routeSlug":"/apis/commerce/commerce-v1/discount-products/patchdiscountproduct","metadata":{"seo":{"title":"Partially updates a discount product with the specified ID.","description":"This method will patch an existing discount product with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchDiscountProduct","name":"Partially updates a discount product with the specified ID.","isWebhook":false,"pointer":"/paths/~1discountProducts~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a discount product with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing discount product with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the discount product to patch.","required":true}],"pointer":"/paths/~1discountProducts~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1discountProducts~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/discountProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/discountProducts/{tenantId}/{id}","href":"discount-products/patchdiscountproduct","openApiOperationId":"patchDiscountProduct","summary":"Partially updates a discount product with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The discount product was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DiscountProduct"}},"schemaId":"components/schemas/DiscountProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The discount product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The discount product could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve discount product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1discountProducts~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DiscountProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DiscountProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discount-products/patchdiscountproduct"}],"panels":[]}]},"httpPath":"/discountProducts/{tenantId}/{id}"},{"label":"Updates a discount product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/discount-products/updatediscountproduct","routeSlug":"/apis/commerce/commerce-v1/discount-products/updatediscountproduct","metadata":{"seo":{"title":"Updates a discount product with the specified ID.","description":"This method will update an existing discount product with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDiscountProduct","name":"Updates a discount product with the specified ID.","isWebhook":false,"pointer":"/paths/~1discountProducts~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a discount product with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing discount product with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the discount product to update.","required":true}],"pointer":"/paths/~1discountProducts~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DiscountProduct"}},"schemaId":"components/schemas/DiscountProduct","pointer":"/paths/~1discountProducts~1{tenantId}~1{id}/put/requestBody","description":"The updated discount product that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/discountProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DiscountProduct"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/discountProducts/{tenantId}/{id}","href":"discount-products/updatediscountproduct","openApiOperationId":"updateDiscountProduct","summary":"Updates a discount product with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DiscountProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DiscountProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The discount product was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DiscountProduct"}},"schemaId":"components/schemas/DiscountProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The discount product supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The discount product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The discount product could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve discount product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1discountProducts~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DiscountProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DiscountProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discount-products/updatediscountproduct"}],"panels":[]}]},"httpPath":"/discountProducts/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Discount Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discount Products","showPageActions":true},{"nodeType":"markdoc","content":"Discount Products"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/discountProducts/{tenantId}","summary":"Gets all of the discount products in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/discount-products/listdiscountproducts","deprecated":false},{"title":"/discountProducts/{tenantId}","summary":"Creates a new discount product record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/discount-products/creatediscountproduct","deprecated":false},{"title":"/discountProducts/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/discount-products/executebatchoperations","deprecated":false},{"title":"/discountProducts/{tenantId}/{id}","summary":"Returns a discount product from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/discount-products/deletediscountproduct","deprecated":false},{"title":"/discountProducts/{tenantId}/{id}","summary":"Returns a discount product from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/discount-products/getdiscountproduct","deprecated":false},{"title":"/discountProducts/{tenantId}/{id}","summary":"Partially updates a discount product with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/discount-products/patchdiscountproduct","deprecated":false},{"title":"/discountProducts/{tenantId}/{id}","summary":"Updates a discount product with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/discount-products/updatediscountproduct","deprecated":false}]}]}]}]}},{"type":"group","label":"Entitlement Types","link":"/apis/commerce/commerce-v1/entitlement-types","routeSlug":"/apis/commerce/commerce-v1/entitlement-types","items":[{"label":"Gets all of the entitlement types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlement-types/listentitlementtypes","routeSlug":"/apis/commerce/commerce-v1/entitlement-types/listentitlementtypes","metadata":{"seo":{"title":"Gets all of the entitlement types in the system.","description":"This method will scan all entitlement types and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEntitlementTypes","name":"Gets all of the entitlement types in the system.","isWebhook":false,"pointer":"/paths/~1entitlementTypes~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the entitlement types in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all entitlement types and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1entitlementTypes~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1entitlementTypes~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/entitlementTypes/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/entitlementTypes/{tenantId}","href":"entitlement-types/listentitlementtypes","openApiOperationId":"listEntitlementTypes","summary":"Gets all of the entitlement types in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The entitlement typeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_466"}},"schemaId":"schema_466","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1entitlementTypes~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_466","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_466"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlement-types/listentitlementtypes"}],"panels":[]}]},"httpPath":"/entitlementTypes/{tenantId}"},{"label":"Creates a new entitlement type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlement-types/createentitlementtype","routeSlug":"/apis/commerce/commerce-v1/entitlement-types/createentitlementtype","metadata":{"seo":{"title":"Creates a new entitlement type record that does not already exist.","description":"This method will auto-generate an ID and create a new entitlement type. If an ID is specified for the entitlement type, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEntitlementType","name":"Creates a new entitlement type record that does not already exist.","isWebhook":false,"pointer":"/paths/~1entitlementTypes~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new entitlement type record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new entitlement type. If an ID is specified for the entitlement type, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1entitlementTypes~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EntitlementType"}},"schemaId":"components/schemas/EntitlementType","pointer":"/paths/~1entitlementTypes~1{tenantId}/post/requestBody","description":"The entitlement type that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/entitlementTypes/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EntitlementType"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/entitlementTypes/{tenantId}","href":"entitlement-types/createentitlementtype","openApiOperationId":"createEntitlementType","summary":"Creates a new entitlement type record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/EntitlementType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EntitlementType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The entitlement type was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntitlementType"}},"schemaId":"components/schemas/EntitlementType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The entitlement type you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The entitlement type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add entitlement type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1entitlementTypes~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntitlementType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntitlementType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlement-types/createentitlementtype"}],"panels":[]}]},"httpPath":"/entitlementTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlement-types/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/entitlement-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1entitlementTypes~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1entitlementTypes~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1entitlementTypes~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/entitlementTypes/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/entitlementTypes/{tenantId}/batch","href":"entitlement-types/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The entitlement type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve entitlement type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1entitlementTypes~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlement-types/executebatchoperations"}],"panels":[]}]},"httpPath":"/entitlementTypes/{tenantId}/batch"},{"label":"Returns a entitlement type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlement-types/deleteentitlementtype","routeSlug":"/apis/commerce/commerce-v1/entitlement-types/deleteentitlementtype","metadata":{"seo":{"title":"Returns a entitlement type from the system by its ID.","description":"This method will delete a entitlement type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEntitlementType","name":"Returns a entitlement type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1entitlementTypes~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a entitlement type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a entitlement type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the entitlement type to delete.","required":true}],"pointer":"/paths/~1entitlementTypes~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/entitlementTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/entitlementTypes/{tenantId}/{id}","href":"entitlement-types/deleteentitlementtype","openApiOperationId":"deleteEntitlementType","summary":"Returns a entitlement type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The entitlement type was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The entitlement type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The entitlement type could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete entitlement type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1entitlementTypes~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlement-types/deleteentitlementtype"}],"panels":[]}]},"httpPath":"/entitlementTypes/{tenantId}/{id}"},{"label":"Returns a entitlement type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlement-types/getentitlementtype","routeSlug":"/apis/commerce/commerce-v1/entitlement-types/getentitlementtype","metadata":{"seo":{"title":"Returns a entitlement type from the system by its ID.","description":"This method will look up a entitlement type by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEntitlementType","name":"Returns a entitlement type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1entitlementTypes~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a entitlement type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a entitlement type by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the entitlement type to return.","required":true}],"pointer":"/paths/~1entitlementTypes~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1entitlementTypes~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/entitlementTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/entitlementTypes/{tenantId}/{id}","href":"entitlement-types/getentitlementtype","openApiOperationId":"getEntitlementType","summary":"Returns a entitlement type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The entitlement type was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntitlementType"}},"schemaId":"components/schemas/EntitlementType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The entitlement type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve entitlement type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1entitlementTypes~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntitlementType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntitlementType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlement-types/getentitlementtype"}],"panels":[]}]},"httpPath":"/entitlementTypes/{tenantId}/{id}"},{"label":"Partially updates a entitlement type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlement-types/patchentitlementtype","routeSlug":"/apis/commerce/commerce-v1/entitlement-types/patchentitlementtype","metadata":{"seo":{"title":"Partially updates a entitlement type with the specified ID.","description":"This method will patch an existing entitlement type with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchEntitlementType","name":"Partially updates a entitlement type with the specified ID.","isWebhook":false,"pointer":"/paths/~1entitlementTypes~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a entitlement type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing entitlement type with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the entitlement type to patch.","required":true}],"pointer":"/paths/~1entitlementTypes~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1entitlementTypes~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/entitlementTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/entitlementTypes/{tenantId}/{id}","href":"entitlement-types/patchentitlementtype","openApiOperationId":"patchEntitlementType","summary":"Partially updates a entitlement type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The entitlement type was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntitlementType"}},"schemaId":"components/schemas/EntitlementType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The entitlement type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The entitlement type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve entitlement type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1entitlementTypes~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntitlementType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntitlementType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlement-types/patchentitlementtype"}],"panels":[]}]},"httpPath":"/entitlementTypes/{tenantId}/{id}"},{"label":"Updates a entitlement type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlement-types/updateentitlementtype","routeSlug":"/apis/commerce/commerce-v1/entitlement-types/updateentitlementtype","metadata":{"seo":{"title":"Updates a entitlement type with the specified ID.","description":"This method will update an existing entitlement type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEntitlementType","name":"Updates a entitlement type with the specified ID.","isWebhook":false,"pointer":"/paths/~1entitlementTypes~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a entitlement type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing entitlement type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the entitlement type to update.","required":true}],"pointer":"/paths/~1entitlementTypes~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EntitlementType"}},"schemaId":"components/schemas/EntitlementType","pointer":"/paths/~1entitlementTypes~1{tenantId}~1{id}/put/requestBody","description":"The updated entitlement type that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/entitlementTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EntitlementType"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/entitlementTypes/{tenantId}/{id}","href":"entitlement-types/updateentitlementtype","openApiOperationId":"updateEntitlementType","summary":"Updates a entitlement type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/EntitlementType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EntitlementType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The entitlement type was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntitlementType"}},"schemaId":"components/schemas/EntitlementType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The entitlement type supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The entitlement type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The entitlement type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve entitlement type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1entitlementTypes~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntitlementType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntitlementType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlement-types/updateentitlementtype"}],"panels":[]}]},"httpPath":"/entitlementTypes/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Entitlement Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Entitlement Types","showPageActions":true},{"nodeType":"markdoc","content":"Entitlement Types"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/entitlementTypes/{tenantId}","summary":"Gets all of the entitlement types in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/entitlement-types/listentitlementtypes","deprecated":false},{"title":"/entitlementTypes/{tenantId}","summary":"Creates a new entitlement type record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/entitlement-types/createentitlementtype","deprecated":false},{"title":"/entitlementTypes/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/entitlement-types/executebatchoperations","deprecated":false},{"title":"/entitlementTypes/{tenantId}/{id}","summary":"Returns a entitlement type from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/entitlement-types/deleteentitlementtype","deprecated":false},{"title":"/entitlementTypes/{tenantId}/{id}","summary":"Returns a entitlement type from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/entitlement-types/getentitlementtype","deprecated":false},{"title":"/entitlementTypes/{tenantId}/{id}","summary":"Partially updates a entitlement type with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/entitlement-types/patchentitlementtype","deprecated":false},{"title":"/entitlementTypes/{tenantId}/{id}","summary":"Updates a entitlement type with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/entitlement-types/updateentitlementtype","deprecated":false}]}]}]}]}},{"type":"group","label":"Entitlements","link":"/apis/commerce/commerce-v1/entitlements","routeSlug":"/apis/commerce/commerce-v1/entitlements","items":[{"label":"Creates a new entitlement record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/createentitlement","routeSlug":"/apis/commerce/commerce-v1/entitlements/createentitlement","metadata":{"seo":{"title":"Creates a new entitlement record that does not already exist.","description":"This method will auto-generate an ID and create a new entitlement. If an ID is specified for the entitlement, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEntitlement","name":"Creates a new entitlement record that does not already exist.","isWebhook":false,"pointer":"/paths/~1entitlements~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new entitlement record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new entitlement. If an ID is specified for the entitlement, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1entitlements~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Entitlement"}},"schemaId":"components/schemas/Entitlement","pointer":"/paths/~1entitlements~1{tenantId}/post/requestBody","description":"The entitlement that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/entitlements/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Entitlement"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/entitlements/{tenantId}","href":"entitlements/createentitlement","openApiOperationId":"createEntitlement","summary":"Creates a new entitlement record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Entitlement","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Entitlement"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The entitlement was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Entitlement"}},"schemaId":"components/schemas/Entitlement","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The entitlement you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The entitlement could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add entitlement based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1entitlements~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Entitlement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Entitlement"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlements/createentitlement"}],"panels":[]}]},"httpPath":"/entitlements/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/entitlements/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1entitlements~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1entitlements~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1entitlements~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/entitlements/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/entitlements/{tenantId}/batch","href":"entitlements/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The entitlement could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve entitlement based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1entitlements~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlements/executebatchoperations"}],"panels":[]}]},"httpPath":"/entitlements/{tenantId}/batch"},{"label":"Check that a contact/organization has an entitlement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/checkentitlement","routeSlug":"/apis/commerce/commerce-v1/entitlements/checkentitlement","metadata":{"seo":{"title":"Check that a contact/organization has an entitlement","description":"Returns a list of records with the specified owner_entitlement_type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"checkEntitlement","name":"Check that a contact/organization has an entitlement","isWebhook":false,"pointer":"/paths/~1entitlements~1{tenantId}~1checkEntitlement~1{owner_type}~1{owner_id}~1{type_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check that a contact/organization has an entitlement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified owner_entitlement_type"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"owner_type","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The owner_entitlement_type to use to for record lookup"},"children":[]}]}]}],"required":true},{"name":"owner_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The owner_entitlement_type to use to for record lookup"},"children":[]}]}]}],"required":true},{"name":"type_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The owner_entitlement_type to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1entitlements~1{tenantId}~1checkEntitlement~1{owner_type}~1{owner_id}~1{type_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"quantity","in":"query","schemaId":"schema_459","description":"The quantity to check"}],"pointer":"/paths/~1entitlements~1{tenantId}~1checkEntitlement~1{owner_type}~1{owner_id}~1{type_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/entitlements/{tenantId}/checkEntitlement/{owner_type}/{owner_id}/{type_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"owner_type","in":"path","required":true,"schemaId":"schema_459"},{"name":"owner_id","in":"path","required":true,"schemaId":"schema_459"},{"name":"type_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"quantity","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/entitlements/{tenantId}/checkEntitlement/{owner_type}/{owner_id}/{type_id}","href":"entitlements/checkentitlement","openApiOperationId":"checkEntitlement","summary":"Check that a contact/organization has an entitlement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1entitlements~1{tenantId}~1checkEntitlement~1{owner_type}~1{owner_id}~1{type_id}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlements/checkentitlement"}],"panels":[]}]},"httpPath":"/entitlements/{tenantId}/checkEntitlement/{owner_type}/{owner_id}/{type_id}"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/listentitlementsbycontactid","routeSlug":"/apis/commerce/commerce-v1/entitlements/listentitlementsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEntitlementsByContactId","name":"Returns a list of records with the specified contact_id","isWebhook":false,"pointer":"/paths/~1entitlements~1{tenantId}~1contact~1{contact_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified contact_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified contact_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"contact_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1entitlements~1{tenantId}~1contact~1{contact_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1entitlements~1{tenantId}~1contact~1{contact_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/entitlements/{tenantId}/contact/{contact_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"contact_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/entitlements/{tenantId}/contact/{contact_id}","href":"entitlements/listentitlementsbycontactid","openApiOperationId":"listEntitlementsByContactId","summary":"Returns a list of records with the specified contact_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEntitlementsResponse"}},"schemaId":"components/schemas/ListEntitlementsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1entitlements~1{tenantId}~1contact~1{contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListEntitlementsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEntitlementsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlements/listentitlementsbycontactid"}],"panels":[]}]},"httpPath":"/entitlements/{tenantId}/contact/{contact_id}"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/listentitlementsbyorderid","routeSlug":"/apis/commerce/commerce-v1/entitlements/listentitlementsbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEntitlementsByOrderId","name":"Returns a list of records with the specified order_id","isWebhook":false,"pointer":"/paths/~1entitlements~1{tenantId}~1order~1{order_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified order_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified order_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"order_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1entitlements~1{tenantId}~1order~1{order_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1entitlements~1{tenantId}~1order~1{order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/entitlements/{tenantId}/order/{order_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/entitlements/{tenantId}/order/{order_id}","href":"entitlements/listentitlementsbyorderid","openApiOperationId":"listEntitlementsByOrderId","summary":"Returns a list of records with the specified order_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEntitlementsResponse"}},"schemaId":"components/schemas/ListEntitlementsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1entitlements~1{tenantId}~1order~1{order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListEntitlementsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEntitlementsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlements/listentitlementsbyorderid"}],"panels":[]}]},"httpPath":"/entitlements/{tenantId}/order/{order_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/listentitlementsbyorganizationid","routeSlug":"/apis/commerce/commerce-v1/entitlements/listentitlementsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEntitlementsByOrganizationId","name":"Returns a list of records with the specified organization_id","isWebhook":false,"pointer":"/paths/~1entitlements~1{tenantId}~1organization~1{organization_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified organization_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified organization_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"organization_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1entitlements~1{tenantId}~1organization~1{organization_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1entitlements~1{tenantId}~1organization~1{organization_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/entitlements/{tenantId}/organization/{organization_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"organization_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/entitlements/{tenantId}/organization/{organization_id}","href":"entitlements/listentitlementsbyorganizationid","openApiOperationId":"listEntitlementsByOrganizationId","summary":"Returns a list of records with the specified organization_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEntitlementsResponse"}},"schemaId":"components/schemas/ListEntitlementsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1entitlements~1{tenantId}~1organization~1{organization_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListEntitlementsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEntitlementsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlements/listentitlementsbyorganizationid"}],"panels":[]}]},"httpPath":"/entitlements/{tenantId}/organization/{organization_id}"},{"label":"Returns a list of records with the specified owner_entitlement_type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/listentitlementsbyownerentitlementtype","routeSlug":"/apis/commerce/commerce-v1/entitlements/listentitlementsbyownerentitlementtype","metadata":{"seo":{"title":"Returns a list of records with the specified owner_entitlement_type","description":"Returns a list of records with the specified owner_entitlement_type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEntitlementsByOwnerEntitlementType","name":"Returns a list of records with the specified owner_entitlement_type","isWebhook":false,"pointer":"/paths/~1entitlements~1{tenantId}~1ownerEntitlementType~1{owner_type}~1{owner_id}~1{type_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified owner_entitlement_type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified owner_entitlement_type"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"owner_type","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The owner_entitlement_type to use to for record lookup"},"children":[]}]}]}],"required":true},{"name":"owner_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The owner_entitlement_type to use to for record lookup"},"children":[]}]}]}],"required":true},{"name":"type_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The owner_entitlement_type to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1entitlements~1{tenantId}~1ownerEntitlementType~1{owner_type}~1{owner_id}~1{type_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1entitlements~1{tenantId}~1ownerEntitlementType~1{owner_type}~1{owner_id}~1{type_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/entitlements/{tenantId}/ownerEntitlementType/{owner_type}/{owner_id}/{type_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"owner_type","in":"path","required":true,"schemaId":"schema_459"},{"name":"owner_id","in":"path","required":true,"schemaId":"schema_459"},{"name":"type_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/entitlements/{tenantId}/ownerEntitlementType/{owner_type}/{owner_id}/{type_id}","href":"entitlements/listentitlementsbyownerentitlementtype","openApiOperationId":"listEntitlementsByOwnerEntitlementType","summary":"Returns a list of records with the specified owner_entitlement_type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEntitlementsResponse"}},"schemaId":"components/schemas/ListEntitlementsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1entitlements~1{tenantId}~1ownerEntitlementType~1{owner_type}~1{owner_id}~1{type_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListEntitlementsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEntitlementsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlements/listentitlementsbyownerentitlementtype"}],"panels":[]}]},"httpPath":"/entitlements/{tenantId}/ownerEntitlementType/{owner_type}/{owner_id}/{type_id}"},{"label":"Returns a entitlement from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/deleteentitlement","routeSlug":"/apis/commerce/commerce-v1/entitlements/deleteentitlement","metadata":{"seo":{"title":"Returns a entitlement from the system by its ID.","description":"This method will delete a entitlement with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEntitlement","name":"Returns a entitlement from the system by its ID.","isWebhook":false,"pointer":"/paths/~1entitlements~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a entitlement from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a entitlement with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the entitlement to delete.","required":true}],"pointer":"/paths/~1entitlements~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/entitlements/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/entitlements/{tenantId}/{id}","href":"entitlements/deleteentitlement","openApiOperationId":"deleteEntitlement","summary":"Returns a entitlement from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The entitlement was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The entitlement could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The entitlement could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete entitlement based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1entitlements~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlements/deleteentitlement"}],"panels":[]}]},"httpPath":"/entitlements/{tenantId}/{id}"},{"label":"Returns a entitlement from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/getentitlement","routeSlug":"/apis/commerce/commerce-v1/entitlements/getentitlement","metadata":{"seo":{"title":"Returns a entitlement from the system by its ID.","description":"This method will look up a entitlement by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEntitlement","name":"Returns a entitlement from the system by its ID.","isWebhook":false,"pointer":"/paths/~1entitlements~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a entitlement from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a entitlement by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the entitlement to return.","required":true}],"pointer":"/paths/~1entitlements~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1entitlements~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/entitlements/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/entitlements/{tenantId}/{id}","href":"entitlements/getentitlement","openApiOperationId":"getEntitlement","summary":"Returns a entitlement from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The entitlement was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Entitlement"}},"schemaId":"components/schemas/Entitlement","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The entitlement could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve entitlement based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1entitlements~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Entitlement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Entitlement"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlements/getentitlement"}],"panels":[]}]},"httpPath":"/entitlements/{tenantId}/{id}"},{"label":"Partially updates a entitlement with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/patchentitlement","routeSlug":"/apis/commerce/commerce-v1/entitlements/patchentitlement","metadata":{"seo":{"title":"Partially updates a entitlement with the specified ID.","description":"This method will patch an existing entitlement with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchEntitlement","name":"Partially updates a entitlement with the specified ID.","isWebhook":false,"pointer":"/paths/~1entitlements~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a entitlement with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing entitlement with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the entitlement to patch.","required":true}],"pointer":"/paths/~1entitlements~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1entitlements~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/entitlements/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/entitlements/{tenantId}/{id}","href":"entitlements/patchentitlement","openApiOperationId":"patchEntitlement","summary":"Partially updates a entitlement with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The entitlement was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Entitlement"}},"schemaId":"components/schemas/Entitlement","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The entitlement could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The entitlement could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve entitlement based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1entitlements~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Entitlement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Entitlement"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlements/patchentitlement"}],"panels":[]}]},"httpPath":"/entitlements/{tenantId}/{id}"},{"label":"Updates a entitlement with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/updateentitlement","routeSlug":"/apis/commerce/commerce-v1/entitlements/updateentitlement","metadata":{"seo":{"title":"Updates a entitlement with the specified ID.","description":"This method will update an existing entitlement with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEntitlement","name":"Updates a entitlement with the specified ID.","isWebhook":false,"pointer":"/paths/~1entitlements~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a entitlement with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing entitlement with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the entitlement to update.","required":true}],"pointer":"/paths/~1entitlements~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Entitlement"}},"schemaId":"components/schemas/Entitlement","pointer":"/paths/~1entitlements~1{tenantId}~1{id}/put/requestBody","description":"The updated entitlement that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/entitlements/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Entitlement"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/entitlements/{tenantId}/{id}","href":"entitlements/updateentitlement","openApiOperationId":"updateEntitlement","summary":"Updates a entitlement with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Entitlement","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Entitlement"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The entitlement was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Entitlement"}},"schemaId":"components/schemas/Entitlement","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The entitlement supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The entitlement could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The entitlement could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve entitlement based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1entitlements~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Entitlement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Entitlement"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/entitlements/updateentitlement"}],"panels":[]}]},"httpPath":"/entitlements/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Entitlements"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Entitlements","showPageActions":true},{"nodeType":"markdoc","content":"Entitlements"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/entitlements/{tenantId}","summary":"Creates a new entitlement record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/entitlements/createentitlement","deprecated":false},{"title":"/entitlements/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/entitlements/executebatchoperations","deprecated":false},{"title":"/entitlements/{tenantId}/checkEntitlement/{owner_type}/{owner_id}/{type_id}","summary":"Check that a contact/organization has an entitlement","prefix":{"name":"get","color":"get"},"badges":[],"link":"/entitlements/checkentitlement","deprecated":false},{"title":"/entitlements/{tenantId}/contact/{contact_id}","summary":"Returns a list of records with the specified contact_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/entitlements/listentitlementsbycontactid","deprecated":false},{"title":"/entitlements/{tenantId}/order/{order_id}","summary":"Returns a list of records with the specified order_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/entitlements/listentitlementsbyorderid","deprecated":false},{"title":"/entitlements/{tenantId}/organization/{organization_id}","summary":"Returns a list of records with the specified organization_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/entitlements/listentitlementsbyorganizationid","deprecated":false},{"title":"/entitlements/{tenantId}/ownerEntitlementType/{owner_type}/{owner_id}/{type_id}","summary":"Returns a list of records with the specified owner_entitlement_type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/entitlements/listentitlementsbyownerentitlementtype","deprecated":false},{"title":"/entitlements/{tenantId}/{id}","summary":"Returns a entitlement from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/entitlements/deleteentitlement","deprecated":false},{"title":"/entitlements/{tenantId}/{id}","summary":"Returns a entitlement from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/entitlements/getentitlement","deprecated":false},{"title":"/entitlements/{tenantId}/{id}","summary":"Partially updates a entitlement with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/entitlements/patchentitlement","deprecated":false},{"title":"/entitlements/{tenantId}/{id}","summary":"Updates a entitlement with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/entitlements/updateentitlement","deprecated":false}]}]}]}]}},{"type":"group","label":"Inventory Transactions","link":"/apis/commerce/commerce-v1/inventory-transactions","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions","items":[{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/inventory-transactions/warmupinventorytransactions","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions/warmupinventorytransactions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"warmUpInventoryTransactions","name":"Initiates workflow to warm up inventory transactions","isWebhook":false,"pointer":"/paths/~1inventoryTransactions~1warmUpStepFunctions/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates workflow to warm up inventory transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventoryTransactions/warmUpStepFunctions","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/inventoryTransactions/warmUpStepFunctions","href":"inventory-transactions/warmupinventorytransactions","openApiOperationId":"warmUpInventoryTransactions","summary":"Initiates workflow to warm up inventory transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Request limit exceeded... please try your request again in a few seconds","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1inventoryTransactions~1warmUpStepFunctions/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-transactions/warmupinventorytransactions"}],"panels":[]}]},"httpPath":"/inventoryTransactions/warmUpStepFunctions"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/inventory-transactions/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1inventoryTransactions~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventoryTransactions/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/inventoryTransactions/{tenantId}/batch","href":"inventory-transactions/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The inventory transaction could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve inventory transaction based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-transactions/executebatchoperations"}],"panels":[]}]},"httpPath":"/inventoryTransactions/{tenantId}/batch"},{"label":"Returns a list of records with the specified open_purchase_order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/inventory-transactions/listopenpurchaseordersforproduct","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions/listopenpurchaseordersforproduct","metadata":{"seo":{"title":"Returns a list of records with the specified open_purchase_order_id","description":"Returns a list of records with the specified open_purchase_order_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOpenPurchaseOrdersForProduct","name":"Returns a list of records with the specified open_purchase_order_id","isWebhook":false,"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1openPurchaseOrders~1{product_type}~1{product_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified open_purchase_order_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified open_purchase_order_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"product_type","in":"path","schemaId":"schema_459","description":"Produc type","required":true},{"name":"product_id","in":"path","schemaId":"schema_459","description":"Product ID","required":true}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1openPurchaseOrders~1{product_type}~1{product_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1openPurchaseOrders~1{product_type}~1{product_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inventoryTransactions/{tenantId}/openPurchaseOrders/{product_type}/{product_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"product_type","in":"path","required":true,"schemaId":"schema_459"},{"name":"product_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/inventoryTransactions/{tenantId}/openPurchaseOrders/{product_type}/{product_id}","href":"inventory-transactions/listopenpurchaseordersforproduct","openApiOperationId":"listOpenPurchaseOrdersForProduct","summary":"Returns a list of records with the specified open_purchase_order_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInventoryTransactionsResponse"}},"schemaId":"components/schemas/ListInventoryTransactionsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1openPurchaseOrders~1{product_type}~1{product_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListInventoryTransactionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInventoryTransactionsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-transactions/listopenpurchaseordersforproduct"}],"panels":[]}]},"httpPath":"/inventoryTransactions/{tenantId}/openPurchaseOrders/{product_type}/{product_id}"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/inventory-transactions/listtransactionsbyorderid","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions/listtransactionsbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTransactionsByOrderId","name":"Returns a list of records with the specified order_id","isWebhook":false,"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1order~1{order_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified order_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified order_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"order_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1order~1{order_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1order~1{order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inventoryTransactions/{tenantId}/order/{order_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/inventoryTransactions/{tenantId}/order/{order_id}","href":"inventory-transactions/listtransactionsbyorderid","openApiOperationId":"listTransactionsByOrderId","summary":"Returns a list of records with the specified order_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInventoryTransactionsResponse"}},"schemaId":"components/schemas/ListInventoryTransactionsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1order~1{order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListInventoryTransactionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInventoryTransactionsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-transactions/listtransactionsbyorderid"}],"panels":[]}]},"httpPath":"/inventoryTransactions/{tenantId}/order/{order_id}"},{"label":"Initiates workflow to process an inventory transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/inventory-transactions/processinventorytransaction","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions/processinventorytransaction","metadata":{"seo":{"title":"Initiates workflow to process an inventory transaction","description":"This method will auto-generate an ID and create a new inventory transaction. If an ID is specified for the inventory transaction, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processInventoryTransaction","name":"Initiates workflow to process an inventory transaction","isWebhook":false,"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1process/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates workflow to process an inventory transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new inventory transaction. If an ID is specified for the inventory transaction, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1process/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InventoryTransaction"}},"schemaId":"components/schemas/InventoryTransaction","pointer":"/paths/~1inventoryTransactions~1{tenantId}~1process/post/requestBody","description":"The inventory transaction that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventoryTransactions/{tenantId}/process","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InventoryTransaction"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/inventoryTransactions/{tenantId}/process","href":"inventory-transactions/processinventorytransaction","openApiOperationId":"processInventoryTransaction","summary":"Initiates workflow to process an inventory transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/InventoryTransaction","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InventoryTransaction"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The inventory transaction was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The inventory transaction you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The inventory transaction could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add inventory transaction based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1process/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-transactions/processinventorytransaction"}],"panels":[]}]},"httpPath":"/inventoryTransactions/{tenantId}/process"},{"label":"Initiates workflow to process an inventory transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/inventory-transactions/processinventorytransactionsync","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions/processinventorytransactionsync","metadata":{"seo":{"title":"Initiates workflow to process an inventory transaction","description":"This method will auto-generate an ID and create a new inventory transaction. If an ID is specified for the inventory transaction, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processInventoryTransactionSync","name":"Initiates workflow to process an inventory transaction","isWebhook":false,"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1process~1sync/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates workflow to process an inventory transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new inventory transaction. If an ID is specified for the inventory transaction, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1process~1sync/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InventoryTransaction"}},"schemaId":"components/schemas/InventoryTransaction","pointer":"/paths/~1inventoryTransactions~1{tenantId}~1process~1sync/post/requestBody","description":"The inventory transaction that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventoryTransactions/{tenantId}/process/sync","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InventoryTransaction"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/inventoryTransactions/{tenantId}/process/sync","href":"inventory-transactions/processinventorytransactionsync","openApiOperationId":"processInventoryTransactionSync","summary":"Initiates workflow to process an inventory transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/InventoryTransaction","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InventoryTransaction"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The inventory transaction was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryTransaction"}},"schemaId":"components/schemas/InventoryTransaction","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The inventory transaction you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The inventory transaction could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add inventory transaction based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1process~1sync/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InventoryTransaction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryTransaction"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-transactions/processinventorytransactionsync"}],"panels":[]}]},"httpPath":"/inventoryTransactions/{tenantId}/process/sync"},{"label":"Returns a list of records with the specified product_inventory_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/inventory-transactions/listtransactionsbyproductinventoryid","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions/listtransactionsbyproductinventoryid","metadata":{"seo":{"title":"Returns a list of records with the specified product_inventory_id","description":"Returns a list of records with the specified product_inventory_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTransactionsByProductInventoryId","name":"Returns a list of records with the specified product_inventory_id","isWebhook":false,"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1productInventory~1{product_inventory_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified product_inventory_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified product_inventory_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"product_inventory_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The product_inventory_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1productInventory~1{product_inventory_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1productInventory~1{product_inventory_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inventoryTransactions/{tenantId}/productInventory/{product_inventory_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"product_inventory_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/inventoryTransactions/{tenantId}/productInventory/{product_inventory_id}","href":"inventory-transactions/listtransactionsbyproductinventoryid","openApiOperationId":"listTransactionsByProductInventoryId","summary":"Returns a list of records with the specified product_inventory_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInventoryTransactionsResponse"}},"schemaId":"components/schemas/ListInventoryTransactionsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1productInventory~1{product_inventory_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListInventoryTransactionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInventoryTransactionsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-transactions/listtransactionsbyproductinventoryid"}],"panels":[]}]},"httpPath":"/inventoryTransactions/{tenantId}/productInventory/{product_inventory_id}"},{"label":"Returns a inventory transaction from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/inventory-transactions/getinventorytransaction","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions/getinventorytransaction","metadata":{"seo":{"title":"Returns a inventory transaction from the system by its ID.","description":"This method will look up a inventory transaction by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInventoryTransaction","name":"Returns a inventory transaction from the system by its ID.","isWebhook":false,"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a inventory transaction from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a inventory transaction by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the inventory transaction to return.","required":true}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inventoryTransactions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/inventoryTransactions/{tenantId}/{id}","href":"inventory-transactions/getinventorytransaction","openApiOperationId":"getInventoryTransaction","summary":"Returns a inventory transaction from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The inventory transaction was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryTransaction"}},"schemaId":"components/schemas/InventoryTransaction","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The inventory transaction could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve inventory transaction based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InventoryTransaction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryTransaction"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-transactions/getinventorytransaction"}],"panels":[]}]},"httpPath":"/inventoryTransactions/{tenantId}/{id}"},{"label":"Partially updates a inventory transaction with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/inventory-transactions/patchinventorytransaction","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions/patchinventorytransaction","metadata":{"seo":{"title":"Partially updates a inventory transaction with the specified ID.","description":"This method will patch an existing inventory transaction with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchInventoryTransaction","name":"Partially updates a inventory transaction with the specified ID.","isWebhook":false,"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a inventory transaction with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing inventory transaction with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the inventory transaction to patch.","required":true}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1inventoryTransactions~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/inventoryTransactions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/inventoryTransactions/{tenantId}/{id}","href":"inventory-transactions/patchinventorytransaction","openApiOperationId":"patchInventoryTransaction","summary":"Partially updates a inventory transaction with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The inventory transaction was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryTransaction"}},"schemaId":"components/schemas/InventoryTransaction","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The inventory transaction could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The inventory transaction could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve inventory transaction based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InventoryTransaction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryTransaction"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-transactions/patchinventorytransaction"}],"panels":[]}]},"httpPath":"/inventoryTransactions/{tenantId}/{id}"},{"label":"Updates a inventory transaction with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/inventory-transactions/updateinventorytransaction","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions/updateinventorytransaction","metadata":{"seo":{"title":"Updates a inventory transaction with the specified ID.","description":"This method will update an existing inventory transaction with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateInventoryTransaction","name":"Updates a inventory transaction with the specified ID.","isWebhook":false,"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a inventory transaction with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing inventory transaction with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the inventory transaction to update.","required":true}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InventoryTransaction"}},"schemaId":"components/schemas/InventoryTransaction","pointer":"/paths/~1inventoryTransactions~1{tenantId}~1{id}/put/requestBody","description":"The updated inventory transaction that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/inventoryTransactions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InventoryTransaction"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/inventoryTransactions/{tenantId}/{id}","href":"inventory-transactions/updateinventorytransaction","openApiOperationId":"updateInventoryTransaction","summary":"Updates a inventory transaction with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/InventoryTransaction","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InventoryTransaction"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The inventory transaction was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryTransaction"}},"schemaId":"components/schemas/InventoryTransaction","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The inventory transaction supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The inventory transaction could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The inventory transaction could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve inventory transaction based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1inventoryTransactions~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InventoryTransaction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryTransaction"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory-transactions/updateinventorytransaction"}],"panels":[]}]},"httpPath":"/inventoryTransactions/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Inventory Transactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Inventory Transactions","showPageActions":true},{"nodeType":"markdoc","content":"Inventory Transactions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/inventoryTransactions/warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/inventory-transactions/warmupinventorytransactions","deprecated":false},{"title":"/inventoryTransactions/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/inventory-transactions/executebatchoperations","deprecated":false},{"title":"/inventoryTransactions/{tenantId}/openPurchaseOrders/{product_type}/{product_id}","summary":"Returns a list of records with the specified open_purchase_order_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory-transactions/listopenpurchaseordersforproduct","deprecated":false},{"title":"/inventoryTransactions/{tenantId}/order/{order_id}","summary":"Returns a list of records with the specified order_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory-transactions/listtransactionsbyorderid","deprecated":false},{"title":"/inventoryTransactions/{tenantId}/process","summary":"Initiates workflow to process an inventory transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/inventory-transactions/processinventorytransaction","deprecated":false},{"title":"/inventoryTransactions/{tenantId}/process/sync","summary":"Initiates workflow to process an inventory transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/inventory-transactions/processinventorytransactionsync","deprecated":false},{"title":"/inventoryTransactions/{tenantId}/productInventory/{product_inventory_id}","summary":"Returns a list of records with the specified product_inventory_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory-transactions/listtransactionsbyproductinventoryid","deprecated":false},{"title":"/inventoryTransactions/{tenantId}/{id}","summary":"Returns a inventory transaction from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory-transactions/getinventorytransaction","deprecated":false},{"title":"/inventoryTransactions/{tenantId}/{id}","summary":"Partially updates a inventory transaction with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/inventory-transactions/patchinventorytransaction","deprecated":false},{"title":"/inventoryTransactions/{tenantId}/{id}","summary":"Updates a inventory transaction with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/inventory-transactions/updateinventorytransaction","deprecated":false}]}]}]}]}},{"type":"group","label":"Merchandise","link":"/apis/commerce/commerce-v1/merchandise","routeSlug":"/apis/commerce/commerce-v1/merchandise","items":[{"label":"Gets all of the merchandise in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/listmerchandise","routeSlug":"/apis/commerce/commerce-v1/merchandise/listmerchandise","metadata":{"seo":{"title":"Gets all of the merchandise in the system.","description":"This method will scan all merchandise and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMerchandise","name":"Gets all of the merchandise in the system.","isWebhook":false,"pointer":"/paths/~1merchandise~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the merchandise in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all merchandise and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1merchandise~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1merchandise~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/merchandise/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/merchandise/{tenantId}","href":"merchandise/listmerchandise","openApiOperationId":"listMerchandise","summary":"Gets all of the merchandise in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The merchandisewere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_467"}},"schemaId":"schema_467","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1merchandise~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_467","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_467"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchandise/listmerchandise"}],"panels":[]}]},"httpPath":"/merchandise/{tenantId}"},{"label":"Creates a new merchandise record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/createmerchandise","routeSlug":"/apis/commerce/commerce-v1/merchandise/createmerchandise","metadata":{"seo":{"title":"Creates a new merchandise record that does not already exist.","description":"This method will auto-generate an ID and create a new merchandise. If an ID is specified for the merchandise, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createMerchandise","name":"Creates a new merchandise record that does not already exist.","isWebhook":false,"pointer":"/paths/~1merchandise~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new merchandise record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new merchandise. If an ID is specified for the merchandise, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1merchandise~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Merchandise"}},"schemaId":"components/schemas/Merchandise","pointer":"/paths/~1merchandise~1{tenantId}/post/requestBody","description":"The merchandise that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/merchandise/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Merchandise"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/merchandise/{tenantId}","href":"merchandise/createmerchandise","openApiOperationId":"createMerchandise","summary":"Creates a new merchandise record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Merchandise","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Merchandise"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The merchandise was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Merchandise"}},"schemaId":"components/schemas/Merchandise","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The merchandise you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The merchandise could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add merchandise based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1merchandise~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Merchandise","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Merchandise"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchandise/createmerchandise"}],"panels":[]}]},"httpPath":"/merchandise/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/merchandise/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1merchandise~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1merchandise~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1merchandise~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/merchandise/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/merchandise/{tenantId}/batch","href":"merchandise/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The merchandise could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve merchandise based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1merchandise~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchandise/executebatchoperations"}],"panels":[]}]},"httpPath":"/merchandise/{tenantId}/batch"},{"label":"Returns a list of records with the specified category_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/listmerchandisebycategoryid","routeSlug":"/apis/commerce/commerce-v1/merchandise/listmerchandisebycategoryid","metadata":{"seo":{"title":"Returns a list of records with the specified category_id","description":"Returns a list of records with the specified category_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMerchandiseByCategoryId","name":"Returns a list of records with the specified category_id","isWebhook":false,"pointer":"/paths/~1merchandise~1{tenantId}~1category~1{category_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified category_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified category_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"category_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The category_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1merchandise~1{tenantId}~1category~1{category_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1merchandise~1{tenantId}~1category~1{category_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/merchandise/{tenantId}/category/{category_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"category_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/merchandise/{tenantId}/category/{category_id}","href":"merchandise/listmerchandisebycategoryid","openApiOperationId":"listMerchandiseByCategoryId","summary":"Returns a list of records with the specified category_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_467"}},"schemaId":"schema_467","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1merchandise~1{tenantId}~1category~1{category_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_467","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_467"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchandise/listmerchandisebycategoryid"}],"panels":[]}]},"httpPath":"/merchandise/{tenantId}/category/{category_id}"},{"label":"Lists all merchandise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/listallpublicmerchandise","routeSlug":"/apis/commerce/commerce-v1/merchandise/listallpublicmerchandise","metadata":{"seo":{"title":"Lists all merchandise","description":"Lists all merchandise"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAllPublicMerchandise","name":"Lists all merchandise","isWebhook":false,"pointer":"/paths/~1merchandise~1{tenantId}~1public/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists all merchandise","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all merchandise"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true}],"pointer":"/paths/~1merchandise~1{tenantId}~1public/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key, if you're making a subsequent request"},{"name":"categoryIds","in":"query","schemaId":"schema_459","description":"The category IDs to filter"}],"pointer":"/paths/~1merchandise~1{tenantId}~1public/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/merchandise/{tenantId}/public","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"},{"name":"categoryIds","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/merchandise/{tenantId}/public","href":"merchandise/listallpublicmerchandise","openApiOperationId":"listAllPublicMerchandise","summary":"Lists all merchandise"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The merchandise was retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListMerchandisePublicResponse"}},"schemaId":"components/schemas/ListMerchandisePublicResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1merchandise~1{tenantId}~1public/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListMerchandisePublicResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListMerchandisePublicResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchandise/listallpublicmerchandise"}],"panels":[]}]},"httpPath":"/merchandise/{tenantId}/public"},{"label":"Gets merchandise info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/get","routeSlug":"/apis/commerce/commerce-v1/merchandise/get","metadata":{"seo":{"title":"Gets merchandise info","description":"Gets merchandise info"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get","name":"Gets merchandise info","isWebhook":false,"pointer":"/paths/~1merchandise~1{tenantId}~1public~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets merchandise info","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets merchandise info"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The id of the merchandise","required":true}],"pointer":"/paths/~1merchandise~1{tenantId}~1public~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/merchandise/{tenantId}/public/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/merchandise/{tenantId}/public/{id}","href":"merchandise/get","openApiOperationId":"get","summary":"Gets merchandise info"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The merchandise was retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MerchandisePublic"}},"schemaId":"components/schemas/MerchandisePublic","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1merchandise~1{tenantId}~1public~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MerchandisePublic","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MerchandisePublic"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchandise/get"}],"panels":[]}]},"httpPath":"/merchandise/{tenantId}/public/{id}"},{"label":"Searches for merchandise using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/searchformerchandise","routeSlug":"/apis/commerce/commerce-v1/merchandise/searchformerchandise","metadata":{"seo":{"title":"Searches for merchandise using predefined parameters","description":"Searches for merchandise using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForMerchandise","name":"Searches for merchandise using predefined parameters","isWebhook":false,"pointer":"/paths/~1merchandise~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for merchandise using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for merchandise using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1merchandise~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_459","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1merchandise~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MerchandiseSearchParameters"}},"schemaId":"components/schemas/MerchandiseSearchParameters","pointer":"/paths/~1merchandise~1{tenantId}~1search/post/requestBody","description":"The merchandise that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/merchandise/{tenantId}/search","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MerchandiseSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/merchandise/{tenantId}/search","href":"merchandise/searchformerchandise","openApiOperationId":"searchForMerchandise","summary":"Searches for merchandise using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/MerchandiseSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MerchandiseSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The merchandise search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedMerchandiseSearchResults"}},"schemaId":"components/schemas/PagedMerchandiseSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The merchandise you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The merchandise could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add merchandise based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1merchandise~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedMerchandiseSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedMerchandiseSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchandise/searchformerchandise"}],"panels":[]}]},"httpPath":"/merchandise/{tenantId}/search"},{"label":"Returns a merchandise from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/deletemerchandise","routeSlug":"/apis/commerce/commerce-v1/merchandise/deletemerchandise","metadata":{"seo":{"title":"Returns a merchandise from the system by its ID.","description":"This method will delete a merchandise with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteMerchandise","name":"Returns a merchandise from the system by its ID.","isWebhook":false,"pointer":"/paths/~1merchandise~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a merchandise from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a merchandise with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the merchandise to delete.","required":true}],"pointer":"/paths/~1merchandise~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/merchandise/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/merchandise/{tenantId}/{id}","href":"merchandise/deletemerchandise","openApiOperationId":"deleteMerchandise","summary":"Returns a merchandise from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The merchandise was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The merchandise could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The merchandise could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete merchandise based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1merchandise~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchandise/deletemerchandise"}],"panels":[]}]},"httpPath":"/merchandise/{tenantId}/{id}"},{"label":"Returns a merchandise from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/getmerchandise","routeSlug":"/apis/commerce/commerce-v1/merchandise/getmerchandise","metadata":{"seo":{"title":"Returns a merchandise from the system by its ID.","description":"This method will look up a merchandise by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMerchandise","name":"Returns a merchandise from the system by its ID.","isWebhook":false,"pointer":"/paths/~1merchandise~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a merchandise from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a merchandise by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the merchandise to return.","required":true}],"pointer":"/paths/~1merchandise~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1merchandise~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/merchandise/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/merchandise/{tenantId}/{id}","href":"merchandise/getmerchandise","openApiOperationId":"getMerchandise","summary":"Returns a merchandise from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The merchandise was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Merchandise"}},"schemaId":"components/schemas/Merchandise","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The merchandise could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve merchandise based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1merchandise~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Merchandise","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Merchandise"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchandise/getmerchandise"}],"panels":[]}]},"httpPath":"/merchandise/{tenantId}/{id}"},{"label":"Partially updates a merchandise with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/patchmerchandise","routeSlug":"/apis/commerce/commerce-v1/merchandise/patchmerchandise","metadata":{"seo":{"title":"Partially updates a merchandise with the specified ID.","description":"This method will patch an existing merchandise with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchMerchandise","name":"Partially updates a merchandise with the specified ID.","isWebhook":false,"pointer":"/paths/~1merchandise~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a merchandise with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing merchandise with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the merchandise to patch.","required":true}],"pointer":"/paths/~1merchandise~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1merchandise~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/merchandise/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/merchandise/{tenantId}/{id}","href":"merchandise/patchmerchandise","openApiOperationId":"patchMerchandise","summary":"Partially updates a merchandise with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The merchandise was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Merchandise"}},"schemaId":"components/schemas/Merchandise","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The merchandise could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The merchandise could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve merchandise based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1merchandise~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Merchandise","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Merchandise"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchandise/patchmerchandise"}],"panels":[]}]},"httpPath":"/merchandise/{tenantId}/{id}"},{"label":"Updates a merchandise with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/updatemerchandise","routeSlug":"/apis/commerce/commerce-v1/merchandise/updatemerchandise","metadata":{"seo":{"title":"Updates a merchandise with the specified ID.","description":"This method will update an existing merchandise with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateMerchandise","name":"Updates a merchandise with the specified ID.","isWebhook":false,"pointer":"/paths/~1merchandise~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a merchandise with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing merchandise with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the merchandise to update.","required":true}],"pointer":"/paths/~1merchandise~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Merchandise"}},"schemaId":"components/schemas/Merchandise","pointer":"/paths/~1merchandise~1{tenantId}~1{id}/put/requestBody","description":"The updated merchandise that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/merchandise/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Merchandise"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/merchandise/{tenantId}/{id}","href":"merchandise/updatemerchandise","openApiOperationId":"updateMerchandise","summary":"Updates a merchandise with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Merchandise","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Merchandise"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The merchandise was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Merchandise"}},"schemaId":"components/schemas/Merchandise","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The merchandise supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The merchandise could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The merchandise could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve merchandise based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1merchandise~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Merchandise","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Merchandise"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchandise/updatemerchandise"}],"panels":[]}]},"httpPath":"/merchandise/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Merchandise"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merchandise","showPageActions":true},{"nodeType":"markdoc","content":"Merchandise"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/merchandise/{tenantId}","summary":"Gets all of the merchandise in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/merchandise/listmerchandise","deprecated":false},{"title":"/merchandise/{tenantId}","summary":"Creates a new merchandise record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchandise/createmerchandise","deprecated":false},{"title":"/merchandise/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchandise/executebatchoperations","deprecated":false},{"title":"/merchandise/{tenantId}/category/{category_id}","summary":"Returns a list of records with the specified category_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/merchandise/listmerchandisebycategoryid","deprecated":false},{"title":"/merchandise/{tenantId}/public","summary":"Lists all merchandise","prefix":{"name":"get","color":"get"},"badges":[],"link":"/merchandise/listallpublicmerchandise","deprecated":false},{"title":"/merchandise/{tenantId}/public/{id}","summary":"Gets merchandise info","prefix":{"name":"get","color":"get"},"badges":[],"link":"/merchandise/get","deprecated":false},{"title":"/merchandise/{tenantId}/search","summary":"Searches for merchandise using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchandise/searchformerchandise","deprecated":false},{"title":"/merchandise/{tenantId}/{id}","summary":"Returns a merchandise from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/merchandise/deletemerchandise","deprecated":false},{"title":"/merchandise/{tenantId}/{id}","summary":"Returns a merchandise from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/merchandise/getmerchandise","deprecated":false},{"title":"/merchandise/{tenantId}/{id}","summary":"Partially updates a merchandise with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/merchandise/patchmerchandise","deprecated":false},{"title":"/merchandise/{tenantId}/{id}","summary":"Updates a merchandise with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/merchandise/updatemerchandise","deprecated":false}]}]}]}]}},{"type":"group","label":"Orders","link":"/apis/commerce/commerce-v1/orders","routeSlug":"/apis/commerce/commerce-v1/orders","items":[{"label":"Gets all of the orders in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listorders","routeSlug":"/apis/commerce/commerce-v1/orders/listorders","metadata":{"seo":{"title":"Gets all of the orders in the system.","description":"This method will scan all orders and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrders","name":"Gets all of the orders in the system.","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the orders in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all orders and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1orders~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1orders~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orders/{tenantId}","href":"orders/listorders","openApiOperationId":"listOrders","summary":"Gets all of the orders in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The orderswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_468"}},"schemaId":"schema_468","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_468","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_468"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/listorders"}],"panels":[]}]},"httpPath":"/orders/{tenantId}"},{"label":"Processes a order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/processorder","routeSlug":"/apis/commerce/commerce-v1/orders/processorder","metadata":{"seo":{"title":"Processes a order","description":"This method will auto-generate an ID and create a new order. If an ID is specified for the order, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processOrder","name":"Processes a order","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Processes a order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new order. If an ID is specified for the order, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1orders~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Order"}},"schemaId":"components/schemas/Order","pointer":"/paths/~1orders~1{tenantId}/post/requestBody","description":"The order that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Order"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/orders/{tenantId}","href":"orders/processorder","openApiOperationId":"processOrder","summary":"Processes a order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Order","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Order"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order process was started","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The order you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The order could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/processorder"}],"panels":[]}]},"httpPath":"/orders/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/orders/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1orders~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orders/{tenantId}/batch","href":"orders/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The order could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/executebatchoperations"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/batch"},{"label":"Returns a list of records with the specified bill_to_contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listordersbybilltocontactid","routeSlug":"/apis/commerce/commerce-v1/orders/listordersbybilltocontactid","metadata":{"seo":{"title":"Returns a list of records with the specified bill_to_contact_id","description":"Returns a list of records with the specified bill_to_contact_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrdersByBillToContactId","name":"Returns a list of records with the specified bill_to_contact_id","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1billToContact~1{bill_to_contact_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified bill_to_contact_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified bill_to_contact_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"bill_to_contact_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bill_to_contact_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1orders~1{tenantId}~1billToContact~1{bill_to_contact_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1orders~1{tenantId}~1billToContact~1{bill_to_contact_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{tenantId}/billToContact/{bill_to_contact_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"bill_to_contact_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orders/{tenantId}/billToContact/{bill_to_contact_id}","href":"orders/listordersbybilltocontactid","openApiOperationId":"listOrdersByBillToContactId","summary":"Returns a list of records with the specified bill_to_contact_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}},"schemaId":"components/schemas/ListOrdersResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1billToContact~1{bill_to_contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListOrdersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/listordersbybilltocontactid"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/billToContact/{bill_to_contact_id}"},{"label":"Returns a list of records with the specified bill_to_organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listordersbybilltoorganizationid","routeSlug":"/apis/commerce/commerce-v1/orders/listordersbybilltoorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified bill_to_organization_id","description":"Returns a list of records with the specified bill_to_organization_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrdersByBillToOrganizationId","name":"Returns a list of records with the specified bill_to_organization_id","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1billToOrganization~1{bill_to_organization_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified bill_to_organization_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified bill_to_organization_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"bill_to_organization_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bill_to_organization_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1orders~1{tenantId}~1billToOrganization~1{bill_to_organization_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1orders~1{tenantId}~1billToOrganization~1{bill_to_organization_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{tenantId}/billToOrganization/{bill_to_organization_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"bill_to_organization_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orders/{tenantId}/billToOrganization/{bill_to_organization_id}","href":"orders/listordersbybilltoorganizationid","openApiOperationId":"listOrdersByBillToOrganizationId","summary":"Returns a list of records with the specified bill_to_organization_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}},"schemaId":"components/schemas/ListOrdersResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1billToOrganization~1{bill_to_organization_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListOrdersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/listordersbybilltoorganizationid"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/billToOrganization/{bill_to_organization_id}"},{"label":"Checks to see whether or not a person is eligible based on specified criteria","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/checkeligibility","routeSlug":"/apis/commerce/commerce-v1/orders/checkeligibility","metadata":{"seo":{"title":"Checks to see whether or not a person is eligible based on specified criteria","description":"This method takes in an order that has not yet been placed, and returns information about order pricing and available options"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"checkEligibility","name":"Checks to see whether or not a person is eligible based on specified criteria","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1checkEligibility~1{customerType}~1{contactOrOrganizationId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Checks to see whether or not a person is eligible based on specified criteria","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method takes in an order that has not yet been placed, and returns information about order pricing and available options"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed","required":true},{"name":"customerType","in":"path","schemaId":"schema_459","description":"The type of customer","required":true},{"name":"contactOrOrganizationId","in":"path","schemaId":"schema_459","description":"The contact or organization ID","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1checkEligibility~1{customerType}~1{contactOrOrganizationId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_469"}},"schemaId":"schema_469","pointer":"/paths/~1orders~1{tenantId}~1checkEligibility~1{customerType}~1{contactOrOrganizationId}/post/requestBody","description":"The order that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{tenantId}/checkEligibility/{customerType}/{contactOrOrganizationId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"customerType","in":"path","required":true,"schemaId":"schema_459"},{"name":"contactOrOrganizationId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_469"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/orders/{tenantId}/checkEligibility/{customerType}/{contactOrOrganizationId}","href":"orders/checkeligibility","openApiOperationId":"checkEligibility","summary":"Checks to see whether or not a person is eligible based on specified criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_469","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_469"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order preview was successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckEligibilityResponse"}},"schemaId":"components/schemas/CheckEligibilityResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The order record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The order could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1checkEligibility~1{customerType}~1{contactOrOrganizationId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CheckEligibilityResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckEligibilityResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/checkeligibility"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/checkEligibility/{customerType}/{contactOrOrganizationId}"},{"label":"Checks to see whether or not a person is eligible based on specified criteria","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/checkprice","routeSlug":"/apis/commerce/commerce-v1/orders/checkprice","metadata":{"seo":{"title":"Checks to see whether or not a person is eligible based on specified criteria","description":"This method takes in an order that has not yet been placed, and returns information about order pricing and available options"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"checkPrice","name":"Checks to see whether or not a person is eligible based on specified criteria","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1checkPrice~1{customerType}~1{billToId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Checks to see whether or not a person is eligible based on specified criteria","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method takes in an order that has not yet been placed, and returns information about order pricing and available options"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed","required":true},{"name":"customerType","in":"path","schemaId":"schema_459","description":"The type of customer","required":true},{"name":"billToId","in":"path","schemaId":"schema_459","description":"The bill to contact ID","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1checkPrice~1{customerType}~1{billToId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_469"}},"schemaId":"schema_469","pointer":"/paths/~1orders~1{tenantId}~1checkPrice~1{customerType}~1{billToId}/post/requestBody","description":"The order that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{tenantId}/checkPrice/{customerType}/{billToId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"customerType","in":"path","required":true,"schemaId":"schema_459"},{"name":"billToId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_469"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/orders/{tenantId}/checkPrice/{customerType}/{billToId}","href":"orders/checkprice","openApiOperationId":"checkPrice","summary":"Checks to see whether or not a person is eligible based on specified criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_469","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_469"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order preview was successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckPriceResponse"}},"schemaId":"components/schemas/CheckPriceResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The order record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The order could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1checkPrice~1{customerType}~1{billToId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CheckPriceResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckPriceResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/checkprice"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/checkPrice/{customerType}/{billToId}"},{"label":"Closes an Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/closeorder","routeSlug":"/apis/commerce/commerce-v1/orders/closeorder","metadata":{"seo":{"title":"Closes an Order","description":"Closes an order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"closeOrder","name":"Closes an Order","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1close~1{id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Closes an Order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Closes an order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The id of the order","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1close~1{id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{tenantId}/close/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/orders/{tenantId}/close/{id}","href":"orders/closeorder","openApiOperationId":"closeOrder","summary":"Closes an Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order preview was successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}},"schemaId":"components/schemas/Order","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The order record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The order could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1close~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Order","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/closeorder"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/close/{id}"},{"label":"Returns a list of records with the specified coupon_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listordersbycouponid","routeSlug":"/apis/commerce/commerce-v1/orders/listordersbycouponid","metadata":{"seo":{"title":"Returns a list of records with the specified coupon_id","description":"Returns a list of records with the specified coupon_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrdersByCouponId","name":"Returns a list of records with the specified coupon_id","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1coupon~1{coupon_type}~1{coupon_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified coupon_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified coupon_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"coupon_type","in":"path","schemaId":"schema_459","description":"The type of coupon","required":true},{"name":"coupon_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The coupon_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1orders~1{tenantId}~1coupon~1{coupon_type}~1{coupon_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1orders~1{tenantId}~1coupon~1{coupon_type}~1{coupon_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{tenantId}/coupon/{coupon_type}/{coupon_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"coupon_type","in":"path","required":true,"schemaId":"schema_459"},{"name":"coupon_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orders/{tenantId}/coupon/{coupon_type}/{coupon_id}","href":"orders/listordersbycouponid","openApiOperationId":"listOrdersByCouponId","summary":"Returns a list of records with the specified coupon_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}},"schemaId":"components/schemas/ListOrdersResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1coupon~1{coupon_type}~1{coupon_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListOrdersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/listordersbycouponid"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/coupon/{coupon_type}/{coupon_id}"},{"label":"Returns a list of records with the specified coupon_code_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listcouponcodeusagesbycouponcode","routeSlug":"/apis/commerce/commerce-v1/orders/listcouponcodeusagesbycouponcode","metadata":{"seo":{"title":"Returns a list of records with the specified coupon_code_id","description":"Returns a list of records with the specified coupon_code_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCouponCodeUsagesByCouponCode","name":"Returns a list of records with the specified coupon_code_id","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1couponCodeUsages~1{coupon_code_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified coupon_code_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified coupon_code_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"coupon_code_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The coupon_code_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1orders~1{tenantId}~1couponCodeUsages~1{coupon_code_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1orders~1{tenantId}~1couponCodeUsages~1{coupon_code_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{tenantId}/couponCodeUsages/{coupon_code_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"coupon_code_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orders/{tenantId}/couponCodeUsages/{coupon_code_id}","href":"orders/listcouponcodeusagesbycouponcode","openApiOperationId":"listCouponCodeUsagesByCouponCode","summary":"Returns a list of records with the specified coupon_code_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCouponUsagesResponse"}},"schemaId":"components/schemas/ListCouponUsagesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1couponCodeUsages~1{coupon_code_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCouponUsagesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCouponUsagesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/listcouponcodeusagesbycouponcode"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/couponCodeUsages/{coupon_code_id}"},{"label":"Returns a list of records with the specified coupon id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listcouponusagesbycoupon","routeSlug":"/apis/commerce/commerce-v1/orders/listcouponusagesbycoupon","metadata":{"seo":{"title":"Returns a list of records with the specified coupon id","description":"Returns a list of records with the specified coupon id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCouponUsagesByCoupon","name":"Returns a list of records with the specified coupon id","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1couponUsages~1{coupon_type}~1{coupon_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified coupon id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of records with the specified coupon id"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"coupon_type","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The coupon_type to use to for record lookup"},"children":[]}]}]}],"required":true},{"name":"coupon_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The coupon_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1orders~1{tenantId}~1couponUsages~1{coupon_type}~1{coupon_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1orders~1{tenantId}~1couponUsages~1{coupon_type}~1{coupon_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{tenantId}/couponUsages/{coupon_type}/{coupon_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"coupon_type","in":"path","required":true,"schemaId":"schema_459"},{"name":"coupon_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orders/{tenantId}/couponUsages/{coupon_type}/{coupon_id}","href":"orders/listcouponusagesbycoupon","openApiOperationId":"listCouponUsagesByCoupon","summary":"Returns a list of records with the specified coupon id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCouponUsagesResponse"}},"schemaId":"components/schemas/ListCouponUsagesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1couponUsages~1{coupon_type}~1{coupon_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCouponUsagesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCouponUsagesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/listcouponusagesbycoupon"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/couponUsages/{coupon_type}/{coupon_id}"},{"label":"List orders by customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listordersbycustomer","routeSlug":"/apis/commerce/commerce-v1/orders/listordersbycustomer","metadata":{"seo":{"title":"List orders by customer","description":"Includes orders where ship to"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrdersByCustomer","name":"List orders by customer","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1customer~1{customerType}~1{customerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List orders by customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Includes orders where ship to"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"customerType","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bill_to_contact_id to use to for record lookup"},"children":[]}]}]}],"required":true},{"name":"customerId","in":"path","schemaId":"schema_459","description":"The customer id","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1customer~1{customerType}~1{customerId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1orders~1{tenantId}~1customer~1{customerType}~1{customerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{tenantId}/customer/{customerType}/{customerId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"customerType","in":"path","required":true,"schemaId":"schema_459"},{"name":"customerId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orders/{tenantId}/customer/{customerType}/{customerId}","href":"orders/listordersbycustomer","openApiOperationId":"listOrdersByCustomer","summary":"List orders by customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}},"schemaId":"components/schemas/ListOrdersResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1customer~1{customerType}~1{customerId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListOrdersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/listordersbycustomer"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/customer/{customerType}/{customerId}"},{"label":"Returns a list of records with the specified installment_schedule_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listordersbyinstallmentscheduleid","routeSlug":"/apis/commerce/commerce-v1/orders/listordersbyinstallmentscheduleid","metadata":{"seo":{"title":"Returns a list of records with the specified installment_schedule_id","description":"Returns a list of records with the specified installment_schedule_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrdersByInstallmentScheduleId","name":"Returns a list of records with the specified installment_schedule_id","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1installmentSchedule~1{installment_schedule_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified installment_schedule_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified installment_schedule_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"installment_schedule_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The installment_schedule_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1orders~1{tenantId}~1installmentSchedule~1{installment_schedule_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1orders~1{tenantId}~1installmentSchedule~1{installment_schedule_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{tenantId}/installmentSchedule/{installment_schedule_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"installment_schedule_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orders/{tenantId}/installmentSchedule/{installment_schedule_id}","href":"orders/listordersbyinstallmentscheduleid","openApiOperationId":"listOrdersByInstallmentScheduleId","summary":"Returns a list of records with the specified installment_schedule_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}},"schemaId":"components/schemas/ListOrdersResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1installmentSchedule~1{installment_schedule_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListOrdersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/listordersbyinstallmentscheduleid"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/installmentSchedule/{installment_schedule_id}"},{"label":"Gets all of the orders in the system for a given contact.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listordersforportal","routeSlug":"/apis/commerce/commerce-v1/orders/listordersforportal","metadata":{"seo":{"title":"Gets all of the orders in the system for a given contact.","description":"This method will scan all orders and and return them to the caller for a given contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrdersForPortal","name":"Gets all of the orders in the system for a given contact.","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1portal~1contact~1{portalContactId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the orders in the system for a given contact.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all orders and and return them to the caller for a given contact."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"portalContactId","in":"path","schemaId":"schema_459","description":"The contact to use","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1portal~1contact~1{portalContactId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."}],"pointer":"/paths/~1orders~1{tenantId}~1portal~1contact~1{portalContactId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{tenantId}/portal/contact/{portalContactId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"portalContactId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orders/{tenantId}/portal/contact/{portalContactId}","href":"orders/listordersforportal","openApiOperationId":"listOrdersForPortal","summary":"Gets all of the orders in the system for a given contact."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The orderswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}},"schemaId":"components/schemas/ListOrdersResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1portal~1contact~1{portalContactId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListOrdersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/listordersforportal"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/portal/contact/{portalContactId}"},{"label":"Returns a order from the system by its ID for a given contact.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/getorderforportal","routeSlug":"/apis/commerce/commerce-v1/orders/getorderforportal","metadata":{"seo":{"title":"Returns a order from the system by its ID for a given contact.","description":"This method will look up a order by the specified ID and return it back (for a portal contact)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrderForPortal","name":"Returns a order from the system by its ID for a given contact.","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a order from the system by its ID for a given contact.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a order by the specified ID and return it back (for a portal contact)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"portalContactId","in":"path","schemaId":"schema_459","description":"The contact to use","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the order to return.","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1orders~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{tenantId}/portal/contact/{portalContactId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"portalContactId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orders/{tenantId}/portal/contact/{portalContactId}/{id}","href":"orders/getorderforportal","openApiOperationId":"getOrderForPortal","summary":"Returns a order from the system by its ID for a given contact."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}},"schemaId":"components/schemas/Order","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The order could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Order","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getorderforportal"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/portal/contact/{portalContactId}/{id}"},{"label":"Gets all of the orders in the system for a given organization.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listordersforportalbyorganization","routeSlug":"/apis/commerce/commerce-v1/orders/listordersforportalbyorganization","metadata":{"seo":{"title":"Gets all of the orders in the system for a given organization.","description":"This method will scan all orders and and return them to the caller for a given organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrdersForPortalByOrganization","name":"Gets all of the orders in the system for a given organization.","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1portal~1organization~1{portalOrganizationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the orders in the system for a given organization.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all orders and and return them to the caller for a given organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"portalOrganizationId","in":"path","schemaId":"schema_459","description":"The organization to use","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1portal~1organization~1{portalOrganizationId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."}],"pointer":"/paths/~1orders~1{tenantId}~1portal~1organization~1{portalOrganizationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{tenantId}/portal/organization/{portalOrganizationId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"portalOrganizationId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orders/{tenantId}/portal/organization/{portalOrganizationId}","href":"orders/listordersforportalbyorganization","openApiOperationId":"listOrdersForPortalByOrganization","summary":"Gets all of the orders in the system for a given organization."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The orderswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}},"schemaId":"components/schemas/ListOrdersResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add organization role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1portal~1organization~1{portalOrganizationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListOrdersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/listordersforportalbyorganization"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/portal/organization/{portalOrganizationId}"},{"label":"Returns a order from the system by its ID for a given organization.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/getorderforportal","routeSlug":"/apis/commerce/commerce-v1/orders/getorderforportal","metadata":{"seo":{"title":"Returns a order from the system by its ID for a given organization.","description":"This method will look up a order by the specified ID and return it back (for a portal organization)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrderForPortal","name":"Returns a order from the system by its ID for a given organization.","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1portal~1organization~1{portalOrganizationId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a order from the system by its ID for a given organization.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a order by the specified ID and return it back (for a portal organization)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"portalOrganizationId","in":"path","schemaId":"schema_459","description":"The organization to use","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the order to return.","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1portal~1organization~1{portalOrganizationId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1orders~1{tenantId}~1portal~1organization~1{portalOrganizationId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{tenantId}/portal/organization/{portalOrganizationId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"portalOrganizationId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orders/{tenantId}/portal/organization/{portalOrganizationId}/{id}","href":"orders/getorderforportal","openApiOperationId":"getOrderForPortal","summary":"Returns a order from the system by its ID for a given organization."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}},"schemaId":"components/schemas/Order","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The order could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1portal~1organization~1{portalOrganizationId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Order","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getorderforportal"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/portal/organization/{portalOrganizationId}/{id}"},{"label":"Preview an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/previeworder","routeSlug":"/apis/commerce/commerce-v1/orders/previeworder","metadata":{"seo":{"title":"Preview an order","description":"This method takes in an order that has not yet been placed, and returns information about order pricing and available options"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewOrder","name":"Preview an order","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1preview/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preview an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method takes in an order that has not yet been placed, and returns information about order pricing and available options"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1preview/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Order"}},"schemaId":"components/schemas/Order","pointer":"/paths/~1orders~1{tenantId}~1preview/post/requestBody","description":"The order that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{tenantId}/preview","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Order"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/orders/{tenantId}/preview","href":"orders/previeworder","openApiOperationId":"previewOrder","summary":"Preview an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Order","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Order"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order preview was successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderPreviewResponse"}},"schemaId":"components/schemas/OrderPreviewResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The order record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The order could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1preview/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderPreviewResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderPreviewResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/previeworder"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/preview"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/previeworderconfirmationemail","routeSlug":"/apis/commerce/commerce-v1/orders/previeworderconfirmationemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewOrderConfirmationEmail","name":"Sends out a preview of the CRC notification email","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1previewOrderConfirmationEmail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the CRC notification email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the CRC notification email"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1previewOrderConfirmationEmail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewOrderConfirmationEmailRequest"}},"schemaId":"components/schemas/PreviewOrderConfirmationEmailRequest","pointer":"/paths/~1orders~1{tenantId}~1previewOrderConfirmationEmail/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{tenantId}/previewOrderConfirmationEmail","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewOrderConfirmationEmailRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orders/{tenantId}/previewOrderConfirmationEmail","href":"orders/previeworderconfirmationemail","openApiOperationId":"previewOrderConfirmationEmail","summary":"Sends out a preview of the CRC notification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewOrderConfirmationEmailRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewOrderConfirmationEmailRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1previewOrderConfirmationEmail/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/previeworderconfirmationemail"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/previewOrderConfirmationEmail"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/previewproductconfirmationemail","routeSlug":"/apis/commerce/commerce-v1/orders/previewproductconfirmationemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewProductConfirmationEmail","name":"Sends out a preview of the CRC notification email","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1previewProductConfirmationEmail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the CRC notification email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the CRC notification email"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1previewProductConfirmationEmail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewProductConfirmationEmailRequest"}},"schemaId":"components/schemas/PreviewProductConfirmationEmailRequest","pointer":"/paths/~1orders~1{tenantId}~1previewProductConfirmationEmail/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{tenantId}/previewProductConfirmationEmail","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewProductConfirmationEmailRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orders/{tenantId}/previewProductConfirmationEmail","href":"orders/previewproductconfirmationemail","openApiOperationId":"previewProductConfirmationEmail","summary":"Sends out a preview of the CRC notification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewProductConfirmationEmailRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewProductConfirmationEmailRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1previewProductConfirmationEmail/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/previewproductconfirmationemail"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/previewProductConfirmationEmail"},{"label":"Previews an order with line item overrides","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/previeworderwithoverride","routeSlug":"/apis/commerce/commerce-v1/orders/previeworderwithoverride","metadata":{"seo":{"title":"Previews an order with line item overrides","description":"This is designed to be run by administrators; allows an order to e previewed but have prices or quantities overridden"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewOrderWithOverride","name":"Previews an order with line item overrides","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1previewWithOverride/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Previews an order with line item overrides","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This is designed to be run by administrators; allows an order to e previewed but have prices or quantities overridden"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1previewWithOverride/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderWithOverride"}},"schemaId":"components/schemas/OrderWithOverride","pointer":"/paths/~1orders~1{tenantId}~1previewWithOverride/post/requestBody","description":"The order that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{tenantId}/previewWithOverride","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderWithOverride"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/orders/{tenantId}/previewWithOverride","href":"orders/previeworderwithoverride","openApiOperationId":"previewOrderWithOverride","summary":"Previews an order with line item overrides"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/OrderWithOverride","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderWithOverride"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order preview was successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderPreviewResponse"}},"schemaId":"components/schemas/OrderPreviewResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The order record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The order could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1previewWithOverride/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderPreviewResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderPreviewResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/previeworderwithoverride"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/previewWithOverride"},{"label":"Processes an order with line item overrides","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/processorderwithoverride","routeSlug":"/apis/commerce/commerce-v1/orders/processorderwithoverride","metadata":{"seo":{"title":"Processes an order with line item overrides","description":"This is designed to be run by administrators; allows an order to e processed but have prices or quantities overridden"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processOrderWithOverride","name":"Processes an order with line item overrides","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1processWithOverride/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Processes an order with line item overrides","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This is designed to be run by administrators; allows an order to e processed but have prices or quantities overridden"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1processWithOverride/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderWithOverride"}},"schemaId":"components/schemas/OrderWithOverride","pointer":"/paths/~1orders~1{tenantId}~1processWithOverride/post/requestBody","description":"The order that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{tenantId}/processWithOverride","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderWithOverride"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/orders/{tenantId}/processWithOverride","href":"orders/processorderwithoverride","openApiOperationId":"processOrderWithOverride","summary":"Processes an order with line item overrides"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/OrderWithOverride","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderWithOverride"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order preview was successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The order record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The order could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1processWithOverride/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/processorderwithoverride"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/processWithOverride"},{"label":"Processes an order with line item overrides","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/processorderwithoverridesync","routeSlug":"/apis/commerce/commerce-v1/orders/processorderwithoverridesync","metadata":{"seo":{"title":"Processes an order with line item overrides","description":"This is designed to be run by administrators; allows an order to e processed but have prices or quantities overridden"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processOrderWithOverrideSync","name":"Processes an order with line item overrides","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1processWithOverride~1sync/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Processes an order with line item overrides","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This is designed to be run by administrators; allows an order to e processed but have prices or quantities overridden"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1processWithOverride~1sync/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderWithOverride"}},"schemaId":"components/schemas/OrderWithOverride","pointer":"/paths/~1orders~1{tenantId}~1processWithOverride~1sync/post/requestBody","description":"The order that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{tenantId}/processWithOverride/sync","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderWithOverride"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/orders/{tenantId}/processWithOverride/sync","href":"orders/processorderwithoverridesync","openApiOperationId":"processOrderWithOverrideSync","summary":"Processes an order with line item overrides"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/OrderWithOverride","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderWithOverride"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order preview was successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The order record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The order could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1processWithOverride~1sync/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/processorderwithoverridesync"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/processWithOverride/sync"},{"label":"Gets the availability of merchandise","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/getmerchandiseavailability","routeSlug":"/apis/commerce/commerce-v1/orders/getmerchandiseavailability","metadata":{"seo":{"title":"Gets the availability of merchandise","description":"Takes in merchandise and determines it's availability"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMerchandiseAvailability","name":"Gets the availability of merchandise","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1public~1checkAvailability/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the availability of merchandise","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Takes in merchandise and determines it's availability"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1public~1checkAvailability/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Order"}},"schemaId":"components/schemas/Order","pointer":"/paths/~1orders~1{tenantId}~1public~1checkAvailability/post/requestBody","description":"The order that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{tenantId}/public/checkAvailability","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Order"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/orders/{tenantId}/public/checkAvailability","href":"orders/getmerchandiseavailability","openApiOperationId":"getMerchandiseAvailability","summary":"Gets the availability of merchandise"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Order","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Order"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order preview was successful","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The order record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The order could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1public~1checkAvailability/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getmerchandiseavailability"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/public/checkAvailability"},{"label":"Preview an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/describeproducts","routeSlug":"/apis/commerce/commerce-v1/orders/describeproducts","metadata":{"seo":{"title":"Preview an order","description":"This method takes in an order that has not yet been placed, and returns information about order pricing and available options"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"describeProducts","name":"Preview an order","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1public~1describeProducts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preview an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method takes in an order that has not yet been placed, and returns information about order pricing and available options"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1public~1describeProducts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProductDescriptionRequest"}},"schemaId":"components/schemas/ProductDescriptionRequest","pointer":"/paths/~1orders~1{tenantId}~1public~1describeProducts/post/requestBody","description":"The products you want to describe"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{tenantId}/public/describeProducts","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ProductDescriptionRequest"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/orders/{tenantId}/public/describeProducts","href":"orders/describeproducts","openApiOperationId":"describeProducts","summary":"Preview an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ProductDescriptionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProductDescriptionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order preview was successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductDescriptionResponse"}},"schemaId":"components/schemas/ProductDescriptionResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The order record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The order could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1public~1describeProducts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductDescriptionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductDescriptionResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/describeproducts"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/public/describeProducts"},{"label":"Previews an order publicly","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/previeworder","routeSlug":"/apis/commerce/commerce-v1/orders/previeworder","metadata":{"seo":{"title":"Previews an order publicly","description":"This method takes in an order that has not yet been placed, and returns information about order pricing and available options"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewOrder","name":"Previews an order publicly","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1public~1preview/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Previews an order publicly","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method takes in an order that has not yet been placed, and returns information about order pricing and available options"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1public~1preview/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Order"}},"schemaId":"components/schemas/Order","pointer":"/paths/~1orders~1{tenantId}~1public~1preview/post/requestBody","description":"The order that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{tenantId}/public/preview","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Order"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/orders/{tenantId}/public/preview","href":"orders/previeworder","openApiOperationId":"previewOrder","summary":"Previews an order publicly"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Order","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Order"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order preview was successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderPreviewResponse"}},"schemaId":"components/schemas/OrderPreviewResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The order record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The order could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1public~1preview/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderPreviewResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderPreviewResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/previeworder"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/public/preview"},{"label":"Applies a coupon to an existing order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/retroactivelyapplycoupontoorder","routeSlug":"/apis/commerce/commerce-v1/orders/retroactivelyapplycoupontoorder","metadata":{"seo":{"title":"Applies a coupon to an existing order","description":"This is designed to be run by administrators; allows an order to e processed but have prices or quantities overridden"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retroactivelyApplyCouponToOrder","name":"Applies a coupon to an existing order","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1retroactivelyApplyCoupon/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Applies a coupon to an existing order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This is designed to be run by administrators; allows an order to e processed but have prices or quantities overridden"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1retroactivelyApplyCoupon/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RetroCouponRequest"}},"schemaId":"components/schemas/RetroCouponRequest","pointer":"/paths/~1orders~1{tenantId}~1retroactivelyApplyCoupon/post/requestBody","description":"The order that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{tenantId}/retroactivelyApplyCoupon","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RetroCouponRequest"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/orders/{tenantId}/retroactivelyApplyCoupon","href":"orders/retroactivelyapplycoupontoorder","openApiOperationId":"retroactivelyApplyCouponToOrder","summary":"Applies a coupon to an existing order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/RetroCouponRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RetroCouponRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order preview was successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The order record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The order could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1retroactivelyApplyCoupon/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/retroactivelyapplycoupontoorder"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/retroactivelyApplyCoupon"},{"label":"Applies a coupon to an existing order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/retroactivelyapplycoupontoordersync","routeSlug":"/apis/commerce/commerce-v1/orders/retroactivelyapplycoupontoordersync","metadata":{"seo":{"title":"Applies a coupon to an existing order","description":"This is designed to be run by administrators; allows an order to e processed but have prices or quantities overridden"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retroactivelyApplyCouponToOrderSync","name":"Applies a coupon to an existing order","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1retroactivelyApplyCoupon~1sync/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Applies a coupon to an existing order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This is designed to be run by administrators; allows an order to e processed but have prices or quantities overridden"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1retroactivelyApplyCoupon~1sync/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Order"}},"schemaId":"components/schemas/Order","pointer":"/paths/~1orders~1{tenantId}~1retroactivelyApplyCoupon~1sync/post/requestBody","description":"The order that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{tenantId}/retroactivelyApplyCoupon/sync","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Order"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/orders/{tenantId}/retroactivelyApplyCoupon/sync","href":"orders/retroactivelyapplycoupontoordersync","openApiOperationId":"retroactivelyApplyCouponToOrderSync","summary":"Applies a coupon to an existing order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Order","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Order"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order preview was successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The order record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The order could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1retroactivelyApplyCoupon~1sync/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/retroactivelyapplycoupontoordersync"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/retroactivelyApplyCoupon/sync"},{"label":"Searches for orders using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/searchfororders","routeSlug":"/apis/commerce/commerce-v1/orders/searchfororders","metadata":{"seo":{"title":"Searches for orders using predefined parameters","description":"Searches for orders using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForOrders","name":"Searches for orders using predefined parameters","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for orders using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for orders using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_459","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1orders~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderSearchParameters"}},"schemaId":"components/schemas/OrderSearchParameters","pointer":"/paths/~1orders~1{tenantId}~1search/post/requestBody","description":"The order that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{tenantId}/search","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/orders/{tenantId}/search","href":"orders/searchfororders","openApiOperationId":"searchForOrders","summary":"Searches for orders using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/OrderSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedOrderSearchResults"}},"schemaId":"components/schemas/PagedOrderSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The order you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The order could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedOrderSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedOrderSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/searchfororders"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/search"},{"label":"Returns a list of records with the specified ship_to_contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listordersbyshiptocontactid","routeSlug":"/apis/commerce/commerce-v1/orders/listordersbyshiptocontactid","metadata":{"seo":{"title":"Returns a list of records with the specified ship_to_contact_id","description":"Returns a list of records with the specified ship_to_contact_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrdersByShipToContactId","name":"Returns a list of records with the specified ship_to_contact_id","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1shipToContact~1{ship_to_contact_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified ship_to_contact_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified ship_to_contact_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"ship_to_contact_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ship_to_contact_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1orders~1{tenantId}~1shipToContact~1{ship_to_contact_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1orders~1{tenantId}~1shipToContact~1{ship_to_contact_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{tenantId}/shipToContact/{ship_to_contact_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"ship_to_contact_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orders/{tenantId}/shipToContact/{ship_to_contact_id}","href":"orders/listordersbyshiptocontactid","openApiOperationId":"listOrdersByShipToContactId","summary":"Returns a list of records with the specified ship_to_contact_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}},"schemaId":"components/schemas/ListOrdersResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1shipToContact~1{ship_to_contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListOrdersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/listordersbyshiptocontactid"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/shipToContact/{ship_to_contact_id}"},{"label":"Returns a list of records with the specified ship_to_organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listordersbyshiptoorganizationid","routeSlug":"/apis/commerce/commerce-v1/orders/listordersbyshiptoorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified ship_to_organization_id","description":"Returns a list of records with the specified ship_to_organization_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrdersByShipToOrganizationId","name":"Returns a list of records with the specified ship_to_organization_id","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1shipToOrganization~1{ship_to_organization_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified ship_to_organization_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified ship_to_organization_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"ship_to_organization_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ship_to_organization_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1orders~1{tenantId}~1shipToOrganization~1{ship_to_organization_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1orders~1{tenantId}~1shipToOrganization~1{ship_to_organization_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{tenantId}/shipToOrganization/{ship_to_organization_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"ship_to_organization_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orders/{tenantId}/shipToOrganization/{ship_to_organization_id}","href":"orders/listordersbyshiptoorganizationid","openApiOperationId":"listOrdersByShipToOrganizationId","summary":"Returns a list of records with the specified ship_to_organization_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}},"schemaId":"components/schemas/ListOrdersResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1shipToOrganization~1{ship_to_organization_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListOrdersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/listordersbyshiptoorganizationid"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/shipToOrganization/{ship_to_organization_id}"},{"label":"Returns a list of shippable orders with the specified status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listshippableordersbystatus","routeSlug":"/apis/commerce/commerce-v1/orders/listshippableordersbystatus","metadata":{"seo":{"title":"Returns a list of shippable orders with the specified status","description":"Returns a list of shippable orders with the specified status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listShippableOrdersByStatus","name":"Returns a list of shippable orders with the specified status","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1shippable~1status~1{status}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of shippable orders with the specified status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of shippable orders with the specified status"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"status","in":"path","schemaId":"schema_459","description":"The status to use to for record lookup","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1shippable~1status~1{status}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1orders~1{tenantId}~1shippable~1status~1{status}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{tenantId}/shippable/status/{status}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"status","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orders/{tenantId}/shippable/status/{status}","href":"orders/listshippableordersbystatus","openApiOperationId":"listShippableOrdersByStatus","summary":"Returns a list of shippable orders with the specified status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}},"schemaId":"components/schemas/ListOrdersResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1shippable~1status~1{status}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListOrdersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/listshippableordersbystatus"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/shippable/status/{status}"},{"label":"Returns a list of records with the specified shippable_status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listordersbyshippablestatus","routeSlug":"/apis/commerce/commerce-v1/orders/listordersbyshippablestatus","metadata":{"seo":{"title":"Returns a list of records with the specified shippable_status","description":"Returns a list of records with the specified shippable_status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrdersByShippableStatus","name":"Returns a list of records with the specified shippable_status","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1shippableStatus~1{shippable_status}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified shippable_status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified shippable_status"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"shippable_status","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The shippable_status to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1orders~1{tenantId}~1shippableStatus~1{shippable_status}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1orders~1{tenantId}~1shippableStatus~1{shippable_status}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{tenantId}/shippableStatus/{shippable_status}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"shippable_status","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orders/{tenantId}/shippableStatus/{shippable_status}","href":"orders/listordersbyshippablestatus","openApiOperationId":"listOrdersByShippableStatus","summary":"Returns a list of records with the specified shippable_status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}},"schemaId":"components/schemas/ListOrdersResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1shippableStatus~1{shippable_status}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListOrdersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListOrdersResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/listordersbyshippablestatus"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/shippableStatus/{shippable_status}"},{"label":"Creates a new order that doesn't already exist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/processordersync","routeSlug":"/apis/commerce/commerce-v1/orders/processordersync","metadata":{"seo":{"title":"Creates a new order that doesn't already exist","description":"This method will auto-generate an ID and create a new order. If an ID is specified for the order, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processOrderSync","name":"Creates a new order that doesn't already exist","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1sync/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new order that doesn't already exist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new order. If an ID is specified for the order, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1sync/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Order"}},"schemaId":"components/schemas/Order","pointer":"/paths/~1orders~1{tenantId}~1sync/post/requestBody","description":"The order that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{tenantId}/sync","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Order"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/orders/{tenantId}/sync","href":"orders/processordersync","openApiOperationId":"processOrderSync","summary":"Creates a new order that doesn't already exist"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Order","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Order"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}},"schemaId":"components/schemas/Order","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The order you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The order could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1sync/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Order","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/processordersync"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/sync"},{"label":"Void an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/voidorder","routeSlug":"/apis/commerce/commerce-v1/orders/voidorder","metadata":{"seo":{"title":"Void an order","description":"This method voids an order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"voidOrder","name":"Void an order","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1void~1{id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Void an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method voids an order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The  id of the order that you would like to be voided.","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1void~1{id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{tenantId}/void/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/orders/{tenantId}/void/{id}","href":"orders/voidorder","openApiOperationId":"voidOrder","summary":"Void an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order void was successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}},"schemaId":"components/schemas/Order","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The order record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The order could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1void~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Order","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/voidorder"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/void/{id}"},{"label":"Returns a order from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/deleteorder","routeSlug":"/apis/commerce/commerce-v1/orders/deleteorder","metadata":{"seo":{"title":"Returns a order from the system by its ID.","description":"This method will delete a order with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrder","name":"Returns a order from the system by its ID.","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a order from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a order with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the order to delete.","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/orders/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/orders/{tenantId}/{id}","href":"orders/deleteorder","openApiOperationId":"deleteOrder","summary":"Returns a order from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The order could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The order could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/deleteorder"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/{id}"},{"label":"Returns a order from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/getorder","routeSlug":"/apis/commerce/commerce-v1/orders/getorder","metadata":{"seo":{"title":"Returns a order from the system by its ID.","description":"This method will look up a order by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrder","name":"Returns a order from the system by its ID.","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a order from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a order by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the order to return.","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1orders~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/orders/{tenantId}/{id}","href":"orders/getorder","openApiOperationId":"getOrder","summary":"Returns a order from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}},"schemaId":"components/schemas/Order","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The order could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Order","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getorder"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/{id}"},{"label":"Partially updates a order with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/patchorder","routeSlug":"/apis/commerce/commerce-v1/orders/patchorder","metadata":{"seo":{"title":"Partially updates a order with the specified ID.","description":"This method will patch an existing order with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchOrder","name":"Partially updates a order with the specified ID.","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a order with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing order with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the order to patch.","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1orders~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/orders/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/orders/{tenantId}/{id}","href":"orders/patchorder","openApiOperationId":"patchOrder","summary":"Partially updates a order with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}},"schemaId":"components/schemas/Order","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The order could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The order could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Order","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/patchorder"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/{id}"},{"label":"Updates a order with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/updateorder","routeSlug":"/apis/commerce/commerce-v1/orders/updateorder","metadata":{"seo":{"title":"Updates a order with the specified ID.","description":"This method will update an existing order with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOrder","name":"Updates a order with the specified ID.","isWebhook":false,"pointer":"/paths/~1orders~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a order with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing order with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the order to update.","required":true}],"pointer":"/paths/~1orders~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Order"}},"schemaId":"components/schemas/Order","pointer":"/paths/~1orders~1{tenantId}~1{id}/put/requestBody","description":"The updated order that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/orders/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Order"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/orders/{tenantId}/{id}","href":"orders/updateorder","openApiOperationId":"updateOrder","summary":"Updates a order with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Order","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Order"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}},"schemaId":"components/schemas/Order","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The order supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The order could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The order could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1orders~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Order","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/updateorder"}],"panels":[]}]},"httpPath":"/orders/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders","showPageActions":true},{"nodeType":"markdoc","content":"Orders"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/orders/{tenantId}","summary":"Gets all of the orders in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/listorders","deprecated":false},{"title":"/orders/{tenantId}","summary":"Processes a order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/processorder","deprecated":false},{"title":"/orders/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/executebatchoperations","deprecated":false},{"title":"/orders/{tenantId}/billToContact/{bill_to_contact_id}","summary":"Returns a list of records with the specified bill_to_contact_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/listordersbybilltocontactid","deprecated":false},{"title":"/orders/{tenantId}/billToOrganization/{bill_to_organization_id}","summary":"Returns a list of records with the specified bill_to_organization_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/listordersbybilltoorganizationid","deprecated":false},{"title":"/orders/{tenantId}/checkEligibility/{customerType}/{contactOrOrganizationId}","summary":"Checks to see whether or not a person is eligible based on specified criteria","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/checkeligibility","deprecated":false},{"title":"/orders/{tenantId}/checkPrice/{customerType}/{billToId}","summary":"Checks to see whether or not a person is eligible based on specified criteria","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/checkprice","deprecated":false},{"title":"/orders/{tenantId}/close/{id}","summary":"Closes an Order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/closeorder","deprecated":false},{"title":"/orders/{tenantId}/coupon/{coupon_type}/{coupon_id}","summary":"Returns a list of records with the specified coupon_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/listordersbycouponid","deprecated":false},{"title":"/orders/{tenantId}/couponCodeUsages/{coupon_code_id}","summary":"Returns a list of records with the specified coupon_code_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/listcouponcodeusagesbycouponcode","deprecated":false},{"title":"/orders/{tenantId}/couponUsages/{coupon_type}/{coupon_id}","summary":"Returns a list of records with the specified coupon id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/listcouponusagesbycoupon","deprecated":false},{"title":"/orders/{tenantId}/customer/{customerType}/{customerId}","summary":"List orders by customer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/listordersbycustomer","deprecated":false},{"title":"/orders/{tenantId}/installmentSchedule/{installment_schedule_id}","summary":"Returns a list of records with the specified installment_schedule_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/listordersbyinstallmentscheduleid","deprecated":false},{"title":"/orders/{tenantId}/portal/contact/{portalContactId}","summary":"Gets all of the orders in the system for a given contact.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/listordersforportal","deprecated":false},{"title":"/orders/{tenantId}/portal/contact/{portalContactId}/{id}","summary":"Returns a order from the system by its ID for a given contact.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getorderforportal","deprecated":false},{"title":"/orders/{tenantId}/portal/organization/{portalOrganizationId}","summary":"Gets all of the orders in the system for a given organization.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/listordersforportalbyorganization","deprecated":false},{"title":"/orders/{tenantId}/portal/organization/{portalOrganizationId}/{id}","summary":"Returns a order from the system by its ID for a given organization.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getorderforportal","deprecated":false},{"title":"/orders/{tenantId}/preview","summary":"Preview an order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/previeworder","deprecated":false},{"title":"/orders/{tenantId}/previewOrderConfirmationEmail","summary":"Sends out a preview of the CRC notification email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/previeworderconfirmationemail","deprecated":false},{"title":"/orders/{tenantId}/previewProductConfirmationEmail","summary":"Sends out a preview of the CRC notification email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/previewproductconfirmationemail","deprecated":false},{"title":"/orders/{tenantId}/previewWithOverride","summary":"Previews an order with line item overrides","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/previeworderwithoverride","deprecated":false},{"title":"/orders/{tenantId}/processWithOverride","summary":"Processes an order with line item overrides","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/processorderwithoverride","deprecated":false},{"title":"/orders/{tenantId}/processWithOverride/sync","summary":"Processes an order with line item overrides","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/processorderwithoverridesync","deprecated":false},{"title":"/orders/{tenantId}/public/checkAvailability","summary":"Gets the availability of merchandise","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/getmerchandiseavailability","deprecated":false},{"title":"/orders/{tenantId}/public/describeProducts","summary":"Preview an order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/describeproducts","deprecated":false},{"title":"/orders/{tenantId}/public/preview","summary":"Previews an order publicly","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/previeworder","deprecated":false},{"title":"/orders/{tenantId}/retroactivelyApplyCoupon","summary":"Applies a coupon to an existing order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/retroactivelyapplycoupontoorder","deprecated":false},{"title":"/orders/{tenantId}/retroactivelyApplyCoupon/sync","summary":"Applies a coupon to an existing order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/retroactivelyapplycoupontoordersync","deprecated":false},{"title":"/orders/{tenantId}/search","summary":"Searches for orders using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/searchfororders","deprecated":false},{"title":"/orders/{tenantId}/shipToContact/{ship_to_contact_id}","summary":"Returns a list of records with the specified ship_to_contact_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/listordersbyshiptocontactid","deprecated":false},{"title":"/orders/{tenantId}/shipToOrganization/{ship_to_organization_id}","summary":"Returns a list of records with the specified ship_to_organization_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/listordersbyshiptoorganizationid","deprecated":false},{"title":"/orders/{tenantId}/shippable/status/{status}","summary":"Returns a list of shippable orders with the specified status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/listshippableordersbystatus","deprecated":false},{"title":"/orders/{tenantId}/shippableStatus/{shippable_status}","summary":"Returns a list of records with the specified shippable_status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/listordersbyshippablestatus","deprecated":false},{"title":"/orders/{tenantId}/sync","summary":"Creates a new order that doesn't already exist","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/processordersync","deprecated":false},{"title":"/orders/{tenantId}/void/{id}","summary":"Void an order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/voidorder","deprecated":false},{"title":"/orders/{tenantId}/{id}","summary":"Returns a order from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/orders/deleteorder","deprecated":false},{"title":"/orders/{tenantId}/{id}","summary":"Returns a order from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getorder","deprecated":false},{"title":"/orders/{tenantId}/{id}","summary":"Partially updates a order with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/orders/patchorder","deprecated":false},{"title":"/orders/{tenantId}/{id}","summary":"Updates a order with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orders/updateorder","deprecated":false}]}]}]}]}},{"type":"group","label":"Product Categories","link":"/apis/commerce/commerce-v1/product-categories","routeSlug":"/apis/commerce/commerce-v1/product-categories","items":[{"label":"Gets all of the product categories in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-categories/listproductcategories","routeSlug":"/apis/commerce/commerce-v1/product-categories/listproductcategories","metadata":{"seo":{"title":"Gets all of the product categories in the system.","description":"This method will scan all product categories and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProductCategories","name":"Gets all of the product categories in the system.","isWebhook":false,"pointer":"/paths/~1productCategories~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the product categories in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all product categories and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1productCategories~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1productCategories~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/productCategories/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/productCategories/{tenantId}","href":"product-categories/listproductcategories","openApiOperationId":"listProductCategories","summary":"Gets all of the product categories in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product categorieswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_470"}},"schemaId":"schema_470","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productCategories~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_470","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_470"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-categories/listproductcategories"}],"panels":[]}]},"httpPath":"/productCategories/{tenantId}"},{"label":"Creates a new product category record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-categories/createproductcategory","routeSlug":"/apis/commerce/commerce-v1/product-categories/createproductcategory","metadata":{"seo":{"title":"Creates a new product category record that does not already exist.","description":"This method will auto-generate an ID and create a new product category. If an ID is specified for the product category, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProductCategory","name":"Creates a new product category record that does not already exist.","isWebhook":false,"pointer":"/paths/~1productCategories~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new product category record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new product category. If an ID is specified for the product category, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1productCategories~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProductCategory"}},"schemaId":"components/schemas/ProductCategory","pointer":"/paths/~1productCategories~1{tenantId}/post/requestBody","description":"The product category that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/productCategories/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProductCategory"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/productCategories/{tenantId}","href":"product-categories/createproductcategory","openApiOperationId":"createProductCategory","summary":"Creates a new product category record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ProductCategory","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProductCategory"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product category was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductCategory"}},"schemaId":"components/schemas/ProductCategory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The product category you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The product category could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add product category based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productCategories~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductCategory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductCategory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-categories/createproductcategory"}],"panels":[]}]},"httpPath":"/productCategories/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-categories/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/product-categories/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1productCategories~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1productCategories~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1productCategories~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/productCategories/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/productCategories/{tenantId}/batch","href":"product-categories/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The product category could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve product category based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productCategories~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-categories/executebatchoperations"}],"panels":[]}]},"httpPath":"/productCategories/{tenantId}/batch"},{"label":"Returns a product category from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-categories/deleteproductcategory","routeSlug":"/apis/commerce/commerce-v1/product-categories/deleteproductcategory","metadata":{"seo":{"title":"Returns a product category from the system by its ID.","description":"This method will delete a product category with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProductCategory","name":"Returns a product category from the system by its ID.","isWebhook":false,"pointer":"/paths/~1productCategories~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a product category from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a product category with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the product category to delete.","required":true}],"pointer":"/paths/~1productCategories~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/productCategories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/productCategories/{tenantId}/{id}","href":"product-categories/deleteproductcategory","openApiOperationId":"deleteProductCategory","summary":"Returns a product category from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product category was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The product category could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The product category could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete product category based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productCategories~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-categories/deleteproductcategory"}],"panels":[]}]},"httpPath":"/productCategories/{tenantId}/{id}"},{"label":"Returns a product category from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-categories/getproductcategory","routeSlug":"/apis/commerce/commerce-v1/product-categories/getproductcategory","metadata":{"seo":{"title":"Returns a product category from the system by its ID.","description":"This method will look up a product category by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProductCategory","name":"Returns a product category from the system by its ID.","isWebhook":false,"pointer":"/paths/~1productCategories~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a product category from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a product category by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the product category to return.","required":true}],"pointer":"/paths/~1productCategories~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1productCategories~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/productCategories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/productCategories/{tenantId}/{id}","href":"product-categories/getproductcategory","openApiOperationId":"getProductCategory","summary":"Returns a product category from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product category was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductCategory"}},"schemaId":"components/schemas/ProductCategory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The product category could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve product category based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productCategories~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductCategory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductCategory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-categories/getproductcategory"}],"panels":[]}]},"httpPath":"/productCategories/{tenantId}/{id}"},{"label":"Partially updates a product category with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-categories/patchproductcategory","routeSlug":"/apis/commerce/commerce-v1/product-categories/patchproductcategory","metadata":{"seo":{"title":"Partially updates a product category with the specified ID.","description":"This method will patch an existing product category with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchProductCategory","name":"Partially updates a product category with the specified ID.","isWebhook":false,"pointer":"/paths/~1productCategories~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a product category with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing product category with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the product category to patch.","required":true}],"pointer":"/paths/~1productCategories~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1productCategories~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/productCategories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/productCategories/{tenantId}/{id}","href":"product-categories/patchproductcategory","openApiOperationId":"patchProductCategory","summary":"Partially updates a product category with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product category was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductCategory"}},"schemaId":"components/schemas/ProductCategory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The product category could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The product category could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve product category based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productCategories~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductCategory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductCategory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-categories/patchproductcategory"}],"panels":[]}]},"httpPath":"/productCategories/{tenantId}/{id}"},{"label":"Updates a product category with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-categories/updateproductcategory","routeSlug":"/apis/commerce/commerce-v1/product-categories/updateproductcategory","metadata":{"seo":{"title":"Updates a product category with the specified ID.","description":"This method will update an existing product category with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProductCategory","name":"Updates a product category with the specified ID.","isWebhook":false,"pointer":"/paths/~1productCategories~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a product category with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing product category with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the product category to update.","required":true}],"pointer":"/paths/~1productCategories~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProductCategory"}},"schemaId":"components/schemas/ProductCategory","pointer":"/paths/~1productCategories~1{tenantId}~1{id}/put/requestBody","description":"The updated product category that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/productCategories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProductCategory"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/productCategories/{tenantId}/{id}","href":"product-categories/updateproductcategory","openApiOperationId":"updateProductCategory","summary":"Updates a product category with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ProductCategory","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProductCategory"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product category was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductCategory"}},"schemaId":"components/schemas/ProductCategory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The product category supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The product category could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The product category could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve product category based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productCategories~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductCategory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductCategory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-categories/updateproductcategory"}],"panels":[]}]},"httpPath":"/productCategories/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Product Categories"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product Categories","showPageActions":true},{"nodeType":"markdoc","content":"Product Categories"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/productCategories/{tenantId}","summary":"Gets all of the product categories in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-categories/listproductcategories","deprecated":false},{"title":"/productCategories/{tenantId}","summary":"Creates a new product category record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/product-categories/createproductcategory","deprecated":false},{"title":"/productCategories/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/product-categories/executebatchoperations","deprecated":false},{"title":"/productCategories/{tenantId}/{id}","summary":"Returns a product category from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/product-categories/deleteproductcategory","deprecated":false},{"title":"/productCategories/{tenantId}/{id}","summary":"Returns a product category from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-categories/getproductcategory","deprecated":false},{"title":"/productCategories/{tenantId}/{id}","summary":"Partially updates a product category with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/product-categories/patchproductcategory","deprecated":false},{"title":"/productCategories/{tenantId}/{id}","summary":"Updates a product category with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/product-categories/updateproductcategory","deprecated":false}]}]}]}]}},{"type":"group","label":"Product Confirmation Emails","link":"/apis/commerce/commerce-v1/product-confirmation-emails","routeSlug":"/apis/commerce/commerce-v1/product-confirmation-emails","items":[{"label":"Gets all of the product confirmation emails in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-confirmation-emails/listproductconfirmationemails","routeSlug":"/apis/commerce/commerce-v1/product-confirmation-emails/listproductconfirmationemails","metadata":{"seo":{"title":"Gets all of the product confirmation emails in the system.","description":"This method will scan all product confirmation emails and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProductConfirmationEmails","name":"Gets all of the product confirmation emails in the system.","isWebhook":false,"pointer":"/paths/~1productConfirmationEmails~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the product confirmation emails in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all product confirmation emails and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1productConfirmationEmails~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1productConfirmationEmails~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/productConfirmationEmails/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/productConfirmationEmails/{tenantId}","href":"product-confirmation-emails/listproductconfirmationemails","openApiOperationId":"listProductConfirmationEmails","summary":"Gets all of the product confirmation emails in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product confirmation emailswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_471"}},"schemaId":"schema_471","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productConfirmationEmails~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_471","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_471"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-confirmation-emails/listproductconfirmationemails"}],"panels":[]}]},"httpPath":"/productConfirmationEmails/{tenantId}"},{"label":"Creates a new product confirmation email record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-confirmation-emails/createproductconfirmationemail","routeSlug":"/apis/commerce/commerce-v1/product-confirmation-emails/createproductconfirmationemail","metadata":{"seo":{"title":"Creates a new product confirmation email record that does not already exist.","description":"This method will auto-generate an ID and create a new product confirmation email. If an ID is specified for the product confirmation email, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProductConfirmationEmail","name":"Creates a new product confirmation email record that does not already exist.","isWebhook":false,"pointer":"/paths/~1productConfirmationEmails~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new product confirmation email record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new product confirmation email. If an ID is specified for the product confirmation email, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1productConfirmationEmails~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProductConfirmationEmail"}},"schemaId":"components/schemas/ProductConfirmationEmail","pointer":"/paths/~1productConfirmationEmails~1{tenantId}/post/requestBody","description":"The product confirmation email that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/productConfirmationEmails/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProductConfirmationEmail"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/productConfirmationEmails/{tenantId}","href":"product-confirmation-emails/createproductconfirmationemail","openApiOperationId":"createProductConfirmationEmail","summary":"Creates a new product confirmation email record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ProductConfirmationEmail","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProductConfirmationEmail"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product confirmation email was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductConfirmationEmail"}},"schemaId":"components/schemas/ProductConfirmationEmail","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The product confirmation email you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The product confirmation email could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add product confirmation email based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productConfirmationEmails~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductConfirmationEmail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductConfirmationEmail"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-confirmation-emails/createproductconfirmationemail"}],"panels":[]}]},"httpPath":"/productConfirmationEmails/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-confirmation-emails/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/product-confirmation-emails/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1productConfirmationEmails~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1productConfirmationEmails~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1productConfirmationEmails~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/productConfirmationEmails/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/productConfirmationEmails/{tenantId}/batch","href":"product-confirmation-emails/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The product confirmation email could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve product confirmation email based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productConfirmationEmails~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-confirmation-emails/executebatchoperations"}],"panels":[]}]},"httpPath":"/productConfirmationEmails/{tenantId}/batch"},{"label":"Returns a product confirmation email from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-confirmation-emails/deleteproductconfirmationemail","routeSlug":"/apis/commerce/commerce-v1/product-confirmation-emails/deleteproductconfirmationemail","metadata":{"seo":{"title":"Returns a product confirmation email from the system by its ID.","description":"This method will delete a product confirmation email with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProductConfirmationEmail","name":"Returns a product confirmation email from the system by its ID.","isWebhook":false,"pointer":"/paths/~1productConfirmationEmails~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a product confirmation email from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a product confirmation email with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the product confirmation email to delete.","required":true}],"pointer":"/paths/~1productConfirmationEmails~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/productConfirmationEmails/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/productConfirmationEmails/{tenantId}/{id}","href":"product-confirmation-emails/deleteproductconfirmationemail","openApiOperationId":"deleteProductConfirmationEmail","summary":"Returns a product confirmation email from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product confirmation email was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The product confirmation email could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The product confirmation email could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete product confirmation email based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productConfirmationEmails~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-confirmation-emails/deleteproductconfirmationemail"}],"panels":[]}]},"httpPath":"/productConfirmationEmails/{tenantId}/{id}"},{"label":"Returns a product confirmation email from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-confirmation-emails/getproductconfirmationemail","routeSlug":"/apis/commerce/commerce-v1/product-confirmation-emails/getproductconfirmationemail","metadata":{"seo":{"title":"Returns a product confirmation email from the system by its ID.","description":"This method will look up a product confirmation email by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProductConfirmationEmail","name":"Returns a product confirmation email from the system by its ID.","isWebhook":false,"pointer":"/paths/~1productConfirmationEmails~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a product confirmation email from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a product confirmation email by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the product confirmation email to return.","required":true}],"pointer":"/paths/~1productConfirmationEmails~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1productConfirmationEmails~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/productConfirmationEmails/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/productConfirmationEmails/{tenantId}/{id}","href":"product-confirmation-emails/getproductconfirmationemail","openApiOperationId":"getProductConfirmationEmail","summary":"Returns a product confirmation email from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product confirmation email was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductConfirmationEmail"}},"schemaId":"components/schemas/ProductConfirmationEmail","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The product confirmation email could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve product confirmation email based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productConfirmationEmails~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductConfirmationEmail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductConfirmationEmail"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-confirmation-emails/getproductconfirmationemail"}],"panels":[]}]},"httpPath":"/productConfirmationEmails/{tenantId}/{id}"},{"label":"Partially updates a product confirmation email with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-confirmation-emails/patchproductconfirmationemail","routeSlug":"/apis/commerce/commerce-v1/product-confirmation-emails/patchproductconfirmationemail","metadata":{"seo":{"title":"Partially updates a product confirmation email with the specified ID.","description":"This method will patch an existing product confirmation email with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchProductConfirmationEmail","name":"Partially updates a product confirmation email with the specified ID.","isWebhook":false,"pointer":"/paths/~1productConfirmationEmails~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a product confirmation email with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing product confirmation email with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the product confirmation email to patch.","required":true}],"pointer":"/paths/~1productConfirmationEmails~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1productConfirmationEmails~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/productConfirmationEmails/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/productConfirmationEmails/{tenantId}/{id}","href":"product-confirmation-emails/patchproductconfirmationemail","openApiOperationId":"patchProductConfirmationEmail","summary":"Partially updates a product confirmation email with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product confirmation email was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductConfirmationEmail"}},"schemaId":"components/schemas/ProductConfirmationEmail","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The product confirmation email could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The product confirmation email could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve product confirmation email based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productConfirmationEmails~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductConfirmationEmail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductConfirmationEmail"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-confirmation-emails/patchproductconfirmationemail"}],"panels":[]}]},"httpPath":"/productConfirmationEmails/{tenantId}/{id}"},{"label":"Updates a product confirmation email with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-confirmation-emails/updateproductconfirmationemail","routeSlug":"/apis/commerce/commerce-v1/product-confirmation-emails/updateproductconfirmationemail","metadata":{"seo":{"title":"Updates a product confirmation email with the specified ID.","description":"This method will update an existing product confirmation email with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProductConfirmationEmail","name":"Updates a product confirmation email with the specified ID.","isWebhook":false,"pointer":"/paths/~1productConfirmationEmails~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a product confirmation email with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing product confirmation email with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the product confirmation email to update.","required":true}],"pointer":"/paths/~1productConfirmationEmails~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProductConfirmationEmail"}},"schemaId":"components/schemas/ProductConfirmationEmail","pointer":"/paths/~1productConfirmationEmails~1{tenantId}~1{id}/put/requestBody","description":"The updated product confirmation email that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/productConfirmationEmails/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProductConfirmationEmail"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/productConfirmationEmails/{tenantId}/{id}","href":"product-confirmation-emails/updateproductconfirmationemail","openApiOperationId":"updateProductConfirmationEmail","summary":"Updates a product confirmation email with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ProductConfirmationEmail","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProductConfirmationEmail"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product confirmation email was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductConfirmationEmail"}},"schemaId":"components/schemas/ProductConfirmationEmail","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The product confirmation email supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The product confirmation email could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The product confirmation email could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve product confirmation email based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productConfirmationEmails~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductConfirmationEmail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductConfirmationEmail"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-confirmation-emails/updateproductconfirmationemail"}],"panels":[]}]},"httpPath":"/productConfirmationEmails/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Product Confirmation Emails"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product Confirmation Emails","showPageActions":true},{"nodeType":"markdoc","content":"Product Confirmation Emails"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/productConfirmationEmails/{tenantId}","summary":"Gets all of the product confirmation emails in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-confirmation-emails/listproductconfirmationemails","deprecated":false},{"title":"/productConfirmationEmails/{tenantId}","summary":"Creates a new product confirmation email record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/product-confirmation-emails/createproductconfirmationemail","deprecated":false},{"title":"/productConfirmationEmails/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/product-confirmation-emails/executebatchoperations","deprecated":false},{"title":"/productConfirmationEmails/{tenantId}/{id}","summary":"Returns a product confirmation email from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/product-confirmation-emails/deleteproductconfirmationemail","deprecated":false},{"title":"/productConfirmationEmails/{tenantId}/{id}","summary":"Returns a product confirmation email from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-confirmation-emails/getproductconfirmationemail","deprecated":false},{"title":"/productConfirmationEmails/{tenantId}/{id}","summary":"Partially updates a product confirmation email with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/product-confirmation-emails/patchproductconfirmationemail","deprecated":false},{"title":"/productConfirmationEmails/{tenantId}/{id}","summary":"Updates a product confirmation email with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/product-confirmation-emails/updateproductconfirmationemail","deprecated":false}]}]}]}]}},{"type":"group","label":"Product Inventories","link":"/apis/commerce/commerce-v1/product-inventories","routeSlug":"/apis/commerce/commerce-v1/product-inventories","items":[{"label":"Gets all of the product inventories in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-inventories/listproductinventories","routeSlug":"/apis/commerce/commerce-v1/product-inventories/listproductinventories","metadata":{"seo":{"title":"Gets all of the product inventories in the system.","description":"This method will scan all product inventories and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProductInventories","name":"Gets all of the product inventories in the system.","isWebhook":false,"pointer":"/paths/~1productInventories~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the product inventories in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all product inventories and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1productInventories~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1productInventories~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/productInventories/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/productInventories/{tenantId}","href":"product-inventories/listproductinventories","openApiOperationId":"listProductInventories","summary":"Gets all of the product inventories in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product inventorieswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_472"}},"schemaId":"schema_472","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productInventories~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_472","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_472"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-inventories/listproductinventories"}],"panels":[]}]},"httpPath":"/productInventories/{tenantId}"},{"label":"Creates a new product inventory record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-inventories/createproductinventory","routeSlug":"/apis/commerce/commerce-v1/product-inventories/createproductinventory","metadata":{"seo":{"title":"Creates a new product inventory record that does not already exist.","description":"This method will auto-generate an ID and create a new product inventory. If an ID is specified for the product inventory, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProductInventory","name":"Creates a new product inventory record that does not already exist.","isWebhook":false,"pointer":"/paths/~1productInventories~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new product inventory record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new product inventory. If an ID is specified for the product inventory, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1productInventories~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProductInventory"}},"schemaId":"components/schemas/ProductInventory","pointer":"/paths/~1productInventories~1{tenantId}/post/requestBody","description":"The product inventory that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/productInventories/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProductInventory"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/productInventories/{tenantId}","href":"product-inventories/createproductinventory","openApiOperationId":"createProductInventory","summary":"Creates a new product inventory record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ProductInventory","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProductInventory"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product inventory was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductInventory"}},"schemaId":"components/schemas/ProductInventory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The product inventory you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The product inventory could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add product inventory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productInventories~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductInventory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductInventory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-inventories/createproductinventory"}],"panels":[]}]},"httpPath":"/productInventories/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-inventories/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/product-inventories/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1productInventories~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1productInventories~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1productInventories~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/productInventories/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/productInventories/{tenantId}/batch","href":"product-inventories/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The product inventory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve product inventory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productInventories~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-inventories/executebatchoperations"}],"panels":[]}]},"httpPath":"/productInventories/{tenantId}/batch"},{"label":"Returns a list of records with the specified product_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-inventories/listinventoriesbyproductid","routeSlug":"/apis/commerce/commerce-v1/product-inventories/listinventoriesbyproductid","metadata":{"seo":{"title":"Returns a list of records with the specified product_id","description":"Returns a list of records with the specified product_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInventoriesByProductId","name":"Returns a list of records with the specified product_id","isWebhook":false,"pointer":"/paths/~1productInventories~1{tenantId}~1product~1{product_type}~1{product_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified product_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified product_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"product_type","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The product_type to use to for record lookup"},"children":[]}]}]}],"required":true},{"name":"product_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The product_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1productInventories~1{tenantId}~1product~1{product_type}~1{product_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1productInventories~1{tenantId}~1product~1{product_type}~1{product_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/productInventories/{tenantId}/product/{product_type}/{product_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"product_type","in":"path","required":true,"schemaId":"schema_459"},{"name":"product_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/productInventories/{tenantId}/product/{product_type}/{product_id}","href":"product-inventories/listinventoriesbyproductid","openApiOperationId":"listInventoriesByProductId","summary":"Returns a list of records with the specified product_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListProductInventoriesResponse"}},"schemaId":"components/schemas/ListProductInventoriesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productInventories~1{tenantId}~1product~1{product_type}~1{product_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListProductInventoriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListProductInventoriesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-inventories/listinventoriesbyproductid"}],"panels":[]}]},"httpPath":"/productInventories/{tenantId}/product/{product_type}/{product_id}"},{"label":"Returns a product inventory from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-inventories/deleteproductinventory","routeSlug":"/apis/commerce/commerce-v1/product-inventories/deleteproductinventory","metadata":{"seo":{"title":"Returns a product inventory from the system by its ID.","description":"This method will delete a product inventory with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProductInventory","name":"Returns a product inventory from the system by its ID.","isWebhook":false,"pointer":"/paths/~1productInventories~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a product inventory from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a product inventory with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the product inventory to delete.","required":true}],"pointer":"/paths/~1productInventories~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/productInventories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/productInventories/{tenantId}/{id}","href":"product-inventories/deleteproductinventory","openApiOperationId":"deleteProductInventory","summary":"Returns a product inventory from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product inventory was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The product inventory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The product inventory could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete product inventory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productInventories~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-inventories/deleteproductinventory"}],"panels":[]}]},"httpPath":"/productInventories/{tenantId}/{id}"},{"label":"Returns a product inventory from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-inventories/getproductinventory","routeSlug":"/apis/commerce/commerce-v1/product-inventories/getproductinventory","metadata":{"seo":{"title":"Returns a product inventory from the system by its ID.","description":"This method will look up a product inventory by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProductInventory","name":"Returns a product inventory from the system by its ID.","isWebhook":false,"pointer":"/paths/~1productInventories~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a product inventory from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a product inventory by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the product inventory to return.","required":true}],"pointer":"/paths/~1productInventories~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1productInventories~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/productInventories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/productInventories/{tenantId}/{id}","href":"product-inventories/getproductinventory","openApiOperationId":"getProductInventory","summary":"Returns a product inventory from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product inventory was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductInventory"}},"schemaId":"components/schemas/ProductInventory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The product inventory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve product inventory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productInventories~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductInventory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductInventory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-inventories/getproductinventory"}],"panels":[]}]},"httpPath":"/productInventories/{tenantId}/{id}"},{"label":"Partially updates a product inventory with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-inventories/patchproductinventory","routeSlug":"/apis/commerce/commerce-v1/product-inventories/patchproductinventory","metadata":{"seo":{"title":"Partially updates a product inventory with the specified ID.","description":"This method will patch an existing product inventory with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchProductInventory","name":"Partially updates a product inventory with the specified ID.","isWebhook":false,"pointer":"/paths/~1productInventories~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a product inventory with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing product inventory with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the product inventory to patch.","required":true}],"pointer":"/paths/~1productInventories~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1productInventories~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/productInventories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/productInventories/{tenantId}/{id}","href":"product-inventories/patchproductinventory","openApiOperationId":"patchProductInventory","summary":"Partially updates a product inventory with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product inventory was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductInventory"}},"schemaId":"components/schemas/ProductInventory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The product inventory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The product inventory could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve product inventory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productInventories~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductInventory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductInventory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-inventories/patchproductinventory"}],"panels":[]}]},"httpPath":"/productInventories/{tenantId}/{id}"},{"label":"Updates a product inventory with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-inventories/updateproductinventory","routeSlug":"/apis/commerce/commerce-v1/product-inventories/updateproductinventory","metadata":{"seo":{"title":"Updates a product inventory with the specified ID.","description":"This method will update an existing product inventory with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProductInventory","name":"Updates a product inventory with the specified ID.","isWebhook":false,"pointer":"/paths/~1productInventories~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a product inventory with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing product inventory with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the product inventory to update.","required":true}],"pointer":"/paths/~1productInventories~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProductInventory"}},"schemaId":"components/schemas/ProductInventory","pointer":"/paths/~1productInventories~1{tenantId}~1{id}/put/requestBody","description":"The updated product inventory that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/productInventories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProductInventory"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/productInventories/{tenantId}/{id}","href":"product-inventories/updateproductinventory","openApiOperationId":"updateProductInventory","summary":"Updates a product inventory with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ProductInventory","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProductInventory"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product inventory was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductInventory"}},"schemaId":"components/schemas/ProductInventory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The product inventory supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The product inventory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The product inventory could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve product inventory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1productInventories~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductInventory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductInventory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-inventories/updateproductinventory"}],"panels":[]}]},"httpPath":"/productInventories/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Product Inventories"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product Inventories","showPageActions":true},{"nodeType":"markdoc","content":"Product Inventories"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/productInventories/{tenantId}","summary":"Gets all of the product inventories in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-inventories/listproductinventories","deprecated":false},{"title":"/productInventories/{tenantId}","summary":"Creates a new product inventory record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/product-inventories/createproductinventory","deprecated":false},{"title":"/productInventories/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/product-inventories/executebatchoperations","deprecated":false},{"title":"/productInventories/{tenantId}/product/{product_type}/{product_id}","summary":"Returns a list of records with the specified product_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-inventories/listinventoriesbyproductid","deprecated":false},{"title":"/productInventories/{tenantId}/{id}","summary":"Returns a product inventory from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/product-inventories/deleteproductinventory","deprecated":false},{"title":"/productInventories/{tenantId}/{id}","summary":"Returns a product inventory from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-inventories/getproductinventory","deprecated":false},{"title":"/productInventories/{tenantId}/{id}","summary":"Partially updates a product inventory with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/product-inventories/patchproductinventory","deprecated":false},{"title":"/productInventories/{tenantId}/{id}","summary":"Updates a product inventory with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/product-inventories/updateproductinventory","deprecated":false}]}]}]}]}},{"type":"group","label":"Query Definitions","link":"/apis/commerce/commerce-v1/query-definitions","routeSlug":"/apis/commerce/commerce-v1/query-definitions","items":[{"label":"Returns a list of records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/query-definitions/getquerydefinitions","routeSlug":"/apis/commerce/commerce-v1/query-definitions/getquerydefinitions","metadata":{"seo":{"title":"Returns a list of records","description":"Returns a list of records"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQueryDefinitions","name":"Returns a list of records","isWebhook":false,"pointer":"/paths/~1queryDefinitions~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of records"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true}],"pointer":"/paths/~1queryDefinitions~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/queryDefinitions/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/queryDefinitions/{tenantId}","href":"query-definitions/getquerydefinitions","openApiOperationId":"getQueryDefinitions","summary":"Returns a list of records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStandardQueryDefinitionsResponse"}},"schemaId":"components/schemas/ListStandardQueryDefinitionsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1queryDefinitions~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListStandardQueryDefinitionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStandardQueryDefinitionsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/query-definitions/getquerydefinitions"}],"panels":[]}]},"httpPath":"/queryDefinitions/{tenantId}"}],"content":{"contentType":"group","meta":{"name":"Query Definitions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query Definitions","showPageActions":true},{"nodeType":"markdoc","content":"Query Definitions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/queryDefinitions/{tenantId}","summary":"Returns a list of records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/query-definitions/getquerydefinitions","deprecated":false}]}]}]}]}},{"type":"group","label":"Returns","link":"/apis/commerce/commerce-v1/returns","routeSlug":"/apis/commerce/commerce-v1/returns","items":[{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/returns/warmupstepfunctions","routeSlug":"/apis/commerce/commerce-v1/returns/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"warmUpStepFunctions","name":"Initiates workflow to warm up inventory transactions","isWebhook":false,"pointer":"/paths/~1returns~1warmUpStepFunctions/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates workflow to warm up inventory transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/returns/warmUpStepFunctions","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/returns/warmUpStepFunctions","href":"returns/warmupstepfunctions","openApiOperationId":"warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Request limit exceeded... please try your request again in a few seconds","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1returns~1warmUpStepFunctions/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/returns/warmupstepfunctions"}],"panels":[]}]},"httpPath":"/returns/warmUpStepFunctions"},{"label":"Processes a return","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/returns/processreturn","routeSlug":"/apis/commerce/commerce-v1/returns/processreturn","metadata":{"seo":{"title":"Processes a return","description":"This method will auto-generate an ID and create a new return. If an ID is specified for the return, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processReturn","name":"Processes a return","isWebhook":false,"pointer":"/paths/~1returns~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Processes a return","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new return. If an ID is specified for the return, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1returns~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Return"}},"schemaId":"components/schemas/Return","pointer":"/paths/~1returns~1{tenantId}/post/requestBody","description":"The return that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/returns/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Return"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/returns/{tenantId}","href":"returns/processreturn","openApiOperationId":"processReturn","summary":"Processes a return"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Return","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Return"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The return was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The return you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The return could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add return based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1returns~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/returns/processreturn"}],"panels":[]}]},"httpPath":"/returns/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/returns/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/returns/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1returns~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1returns~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1returns~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/returns/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/returns/{tenantId}/batch","href":"returns/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The return could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve return based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1returns~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/returns/executebatchoperations"}],"panels":[]}]},"httpPath":"/returns/{tenantId}/batch"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/returns/listreturnsbyorderid","routeSlug":"/apis/commerce/commerce-v1/returns/listreturnsbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listReturnsByOrderId","name":"Returns a list of records with the specified order_id","isWebhook":false,"pointer":"/paths/~1returns~1{tenantId}~1order~1{order_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified order_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified order_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"order_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1returns~1{tenantId}~1order~1{order_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1returns~1{tenantId}~1order~1{order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/returns/{tenantId}/order/{order_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/returns/{tenantId}/order/{order_id}","href":"returns/listreturnsbyorderid","openApiOperationId":"listReturnsByOrderId","summary":"Returns a list of records with the specified order_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListReturnsResponse"}},"schemaId":"components/schemas/ListReturnsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1returns~1{tenantId}~1order~1{order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListReturnsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListReturnsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/returns/listreturnsbyorderid"}],"panels":[]}]},"httpPath":"/returns/{tenantId}/order/{order_id}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/returns/previewemail","routeSlug":"/apis/commerce/commerce-v1/returns/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewEmail","name":"Sends out a preview of the CRC notification email","isWebhook":false,"pointer":"/paths/~1returns~1{tenantId}~1previewEmail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the CRC notification email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the CRC notification email"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true}],"pointer":"/paths/~1returns~1{tenantId}~1previewEmail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"schemaId":"components/schemas/PreviewEmailRequest","pointer":"/paths/~1returns~1{tenantId}~1previewEmail/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/returns/{tenantId}/previewEmail","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/returns/{tenantId}/previewEmail","href":"returns/previewemail","openApiOperationId":"previewEmail","summary":"Sends out a preview of the CRC notification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewEmailRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1returns~1{tenantId}~1previewEmail/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/returns/previewemail"}],"panels":[]}]},"httpPath":"/returns/{tenantId}/previewEmail"},{"label":"Processes a return","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/returns/processreturnsync","routeSlug":"/apis/commerce/commerce-v1/returns/processreturnsync","metadata":{"seo":{"title":"Processes a return","description":"This method will auto-generate an ID and create a new return. If an ID is specified for the return, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processReturnSync","name":"Processes a return","isWebhook":false,"pointer":"/paths/~1returns~1{tenantId}~1sync/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Processes a return","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new return. If an ID is specified for the return, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1returns~1{tenantId}~1sync/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Return"}},"schemaId":"components/schemas/Return","pointer":"/paths/~1returns~1{tenantId}~1sync/post/requestBody","description":"The return that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/returns/{tenantId}/sync","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Return"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/returns/{tenantId}/sync","href":"returns/processreturnsync","openApiOperationId":"processReturnSync","summary":"Processes a return"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Return","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Return"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The return was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Return"}},"schemaId":"components/schemas/Return","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The return you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The return could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add return based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1returns~1{tenantId}~1sync/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Return","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Return"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/returns/processreturnsync"}],"panels":[]}]},"httpPath":"/returns/{tenantId}/sync"},{"label":"Returns a return from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/returns/deletereturn","routeSlug":"/apis/commerce/commerce-v1/returns/deletereturn","metadata":{"seo":{"title":"Returns a return from the system by its ID.","description":"This method will delete a return with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteReturn","name":"Returns a return from the system by its ID.","isWebhook":false,"pointer":"/paths/~1returns~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a return from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a return with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the return to delete.","required":true}],"pointer":"/paths/~1returns~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/returns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/returns/{tenantId}/{id}","href":"returns/deletereturn","openApiOperationId":"deleteReturn","summary":"Returns a return from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The return was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The return could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The return could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete return based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1returns~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/returns/deletereturn"}],"panels":[]}]},"httpPath":"/returns/{tenantId}/{id}"},{"label":"Returns a return from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/returns/getreturn","routeSlug":"/apis/commerce/commerce-v1/returns/getreturn","metadata":{"seo":{"title":"Returns a return from the system by its ID.","description":"This method will look up a return by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReturn","name":"Returns a return from the system by its ID.","isWebhook":false,"pointer":"/paths/~1returns~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a return from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a return by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the return to return.","required":true}],"pointer":"/paths/~1returns~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1returns~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/returns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/returns/{tenantId}/{id}","href":"returns/getreturn","openApiOperationId":"getReturn","summary":"Returns a return from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The return was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Return"}},"schemaId":"components/schemas/Return","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The return could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve return based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1returns~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Return","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Return"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/returns/getreturn"}],"panels":[]}]},"httpPath":"/returns/{tenantId}/{id}"},{"label":"Partially updates a return with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/returns/patchreturn","routeSlug":"/apis/commerce/commerce-v1/returns/patchreturn","metadata":{"seo":{"title":"Partially updates a return with the specified ID.","description":"This method will patch an existing return with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchReturn","name":"Partially updates a return with the specified ID.","isWebhook":false,"pointer":"/paths/~1returns~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a return with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing return with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the return to patch.","required":true}],"pointer":"/paths/~1returns~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1returns~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/returns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/returns/{tenantId}/{id}","href":"returns/patchreturn","openApiOperationId":"patchReturn","summary":"Partially updates a return with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The return was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Return"}},"schemaId":"components/schemas/Return","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The return could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The return could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve return based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1returns~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Return","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Return"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/returns/patchreturn"}],"panels":[]}]},"httpPath":"/returns/{tenantId}/{id}"},{"label":"Updates a return with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/returns/updatereturn","routeSlug":"/apis/commerce/commerce-v1/returns/updatereturn","metadata":{"seo":{"title":"Updates a return with the specified ID.","description":"This method will update an existing return with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateReturn","name":"Updates a return with the specified ID.","isWebhook":false,"pointer":"/paths/~1returns~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a return with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing return with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the return to update.","required":true}],"pointer":"/paths/~1returns~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Return"}},"schemaId":"components/schemas/Return","pointer":"/paths/~1returns~1{tenantId}~1{id}/put/requestBody","description":"The updated return that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/returns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Return"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/returns/{tenantId}/{id}","href":"returns/updatereturn","openApiOperationId":"updateReturn","summary":"Updates a return with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Return","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Return"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The return was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Return"}},"schemaId":"components/schemas/Return","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The return supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The return could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The return could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve return based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1returns~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Return","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Return"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/returns/updatereturn"}],"panels":[]}]},"httpPath":"/returns/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Returns"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns","showPageActions":true},{"nodeType":"markdoc","content":"Returns"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/returns/warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/returns/warmupstepfunctions","deprecated":false},{"title":"/returns/{tenantId}","summary":"Processes a return","prefix":{"name":"post","color":"post"},"badges":[],"link":"/returns/processreturn","deprecated":false},{"title":"/returns/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/returns/executebatchoperations","deprecated":false},{"title":"/returns/{tenantId}/order/{order_id}","summary":"Returns a list of records with the specified order_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/returns/listreturnsbyorderid","deprecated":false},{"title":"/returns/{tenantId}/previewEmail","summary":"Sends out a preview of the CRC notification email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/returns/previewemail","deprecated":false},{"title":"/returns/{tenantId}/sync","summary":"Processes a return","prefix":{"name":"post","color":"post"},"badges":[],"link":"/returns/processreturnsync","deprecated":false},{"title":"/returns/{tenantId}/{id}","summary":"Returns a return from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/returns/deletereturn","deprecated":false},{"title":"/returns/{tenantId}/{id}","summary":"Returns a return from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/returns/getreturn","deprecated":false},{"title":"/returns/{tenantId}/{id}","summary":"Partially updates a return with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/returns/patchreturn","deprecated":false},{"title":"/returns/{tenantId}/{id}","summary":"Updates a return with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/returns/updatereturn","deprecated":false}]}]}]}]}},{"type":"group","label":"Settings","link":"/apis/commerce/commerce-v1/settings","routeSlug":"/apis/commerce/commerce-v1/settings","items":[{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/settings/deletesetting","routeSlug":"/apis/commerce/commerce-v1/settings/deletesetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will delete a setting with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSetting","name":"Returns a setting from the system by its ID.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a setting from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a setting with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/settings/{tenantId}","href":"settings/deletesetting","openApiOperationId":"deleteSetting","summary":"Returns a setting from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The setting could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1settings~1{tenantId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/deletesetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"},{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/settings/getsetting","routeSlug":"/apis/commerce/commerce-v1/settings/getsetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will look up a setting by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSetting","name":"Returns a setting from the system by its ID.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a setting from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a setting by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1settings~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/settings/{tenantId}","href":"settings/getsetting","openApiOperationId":"getSetting","summary":"Returns a setting from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1settings~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/getsetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"},{"label":"Partially updates a setting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/settings/patchsetting","routeSlug":"/apis/commerce/commerce-v1/settings/patchsetting","metadata":{"seo":{"title":"Partially updates a setting with the specified ID.","description":"This method will patch an existing setting with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchSetting","name":"Partially updates a setting with the specified ID.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a setting with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing setting with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1settings~1{tenantId}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/settings/{tenantId}","href":"settings/patchsetting","openApiOperationId":"patchSetting","summary":"Partially updates a setting with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The setting could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1settings~1{tenantId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/patchsetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"},{"label":"Creates a new setting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/settings/createsetting","routeSlug":"/apis/commerce/commerce-v1/settings/createsetting","metadata":{"seo":{"title":"Creates a new setting record that does not already exist.","description":"This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSetting","name":"Creates a new setting record that does not already exist.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new setting record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","pointer":"/paths/~1settings~1{tenantId}/post/requestBody","description":"The setting that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Setting"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/settings/{tenantId}","href":"settings/createsetting","openApiOperationId":"createSetting","summary":"Creates a new setting record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Setting"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The setting you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The setting could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1settings~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/createsetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"},{"label":"Updates a setting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/settings/updatesetting","routeSlug":"/apis/commerce/commerce-v1/settings/updatesetting","metadata":{"seo":{"title":"Updates a setting with the specified ID.","description":"This method will update an existing setting with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSetting","name":"Updates a setting with the specified ID.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a setting with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing setting with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","pointer":"/paths/~1settings~1{tenantId}/put/requestBody","description":"The updated setting that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Setting"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/settings/{tenantId}","href":"settings/updatesetting","openApiOperationId":"updateSetting","summary":"Updates a setting with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Setting"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The setting supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The setting could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1settings~1{tenantId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/updatesetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"}],"content":{"contentType":"group","meta":{"name":"Settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Settings","showPageActions":true},{"nodeType":"markdoc","content":"Settings"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/settings/{tenantId}","summary":"Returns a setting from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/settings/deletesetting","deprecated":false},{"title":"/settings/{tenantId}","summary":"Returns a setting from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settings/getsetting","deprecated":false},{"title":"/settings/{tenantId}","summary":"Partially updates a setting with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/settings/patchsetting","deprecated":false},{"title":"/settings/{tenantId}","summary":"Creates a new setting record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/settings/createsetting","deprecated":false},{"title":"/settings/{tenantId}","summary":"Updates a setting with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/settings/updatesetting","deprecated":false}]}]}]}]}},{"type":"group","label":"Shared Modifier Options","link":"/apis/commerce/commerce-v1/shared-modifier-options","routeSlug":"/apis/commerce/commerce-v1/shared-modifier-options","items":[{"label":"Gets all of the shared modifier options in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-modifier-options/listsharedmodifieroptions","routeSlug":"/apis/commerce/commerce-v1/shared-modifier-options/listsharedmodifieroptions","metadata":{"seo":{"title":"Gets all of the shared modifier options in the system.","description":"This method will scan all shared modifier options and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSharedModifierOptions","name":"Gets all of the shared modifier options in the system.","isWebhook":false,"pointer":"/paths/~1sharedModifierOptions~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the shared modifier options in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all shared modifier options and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1sharedModifierOptions~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1sharedModifierOptions~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sharedModifierOptions/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/sharedModifierOptions/{tenantId}","href":"shared-modifier-options/listsharedmodifieroptions","openApiOperationId":"listSharedModifierOptions","summary":"Gets all of the shared modifier options in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shared modifier optionswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_473"}},"schemaId":"schema_473","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1sharedModifierOptions~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_473","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_473"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shared-modifier-options/listsharedmodifieroptions"}],"panels":[]}]},"httpPath":"/sharedModifierOptions/{tenantId}"},{"label":"Creates a new shared modifier option record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-modifier-options/createsharedmodifieroption","routeSlug":"/apis/commerce/commerce-v1/shared-modifier-options/createsharedmodifieroption","metadata":{"seo":{"title":"Creates a new shared modifier option record that does not already exist.","description":"This method will auto-generate an ID and create a new shared modifier option. If an ID is specified for the shared modifier option, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSharedModifierOption","name":"Creates a new shared modifier option record that does not already exist.","isWebhook":false,"pointer":"/paths/~1sharedModifierOptions~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new shared modifier option record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new shared modifier option. If an ID is specified for the shared modifier option, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1sharedModifierOptions~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SharedModifierOption"}},"schemaId":"components/schemas/SharedModifierOption","pointer":"/paths/~1sharedModifierOptions~1{tenantId}/post/requestBody","description":"The shared modifier option that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sharedModifierOptions/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SharedModifierOption"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/sharedModifierOptions/{tenantId}","href":"shared-modifier-options/createsharedmodifieroption","openApiOperationId":"createSharedModifierOption","summary":"Creates a new shared modifier option record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/SharedModifierOption","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SharedModifierOption"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shared modifier option was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SharedModifierOption"}},"schemaId":"components/schemas/SharedModifierOption","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The shared modifier option you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The shared modifier option could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add shared modifier option based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1sharedModifierOptions~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SharedModifierOption","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SharedModifierOption"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shared-modifier-options/createsharedmodifieroption"}],"panels":[]}]},"httpPath":"/sharedModifierOptions/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-modifier-options/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/shared-modifier-options/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1sharedModifierOptions~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1sharedModifierOptions~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1sharedModifierOptions~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sharedModifierOptions/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/sharedModifierOptions/{tenantId}/batch","href":"shared-modifier-options/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shared modifier option could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve shared modifier option based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1sharedModifierOptions~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shared-modifier-options/executebatchoperations"}],"panels":[]}]},"httpPath":"/sharedModifierOptions/{tenantId}/batch"},{"label":"Returns a shared modifier option from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-modifier-options/deletesharedmodifieroption","routeSlug":"/apis/commerce/commerce-v1/shared-modifier-options/deletesharedmodifieroption","metadata":{"seo":{"title":"Returns a shared modifier option from the system by its ID.","description":"This method will delete a shared modifier option with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSharedModifierOption","name":"Returns a shared modifier option from the system by its ID.","isWebhook":false,"pointer":"/paths/~1sharedModifierOptions~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a shared modifier option from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a shared modifier option with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the shared modifier option to delete.","required":true}],"pointer":"/paths/~1sharedModifierOptions~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/sharedModifierOptions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/sharedModifierOptions/{tenantId}/{id}","href":"shared-modifier-options/deletesharedmodifieroption","openApiOperationId":"deleteSharedModifierOption","summary":"Returns a shared modifier option from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shared modifier option was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shared modifier option could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The shared modifier option could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete shared modifier option based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1sharedModifierOptions~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shared-modifier-options/deletesharedmodifieroption"}],"panels":[]}]},"httpPath":"/sharedModifierOptions/{tenantId}/{id}"},{"label":"Returns a shared modifier option from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-modifier-options/getsharedmodifieroption","routeSlug":"/apis/commerce/commerce-v1/shared-modifier-options/getsharedmodifieroption","metadata":{"seo":{"title":"Returns a shared modifier option from the system by its ID.","description":"This method will look up a shared modifier option by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSharedModifierOption","name":"Returns a shared modifier option from the system by its ID.","isWebhook":false,"pointer":"/paths/~1sharedModifierOptions~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a shared modifier option from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a shared modifier option by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the shared modifier option to return.","required":true}],"pointer":"/paths/~1sharedModifierOptions~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1sharedModifierOptions~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sharedModifierOptions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/sharedModifierOptions/{tenantId}/{id}","href":"shared-modifier-options/getsharedmodifieroption","openApiOperationId":"getSharedModifierOption","summary":"Returns a shared modifier option from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shared modifier option was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SharedModifierOption"}},"schemaId":"components/schemas/SharedModifierOption","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shared modifier option could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve shared modifier option based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1sharedModifierOptions~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SharedModifierOption","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SharedModifierOption"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shared-modifier-options/getsharedmodifieroption"}],"panels":[]}]},"httpPath":"/sharedModifierOptions/{tenantId}/{id}"},{"label":"Partially updates a shared modifier option with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-modifier-options/patchsharedmodifieroption","routeSlug":"/apis/commerce/commerce-v1/shared-modifier-options/patchsharedmodifieroption","metadata":{"seo":{"title":"Partially updates a shared modifier option with the specified ID.","description":"This method will patch an existing shared modifier option with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchSharedModifierOption","name":"Partially updates a shared modifier option with the specified ID.","isWebhook":false,"pointer":"/paths/~1sharedModifierOptions~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a shared modifier option with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing shared modifier option with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the shared modifier option to patch.","required":true}],"pointer":"/paths/~1sharedModifierOptions~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1sharedModifierOptions~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/sharedModifierOptions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/sharedModifierOptions/{tenantId}/{id}","href":"shared-modifier-options/patchsharedmodifieroption","openApiOperationId":"patchSharedModifierOption","summary":"Partially updates a shared modifier option with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shared modifier option was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SharedModifierOption"}},"schemaId":"components/schemas/SharedModifierOption","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shared modifier option could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The shared modifier option could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve shared modifier option based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1sharedModifierOptions~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SharedModifierOption","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SharedModifierOption"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shared-modifier-options/patchsharedmodifieroption"}],"panels":[]}]},"httpPath":"/sharedModifierOptions/{tenantId}/{id}"},{"label":"Updates a shared modifier option with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-modifier-options/updatesharedmodifieroption","routeSlug":"/apis/commerce/commerce-v1/shared-modifier-options/updatesharedmodifieroption","metadata":{"seo":{"title":"Updates a shared modifier option with the specified ID.","description":"This method will update an existing shared modifier option with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSharedModifierOption","name":"Updates a shared modifier option with the specified ID.","isWebhook":false,"pointer":"/paths/~1sharedModifierOptions~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a shared modifier option with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing shared modifier option with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the shared modifier option to update.","required":true}],"pointer":"/paths/~1sharedModifierOptions~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SharedModifierOption"}},"schemaId":"components/schemas/SharedModifierOption","pointer":"/paths/~1sharedModifierOptions~1{tenantId}~1{id}/put/requestBody","description":"The updated shared modifier option that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/sharedModifierOptions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SharedModifierOption"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/sharedModifierOptions/{tenantId}/{id}","href":"shared-modifier-options/updatesharedmodifieroption","openApiOperationId":"updateSharedModifierOption","summary":"Updates a shared modifier option with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/SharedModifierOption","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SharedModifierOption"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shared modifier option was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SharedModifierOption"}},"schemaId":"components/schemas/SharedModifierOption","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The shared modifier option supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shared modifier option could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The shared modifier option could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve shared modifier option based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1sharedModifierOptions~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SharedModifierOption","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SharedModifierOption"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shared-modifier-options/updatesharedmodifieroption"}],"panels":[]}]},"httpPath":"/sharedModifierOptions/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Shared Modifier Options"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shared Modifier Options","showPageActions":true},{"nodeType":"markdoc","content":"Shared Modifier Options"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/sharedModifierOptions/{tenantId}","summary":"Gets all of the shared modifier options in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shared-modifier-options/listsharedmodifieroptions","deprecated":false},{"title":"/sharedModifierOptions/{tenantId}","summary":"Creates a new shared modifier option record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shared-modifier-options/createsharedmodifieroption","deprecated":false},{"title":"/sharedModifierOptions/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shared-modifier-options/executebatchoperations","deprecated":false},{"title":"/sharedModifierOptions/{tenantId}/{id}","summary":"Returns a shared modifier option from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/shared-modifier-options/deletesharedmodifieroption","deprecated":false},{"title":"/sharedModifierOptions/{tenantId}/{id}","summary":"Returns a shared modifier option from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shared-modifier-options/getsharedmodifieroption","deprecated":false},{"title":"/sharedModifierOptions/{tenantId}/{id}","summary":"Partially updates a shared modifier option with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/shared-modifier-options/patchsharedmodifieroption","deprecated":false},{"title":"/sharedModifierOptions/{tenantId}/{id}","summary":"Updates a shared modifier option with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/shared-modifier-options/updatesharedmodifieroption","deprecated":false}]}]}]}]}},{"type":"group","label":"Shared Variant Options","link":"/apis/commerce/commerce-v1/shared-variant-options","routeSlug":"/apis/commerce/commerce-v1/shared-variant-options","items":[{"label":"Gets all of the shared variant options in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-variant-options/listsharedvariantoptions","routeSlug":"/apis/commerce/commerce-v1/shared-variant-options/listsharedvariantoptions","metadata":{"seo":{"title":"Gets all of the shared variant options in the system.","description":"This method will scan all shared variant options and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSharedVariantOptions","name":"Gets all of the shared variant options in the system.","isWebhook":false,"pointer":"/paths/~1sharedVariantOptions~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the shared variant options in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all shared variant options and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1sharedVariantOptions~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1sharedVariantOptions~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sharedVariantOptions/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/sharedVariantOptions/{tenantId}","href":"shared-variant-options/listsharedvariantoptions","openApiOperationId":"listSharedVariantOptions","summary":"Gets all of the shared variant options in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shared variant optionswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_474"}},"schemaId":"schema_474","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1sharedVariantOptions~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_474","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_474"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shared-variant-options/listsharedvariantoptions"}],"panels":[]}]},"httpPath":"/sharedVariantOptions/{tenantId}"},{"label":"Creates a new shared variant option record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-variant-options/createsharedvariantoption","routeSlug":"/apis/commerce/commerce-v1/shared-variant-options/createsharedvariantoption","metadata":{"seo":{"title":"Creates a new shared variant option record that does not already exist.","description":"This method will auto-generate an ID and create a new shared variant option. If an ID is specified for the shared variant option, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSharedVariantOption","name":"Creates a new shared variant option record that does not already exist.","isWebhook":false,"pointer":"/paths/~1sharedVariantOptions~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new shared variant option record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new shared variant option. If an ID is specified for the shared variant option, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1sharedVariantOptions~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SharedVariantOption"}},"schemaId":"components/schemas/SharedVariantOption","pointer":"/paths/~1sharedVariantOptions~1{tenantId}/post/requestBody","description":"The shared variant option that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sharedVariantOptions/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SharedVariantOption"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/sharedVariantOptions/{tenantId}","href":"shared-variant-options/createsharedvariantoption","openApiOperationId":"createSharedVariantOption","summary":"Creates a new shared variant option record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/SharedVariantOption","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SharedVariantOption"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shared variant option was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SharedVariantOption"}},"schemaId":"components/schemas/SharedVariantOption","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The shared variant option you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The shared variant option could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add shared variant option based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1sharedVariantOptions~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SharedVariantOption","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SharedVariantOption"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shared-variant-options/createsharedvariantoption"}],"panels":[]}]},"httpPath":"/sharedVariantOptions/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-variant-options/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/shared-variant-options/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1sharedVariantOptions~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1sharedVariantOptions~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1sharedVariantOptions~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sharedVariantOptions/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/sharedVariantOptions/{tenantId}/batch","href":"shared-variant-options/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shared variant option could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve shared variant option based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1sharedVariantOptions~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shared-variant-options/executebatchoperations"}],"panels":[]}]},"httpPath":"/sharedVariantOptions/{tenantId}/batch"},{"label":"Returns a shared variant option from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-variant-options/deletesharedvariantoption","routeSlug":"/apis/commerce/commerce-v1/shared-variant-options/deletesharedvariantoption","metadata":{"seo":{"title":"Returns a shared variant option from the system by its ID.","description":"This method will delete a shared variant option with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSharedVariantOption","name":"Returns a shared variant option from the system by its ID.","isWebhook":false,"pointer":"/paths/~1sharedVariantOptions~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a shared variant option from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a shared variant option with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the shared variant option to delete.","required":true}],"pointer":"/paths/~1sharedVariantOptions~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/sharedVariantOptions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/sharedVariantOptions/{tenantId}/{id}","href":"shared-variant-options/deletesharedvariantoption","openApiOperationId":"deleteSharedVariantOption","summary":"Returns a shared variant option from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shared variant option was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shared variant option could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The shared variant option could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete shared variant option based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1sharedVariantOptions~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shared-variant-options/deletesharedvariantoption"}],"panels":[]}]},"httpPath":"/sharedVariantOptions/{tenantId}/{id}"},{"label":"Returns a shared variant option from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-variant-options/getsharedvariantoption","routeSlug":"/apis/commerce/commerce-v1/shared-variant-options/getsharedvariantoption","metadata":{"seo":{"title":"Returns a shared variant option from the system by its ID.","description":"This method will look up a shared variant option by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSharedVariantOption","name":"Returns a shared variant option from the system by its ID.","isWebhook":false,"pointer":"/paths/~1sharedVariantOptions~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a shared variant option from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a shared variant option by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the shared variant option to return.","required":true}],"pointer":"/paths/~1sharedVariantOptions~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1sharedVariantOptions~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sharedVariantOptions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/sharedVariantOptions/{tenantId}/{id}","href":"shared-variant-options/getsharedvariantoption","openApiOperationId":"getSharedVariantOption","summary":"Returns a shared variant option from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shared variant option was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SharedVariantOption"}},"schemaId":"components/schemas/SharedVariantOption","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shared variant option could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve shared variant option based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1sharedVariantOptions~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SharedVariantOption","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SharedVariantOption"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shared-variant-options/getsharedvariantoption"}],"panels":[]}]},"httpPath":"/sharedVariantOptions/{tenantId}/{id}"},{"label":"Partially updates a shared variant option with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-variant-options/patchsharedvariantoption","routeSlug":"/apis/commerce/commerce-v1/shared-variant-options/patchsharedvariantoption","metadata":{"seo":{"title":"Partially updates a shared variant option with the specified ID.","description":"This method will patch an existing shared variant option with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchSharedVariantOption","name":"Partially updates a shared variant option with the specified ID.","isWebhook":false,"pointer":"/paths/~1sharedVariantOptions~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a shared variant option with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing shared variant option with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the shared variant option to patch.","required":true}],"pointer":"/paths/~1sharedVariantOptions~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1sharedVariantOptions~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/sharedVariantOptions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/sharedVariantOptions/{tenantId}/{id}","href":"shared-variant-options/patchsharedvariantoption","openApiOperationId":"patchSharedVariantOption","summary":"Partially updates a shared variant option with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shared variant option was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SharedVariantOption"}},"schemaId":"components/schemas/SharedVariantOption","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shared variant option could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The shared variant option could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve shared variant option based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1sharedVariantOptions~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SharedVariantOption","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SharedVariantOption"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shared-variant-options/patchsharedvariantoption"}],"panels":[]}]},"httpPath":"/sharedVariantOptions/{tenantId}/{id}"},{"label":"Updates a shared variant option with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-variant-options/updatesharedvariantoption","routeSlug":"/apis/commerce/commerce-v1/shared-variant-options/updatesharedvariantoption","metadata":{"seo":{"title":"Updates a shared variant option with the specified ID.","description":"This method will update an existing shared variant option with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSharedVariantOption","name":"Updates a shared variant option with the specified ID.","isWebhook":false,"pointer":"/paths/~1sharedVariantOptions~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a shared variant option with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing shared variant option with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the shared variant option to update.","required":true}],"pointer":"/paths/~1sharedVariantOptions~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SharedVariantOption"}},"schemaId":"components/schemas/SharedVariantOption","pointer":"/paths/~1sharedVariantOptions~1{tenantId}~1{id}/put/requestBody","description":"The updated shared variant option that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/sharedVariantOptions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SharedVariantOption"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/sharedVariantOptions/{tenantId}/{id}","href":"shared-variant-options/updatesharedvariantoption","openApiOperationId":"updateSharedVariantOption","summary":"Updates a shared variant option with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/SharedVariantOption","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SharedVariantOption"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shared variant option was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SharedVariantOption"}},"schemaId":"components/schemas/SharedVariantOption","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The shared variant option supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shared variant option could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The shared variant option could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve shared variant option based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1sharedVariantOptions~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SharedVariantOption","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SharedVariantOption"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shared-variant-options/updatesharedvariantoption"}],"panels":[]}]},"httpPath":"/sharedVariantOptions/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Shared Variant Options"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shared Variant Options","showPageActions":true},{"nodeType":"markdoc","content":"Shared Variant Options"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/sharedVariantOptions/{tenantId}","summary":"Gets all of the shared variant options in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shared-variant-options/listsharedvariantoptions","deprecated":false},{"title":"/sharedVariantOptions/{tenantId}","summary":"Creates a new shared variant option record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shared-variant-options/createsharedvariantoption","deprecated":false},{"title":"/sharedVariantOptions/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shared-variant-options/executebatchoperations","deprecated":false},{"title":"/sharedVariantOptions/{tenantId}/{id}","summary":"Returns a shared variant option from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/shared-variant-options/deletesharedvariantoption","deprecated":false},{"title":"/sharedVariantOptions/{tenantId}/{id}","summary":"Returns a shared variant option from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shared-variant-options/getsharedvariantoption","deprecated":false},{"title":"/sharedVariantOptions/{tenantId}/{id}","summary":"Partially updates a shared variant option with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/shared-variant-options/patchsharedvariantoption","deprecated":false},{"title":"/sharedVariantOptions/{tenantId}/{id}","summary":"Updates a shared variant option with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/shared-variant-options/updatesharedvariantoption","deprecated":false}]}]}]}]}},{"type":"group","label":"Shipments","link":"/apis/commerce/commerce-v1/shipments","routeSlug":"/apis/commerce/commerce-v1/shipments","items":[{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/warmupstepfunctions","routeSlug":"/apis/commerce/commerce-v1/shipments/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"warmUpStepFunctions","name":"Initiates workflow to warm up inventory transactions","isWebhook":false,"pointer":"/paths/~1shipments~1warmUpStepFunctions/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates workflow to warm up inventory transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/shipments/warmUpStepFunctions","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/shipments/warmUpStepFunctions","href":"shipments/warmupstepfunctions","openApiOperationId":"warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Request limit exceeded... please try your request again in a few seconds","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shipments~1warmUpStepFunctions/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipments/warmupstepfunctions"}],"panels":[]}]},"httpPath":"/shipments/warmUpStepFunctions"},{"label":"Processes a shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/processshipment","routeSlug":"/apis/commerce/commerce-v1/shipments/processshipment","metadata":{"seo":{"title":"Processes a shipment","description":"This method will auto-generate an ID and create a new shipment. If an ID is specified for the shipment, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processShipment","name":"Processes a shipment","isWebhook":false,"pointer":"/paths/~1shipments~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Processes a shipment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new shipment. If an ID is specified for the shipment, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1shipments~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Shipment"}},"schemaId":"components/schemas/Shipment","pointer":"/paths/~1shipments~1{tenantId}/post/requestBody","description":"The shipment that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/shipments/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Shipment"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/shipments/{tenantId}","href":"shipments/processshipment","openApiOperationId":"processShipment","summary":"Processes a shipment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Shipment","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Shipment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shipment was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The shipment you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The shipment could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add shipment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shipments~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipments/processshipment"}],"panels":[]}]},"httpPath":"/shipments/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/shipments/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1shipments~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1shipments~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1shipments~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/shipments/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/shipments/{tenantId}/batch","href":"shipments/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shipment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve shipment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shipments~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipments/executebatchoperations"}],"panels":[]}]},"httpPath":"/shipments/{tenantId}/batch"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/listshipmentsbyorderid","routeSlug":"/apis/commerce/commerce-v1/shipments/listshipmentsbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listShipmentsByOrderId","name":"Returns a list of records with the specified order_id","isWebhook":false,"pointer":"/paths/~1shipments~1{tenantId}~1order~1{order_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified order_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified order_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"order_id","in":"path","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1shipments~1{tenantId}~1order~1{order_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1shipments~1{tenantId}~1order~1{order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/shipments/{tenantId}/order/{order_id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/shipments/{tenantId}/order/{order_id}","href":"shipments/listshipmentsbyorderid","openApiOperationId":"listShipmentsByOrderId","summary":"Returns a list of records with the specified order_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListShipmentsResponse"}},"schemaId":"components/schemas/ListShipmentsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shipments~1{tenantId}~1order~1{order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListShipmentsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListShipmentsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipments/listshipmentsbyorderid"}],"panels":[]}]},"httpPath":"/shipments/{tenantId}/order/{order_id}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/previewemail","routeSlug":"/apis/commerce/commerce-v1/shipments/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewEmail","name":"Sends out a preview of the CRC notification email","isWebhook":false,"pointer":"/paths/~1shipments~1{tenantId}~1previewEmail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the CRC notification email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the CRC notification email"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true}],"pointer":"/paths/~1shipments~1{tenantId}~1previewEmail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"schemaId":"components/schemas/PreviewEmailRequest","pointer":"/paths/~1shipments~1{tenantId}~1previewEmail/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/shipments/{tenantId}/previewEmail","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/shipments/{tenantId}/previewEmail","href":"shipments/previewemail","openApiOperationId":"previewEmail","summary":"Sends out a preview of the CRC notification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewEmailRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shipments~1{tenantId}~1previewEmail/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipments/previewemail"}],"panels":[]}]},"httpPath":"/shipments/{tenantId}/previewEmail"},{"label":"Gets all of the shipments in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/listshipments","routeSlug":"/apis/commerce/commerce-v1/shipments/listshipments","metadata":{"seo":{"title":"Gets all of the shipments in the system.","description":"This method will scan all shipments and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listShipments","name":"Gets all of the shipments in the system.","isWebhook":false,"pointer":"/paths/~1shipments~1{tenantId}~1sync/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the shipments in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all shipments and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1shipments~1{tenantId}~1sync/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1shipments~1{tenantId}~1sync/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/shipments/{tenantId}/sync","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/shipments/{tenantId}/sync","href":"shipments/listshipments","openApiOperationId":"listShipments","summary":"Gets all of the shipments in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shipmentswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_475"}},"schemaId":"schema_475","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shipments~1{tenantId}~1sync/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_475","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_475"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipments/listshipments"}],"panels":[]}]},"httpPath":"/shipments/{tenantId}/sync"},{"label":"Processes a shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/processshipmentsync","routeSlug":"/apis/commerce/commerce-v1/shipments/processshipmentsync","metadata":{"seo":{"title":"Processes a shipment","description":"This method will auto-generate an ID and create a new shipment. If an ID is specified for the shipment, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processShipmentSync","name":"Processes a shipment","isWebhook":false,"pointer":"/paths/~1shipments~1{tenantId}~1sync/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Processes a shipment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new shipment. If an ID is specified for the shipment, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1shipments~1{tenantId}~1sync/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Shipment"}},"schemaId":"components/schemas/Shipment","pointer":"/paths/~1shipments~1{tenantId}~1sync/post/requestBody","description":"The shipment that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/shipments/{tenantId}/sync","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Shipment"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/shipments/{tenantId}/sync","href":"shipments/processshipmentsync","openApiOperationId":"processShipmentSync","summary":"Processes a shipment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Shipment","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Shipment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shipment was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Shipment"}},"schemaId":"components/schemas/Shipment","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The shipment you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The shipment could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add shipment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shipments~1{tenantId}~1sync/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Shipment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Shipment"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipments/processshipmentsync"}],"panels":[]}]},"httpPath":"/shipments/{tenantId}/sync"},{"label":"Returns a shipment from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/deleteshipment","routeSlug":"/apis/commerce/commerce-v1/shipments/deleteshipment","metadata":{"seo":{"title":"Returns a shipment from the system by its ID.","description":"This method will delete a shipment with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteShipment","name":"Returns a shipment from the system by its ID.","isWebhook":false,"pointer":"/paths/~1shipments~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a shipment from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a shipment with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the shipment to delete.","required":true}],"pointer":"/paths/~1shipments~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/shipments/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/shipments/{tenantId}/{id}","href":"shipments/deleteshipment","openApiOperationId":"deleteShipment","summary":"Returns a shipment from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shipment was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shipment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The shipment could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete shipment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shipments~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipments/deleteshipment"}],"panels":[]}]},"httpPath":"/shipments/{tenantId}/{id}"},{"label":"Returns a shipment from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/getshipment","routeSlug":"/apis/commerce/commerce-v1/shipments/getshipment","metadata":{"seo":{"title":"Returns a shipment from the system by its ID.","description":"This method will look up a shipment by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShipment","name":"Returns a shipment from the system by its ID.","isWebhook":false,"pointer":"/paths/~1shipments~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a shipment from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a shipment by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the shipment to return.","required":true}],"pointer":"/paths/~1shipments~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1shipments~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/shipments/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/shipments/{tenantId}/{id}","href":"shipments/getshipment","openApiOperationId":"getShipment","summary":"Returns a shipment from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shipment was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Shipment"}},"schemaId":"components/schemas/Shipment","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shipment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve shipment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shipments~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Shipment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Shipment"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipments/getshipment"}],"panels":[]}]},"httpPath":"/shipments/{tenantId}/{id}"},{"label":"Partially updates a shipment with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/patchshipment","routeSlug":"/apis/commerce/commerce-v1/shipments/patchshipment","metadata":{"seo":{"title":"Partially updates a shipment with the specified ID.","description":"This method will patch an existing shipment with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchShipment","name":"Partially updates a shipment with the specified ID.","isWebhook":false,"pointer":"/paths/~1shipments~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a shipment with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing shipment with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the shipment to patch.","required":true}],"pointer":"/paths/~1shipments~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1shipments~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/shipments/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/shipments/{tenantId}/{id}","href":"shipments/patchshipment","openApiOperationId":"patchShipment","summary":"Partially updates a shipment with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shipment was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Shipment"}},"schemaId":"components/schemas/Shipment","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shipment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The shipment could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve shipment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shipments~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Shipment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Shipment"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipments/patchshipment"}],"panels":[]}]},"httpPath":"/shipments/{tenantId}/{id}"},{"label":"Updates a shipment with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/updateshipment","routeSlug":"/apis/commerce/commerce-v1/shipments/updateshipment","metadata":{"seo":{"title":"Updates a shipment with the specified ID.","description":"This method will update an existing shipment with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateShipment","name":"Updates a shipment with the specified ID.","isWebhook":false,"pointer":"/paths/~1shipments~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a shipment with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing shipment with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the shipment to update.","required":true}],"pointer":"/paths/~1shipments~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Shipment"}},"schemaId":"components/schemas/Shipment","pointer":"/paths/~1shipments~1{tenantId}~1{id}/put/requestBody","description":"The updated shipment that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/shipments/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Shipment"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/shipments/{tenantId}/{id}","href":"shipments/updateshipment","openApiOperationId":"updateShipment","summary":"Updates a shipment with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Shipment","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Shipment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shipment was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Shipment"}},"schemaId":"components/schemas/Shipment","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The shipment supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shipment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The shipment could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve shipment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shipments~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Shipment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Shipment"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipments/updateshipment"}],"panels":[]}]},"httpPath":"/shipments/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Shipments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shipments","showPageActions":true},{"nodeType":"markdoc","content":"Shipments"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/shipments/warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipments/warmupstepfunctions","deprecated":false},{"title":"/shipments/{tenantId}","summary":"Processes a shipment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipments/processshipment","deprecated":false},{"title":"/shipments/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipments/executebatchoperations","deprecated":false},{"title":"/shipments/{tenantId}/order/{order_id}","summary":"Returns a list of records with the specified order_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipments/listshipmentsbyorderid","deprecated":false},{"title":"/shipments/{tenantId}/previewEmail","summary":"Sends out a preview of the CRC notification email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipments/previewemail","deprecated":false},{"title":"/shipments/{tenantId}/sync","summary":"Gets all of the shipments in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipments/listshipments","deprecated":false},{"title":"/shipments/{tenantId}/sync","summary":"Processes a shipment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipments/processshipmentsync","deprecated":false},{"title":"/shipments/{tenantId}/{id}","summary":"Returns a shipment from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/shipments/deleteshipment","deprecated":false},{"title":"/shipments/{tenantId}/{id}","summary":"Returns a shipment from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipments/getshipment","deprecated":false},{"title":"/shipments/{tenantId}/{id}","summary":"Partially updates a shipment with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/shipments/patchshipment","deprecated":false},{"title":"/shipments/{tenantId}/{id}","summary":"Updates a shipment with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/shipments/updateshipment","deprecated":false}]}]}]}]}},{"type":"group","label":"Shipping Configurations","link":"/apis/commerce/commerce-v1/shipping-configurations","routeSlug":"/apis/commerce/commerce-v1/shipping-configurations","items":[{"label":"Returns a shipping configuration from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-configurations/deleteshippingconfiguration","routeSlug":"/apis/commerce/commerce-v1/shipping-configurations/deleteshippingconfiguration","metadata":{"seo":{"title":"Returns a shipping configuration from the system by its ID.","description":"This method will delete a shipping configuration with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteShippingConfiguration","name":"Returns a shipping configuration from the system by its ID.","isWebhook":false,"pointer":"/paths/~1shippingConfigurations~1{tenantId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a shipping configuration from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a shipping configuration with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1shippingConfigurations~1{tenantId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/shippingConfigurations/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/shippingConfigurations/{tenantId}","href":"shipping-configurations/deleteshippingconfiguration","openApiOperationId":"deleteShippingConfiguration","summary":"Returns a shipping configuration from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shipping configuration was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shipping configuration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The shipping configuration could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete shipping configuration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shippingConfigurations~1{tenantId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-configurations/deleteshippingconfiguration"}],"panels":[]}]},"httpPath":"/shippingConfigurations/{tenantId}"},{"label":"Returns a shipping configuration from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-configurations/getshippingconfiguration","routeSlug":"/apis/commerce/commerce-v1/shipping-configurations/getshippingconfiguration","metadata":{"seo":{"title":"Returns a shipping configuration from the system by its ID.","description":"This method will look up a shipping configuration by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShippingConfiguration","name":"Returns a shipping configuration from the system by its ID.","isWebhook":false,"pointer":"/paths/~1shippingConfigurations~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a shipping configuration from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a shipping configuration by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1shippingConfigurations~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1shippingConfigurations~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/shippingConfigurations/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/shippingConfigurations/{tenantId}","href":"shipping-configurations/getshippingconfiguration","openApiOperationId":"getShippingConfiguration","summary":"Returns a shipping configuration from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shipping configuration was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingConfiguration"}},"schemaId":"components/schemas/ShippingConfiguration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shipping configuration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve shipping configuration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shippingConfigurations~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShippingConfiguration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingConfiguration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-configurations/getshippingconfiguration"}],"panels":[]}]},"httpPath":"/shippingConfigurations/{tenantId}"},{"label":"Partially updates a shipping configuration with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-configurations/patchshippingconfiguration","routeSlug":"/apis/commerce/commerce-v1/shipping-configurations/patchshippingconfiguration","metadata":{"seo":{"title":"Partially updates a shipping configuration with the specified ID.","description":"This method will patch an existing shipping configuration with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchShippingConfiguration","name":"Partially updates a shipping configuration with the specified ID.","isWebhook":false,"pointer":"/paths/~1shippingConfigurations~1{tenantId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a shipping configuration with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing shipping configuration with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1shippingConfigurations~1{tenantId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1shippingConfigurations~1{tenantId}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/shippingConfigurations/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/shippingConfigurations/{tenantId}","href":"shipping-configurations/patchshippingconfiguration","openApiOperationId":"patchShippingConfiguration","summary":"Partially updates a shipping configuration with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shipping configuration was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingConfiguration"}},"schemaId":"components/schemas/ShippingConfiguration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shipping configuration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The shipping configuration could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve shipping configuration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shippingConfigurations~1{tenantId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShippingConfiguration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingConfiguration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-configurations/patchshippingconfiguration"}],"panels":[]}]},"httpPath":"/shippingConfigurations/{tenantId}"},{"label":"Creates a new shipping configuration record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-configurations/createshippingconfiguration","routeSlug":"/apis/commerce/commerce-v1/shipping-configurations/createshippingconfiguration","metadata":{"seo":{"title":"Creates a new shipping configuration record that does not already exist.","description":"This method will auto-generate an ID and create a new shipping configuration. If an ID is specified for the shipping configuration, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createShippingConfiguration","name":"Creates a new shipping configuration record that does not already exist.","isWebhook":false,"pointer":"/paths/~1shippingConfigurations~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new shipping configuration record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new shipping configuration. If an ID is specified for the shipping configuration, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1shippingConfigurations~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShippingConfiguration"}},"schemaId":"components/schemas/ShippingConfiguration","pointer":"/paths/~1shippingConfigurations~1{tenantId}/post/requestBody","description":"The shipping configuration that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/shippingConfigurations/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShippingConfiguration"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/shippingConfigurations/{tenantId}","href":"shipping-configurations/createshippingconfiguration","openApiOperationId":"createShippingConfiguration","summary":"Creates a new shipping configuration record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ShippingConfiguration","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShippingConfiguration"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shipping configuration was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingConfiguration"}},"schemaId":"components/schemas/ShippingConfiguration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The shipping configuration you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The shipping configuration could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add shipping configuration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shippingConfigurations~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShippingConfiguration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingConfiguration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-configurations/createshippingconfiguration"}],"panels":[]}]},"httpPath":"/shippingConfigurations/{tenantId}"},{"label":"Updates a shipping configuration with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-configurations/updateshippingconfiguration","routeSlug":"/apis/commerce/commerce-v1/shipping-configurations/updateshippingconfiguration","metadata":{"seo":{"title":"Updates a shipping configuration with the specified ID.","description":"This method will update an existing shipping configuration with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateShippingConfiguration","name":"Updates a shipping configuration with the specified ID.","isWebhook":false,"pointer":"/paths/~1shippingConfigurations~1{tenantId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a shipping configuration with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing shipping configuration with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1shippingConfigurations~1{tenantId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShippingConfiguration"}},"schemaId":"components/schemas/ShippingConfiguration","pointer":"/paths/~1shippingConfigurations~1{tenantId}/put/requestBody","description":"The updated shipping configuration that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/shippingConfigurations/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShippingConfiguration"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/shippingConfigurations/{tenantId}","href":"shipping-configurations/updateshippingconfiguration","openApiOperationId":"updateShippingConfiguration","summary":"Updates a shipping configuration with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ShippingConfiguration","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShippingConfiguration"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shipping configuration was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingConfiguration"}},"schemaId":"components/schemas/ShippingConfiguration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The shipping configuration supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shipping configuration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The shipping configuration could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve shipping configuration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shippingConfigurations~1{tenantId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShippingConfiguration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingConfiguration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-configurations/updateshippingconfiguration"}],"panels":[]}]},"httpPath":"/shippingConfigurations/{tenantId}"}],"content":{"contentType":"group","meta":{"name":"Shipping Configurations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shipping Configurations","showPageActions":true},{"nodeType":"markdoc","content":"Shipping Configurations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/shippingConfigurations/{tenantId}","summary":"Returns a shipping configuration from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/shipping-configurations/deleteshippingconfiguration","deprecated":false},{"title":"/shippingConfigurations/{tenantId}","summary":"Returns a shipping configuration from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipping-configurations/getshippingconfiguration","deprecated":false},{"title":"/shippingConfigurations/{tenantId}","summary":"Partially updates a shipping configuration with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/shipping-configurations/patchshippingconfiguration","deprecated":false},{"title":"/shippingConfigurations/{tenantId}","summary":"Creates a new shipping configuration record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipping-configurations/createshippingconfiguration","deprecated":false},{"title":"/shippingConfigurations/{tenantId}","summary":"Updates a shipping configuration with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/shipping-configurations/updateshippingconfiguration","deprecated":false}]}]}]}]}},{"type":"group","label":"Shipping Products","link":"/apis/commerce/commerce-v1/shipping-products","routeSlug":"/apis/commerce/commerce-v1/shipping-products","items":[{"label":"Gets all of the shipping products in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-products/listshippingproducts","routeSlug":"/apis/commerce/commerce-v1/shipping-products/listshippingproducts","metadata":{"seo":{"title":"Gets all of the shipping products in the system.","description":"This method will scan all shipping products and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listShippingProducts","name":"Gets all of the shipping products in the system.","isWebhook":false,"pointer":"/paths/~1shippingProducts~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the shipping products in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all shipping products and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1shippingProducts~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1shippingProducts~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/shippingProducts/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/shippingProducts/{tenantId}","href":"shipping-products/listshippingproducts","openApiOperationId":"listShippingProducts","summary":"Gets all of the shipping products in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shipping productswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_476"}},"schemaId":"schema_476","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shippingProducts~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_476","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_476"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-products/listshippingproducts"}],"panels":[]}]},"httpPath":"/shippingProducts/{tenantId}"},{"label":"Creates a new shipping product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-products/createshippingproduct","routeSlug":"/apis/commerce/commerce-v1/shipping-products/createshippingproduct","metadata":{"seo":{"title":"Creates a new shipping product record that does not already exist.","description":"This method will auto-generate an ID and create a new shipping product. If an ID is specified for the shipping product, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createShippingProduct","name":"Creates a new shipping product record that does not already exist.","isWebhook":false,"pointer":"/paths/~1shippingProducts~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new shipping product record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new shipping product. If an ID is specified for the shipping product, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1shippingProducts~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShippingProduct"}},"schemaId":"components/schemas/ShippingProduct","pointer":"/paths/~1shippingProducts~1{tenantId}/post/requestBody","description":"The shipping product that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/shippingProducts/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShippingProduct"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/shippingProducts/{tenantId}","href":"shipping-products/createshippingproduct","openApiOperationId":"createShippingProduct","summary":"Creates a new shipping product record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ShippingProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShippingProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shipping product was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingProduct"}},"schemaId":"components/schemas/ShippingProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The shipping product you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The shipping product could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add shipping product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shippingProducts~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShippingProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-products/createshippingproduct"}],"panels":[]}]},"httpPath":"/shippingProducts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-products/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/shipping-products/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1shippingProducts~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1shippingProducts~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1shippingProducts~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/shippingProducts/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/shippingProducts/{tenantId}/batch","href":"shipping-products/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shipping product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve shipping product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shippingProducts~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-products/executebatchoperations"}],"panels":[]}]},"httpPath":"/shippingProducts/{tenantId}/batch"},{"label":"Returns a shipping product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-products/deleteshippingproduct","routeSlug":"/apis/commerce/commerce-v1/shipping-products/deleteshippingproduct","metadata":{"seo":{"title":"Returns a shipping product from the system by its ID.","description":"This method will delete a shipping product with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteShippingProduct","name":"Returns a shipping product from the system by its ID.","isWebhook":false,"pointer":"/paths/~1shippingProducts~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a shipping product from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a shipping product with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the shipping product to delete.","required":true}],"pointer":"/paths/~1shippingProducts~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/shippingProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/shippingProducts/{tenantId}/{id}","href":"shipping-products/deleteshippingproduct","openApiOperationId":"deleteShippingProduct","summary":"Returns a shipping product from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shipping product was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shipping product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The shipping product could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete shipping product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shippingProducts~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-products/deleteshippingproduct"}],"panels":[]}]},"httpPath":"/shippingProducts/{tenantId}/{id}"},{"label":"Returns a shipping product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-products/getshippingproduct","routeSlug":"/apis/commerce/commerce-v1/shipping-products/getshippingproduct","metadata":{"seo":{"title":"Returns a shipping product from the system by its ID.","description":"This method will look up a shipping product by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShippingProduct","name":"Returns a shipping product from the system by its ID.","isWebhook":false,"pointer":"/paths/~1shippingProducts~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a shipping product from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a shipping product by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the shipping product to return.","required":true}],"pointer":"/paths/~1shippingProducts~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1shippingProducts~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/shippingProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/shippingProducts/{tenantId}/{id}","href":"shipping-products/getshippingproduct","openApiOperationId":"getShippingProduct","summary":"Returns a shipping product from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shipping product was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingProduct"}},"schemaId":"components/schemas/ShippingProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shipping product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve shipping product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shippingProducts~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShippingProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-products/getshippingproduct"}],"panels":[]}]},"httpPath":"/shippingProducts/{tenantId}/{id}"},{"label":"Partially updates a shipping product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-products/patchshippingproduct","routeSlug":"/apis/commerce/commerce-v1/shipping-products/patchshippingproduct","metadata":{"seo":{"title":"Partially updates a shipping product with the specified ID.","description":"This method will patch an existing shipping product with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchShippingProduct","name":"Partially updates a shipping product with the specified ID.","isWebhook":false,"pointer":"/paths/~1shippingProducts~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a shipping product with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing shipping product with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the shipping product to patch.","required":true}],"pointer":"/paths/~1shippingProducts~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1shippingProducts~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/shippingProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/shippingProducts/{tenantId}/{id}","href":"shipping-products/patchshippingproduct","openApiOperationId":"patchShippingProduct","summary":"Partially updates a shipping product with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shipping product was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingProduct"}},"schemaId":"components/schemas/ShippingProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shipping product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The shipping product could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve shipping product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shippingProducts~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShippingProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-products/patchshippingproduct"}],"panels":[]}]},"httpPath":"/shippingProducts/{tenantId}/{id}"},{"label":"Updates a shipping product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-products/updateshippingproduct","routeSlug":"/apis/commerce/commerce-v1/shipping-products/updateshippingproduct","metadata":{"seo":{"title":"Updates a shipping product with the specified ID.","description":"This method will update an existing shipping product with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateShippingProduct","name":"Updates a shipping product with the specified ID.","isWebhook":false,"pointer":"/paths/~1shippingProducts~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a shipping product with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing shipping product with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the shipping product to update.","required":true}],"pointer":"/paths/~1shippingProducts~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShippingProduct"}},"schemaId":"components/schemas/ShippingProduct","pointer":"/paths/~1shippingProducts~1{tenantId}~1{id}/put/requestBody","description":"The updated shipping product that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/shippingProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShippingProduct"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/shippingProducts/{tenantId}/{id}","href":"shipping-products/updateshippingproduct","openApiOperationId":"updateShippingProduct","summary":"Updates a shipping product with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ShippingProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShippingProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The shipping product was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingProduct"}},"schemaId":"components/schemas/ShippingProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The shipping product supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The shipping product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The shipping product could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve shipping product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1shippingProducts~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShippingProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShippingProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-products/updateshippingproduct"}],"panels":[]}]},"httpPath":"/shippingProducts/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Shipping Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shipping Products","showPageActions":true},{"nodeType":"markdoc","content":"Shipping Products"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/shippingProducts/{tenantId}","summary":"Gets all of the shipping products in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipping-products/listshippingproducts","deprecated":false},{"title":"/shippingProducts/{tenantId}","summary":"Creates a new shipping product record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipping-products/createshippingproduct","deprecated":false},{"title":"/shippingProducts/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipping-products/executebatchoperations","deprecated":false},{"title":"/shippingProducts/{tenantId}/{id}","summary":"Returns a shipping product from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/shipping-products/deleteshippingproduct","deprecated":false},{"title":"/shippingProducts/{tenantId}/{id}","summary":"Returns a shipping product from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipping-products/getshippingproduct","deprecated":false},{"title":"/shippingProducts/{tenantId}/{id}","summary":"Partially updates a shipping product with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/shipping-products/patchshippingproduct","deprecated":false},{"title":"/shippingProducts/{tenantId}/{id}","summary":"Updates a shipping product with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/shipping-products/updateshippingproduct","deprecated":false}]}]}]}]}},{"type":"group","label":"Statistics","link":"/apis/commerce/commerce-v1/statistics","routeSlug":"/apis/commerce/commerce-v1/statistics","items":[{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/statistics/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/statistics/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1statistics~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1statistics~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1statistics~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/statistics/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statistics/{tenantId}/batch","href":"statistics/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The statistic could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve statistic based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1statistics~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statistics/executebatchoperations"}],"panels":[]}]},"httpPath":"/statistics/{tenantId}/batch"},{"label":"Returns a statistic from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/statistics/getstatistic","routeSlug":"/apis/commerce/commerce-v1/statistics/getstatistic","metadata":{"seo":{"title":"Returns a statistic from the system by its ID.","description":"This method will look up a statistic by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStatistic","name":"Returns a statistic from the system by its ID.","isWebhook":false,"pointer":"/paths/~1statistics~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a statistic from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a statistic by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the statistic to return.","required":true}],"pointer":"/paths/~1statistics~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"parameters","in":"query","schemaId":"schema_459","description":"Parameters to the query"},{"name":"recalculate","in":"query","schemaId":"schema_477","description":"If true, the latest statistic will be calculated and the cache will be updated"}],"pointer":"/paths/~1statistics~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/statistics/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"parameters","in":"query","required":false,"schemaId":"schema_459"},{"name":"recalculate","in":"query","required":false,"schemaId":"schema_477"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statistics/{tenantId}/{id}","href":"statistics/getstatistic","openApiOperationId":"getStatistic","summary":"Returns a statistic from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The statistic was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statistic"}},"schemaId":"components/schemas/Statistic","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The statistic could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve statistic based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1statistics~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Statistic","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statistic"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statistics/getstatistic"}],"panels":[]}]},"httpPath":"/statistics/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Statistics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Statistics","showPageActions":true},{"nodeType":"markdoc","content":"Statistics"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/statistics/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/statistics/executebatchoperations","deprecated":false},{"title":"/statistics/{tenantId}/{id}","summary":"Returns a statistic from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statistics/getstatistic","deprecated":false}]}]}]}]}},{"type":"group","label":"Stores","link":"/apis/commerce/commerce-v1/stores","routeSlug":"/apis/commerce/commerce-v1/stores","items":[{"label":"Gets all of the stores in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/stores/liststores","routeSlug":"/apis/commerce/commerce-v1/stores/liststores","metadata":{"seo":{"title":"Gets all of the stores in the system.","description":"This method will scan all stores and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listStores","name":"Gets all of the stores in the system.","isWebhook":false,"pointer":"/paths/~1stores~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the stores in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all stores and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1stores~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1stores~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/stores/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/stores/{tenantId}","href":"stores/liststores","openApiOperationId":"listStores","summary":"Gets all of the stores in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The storeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_478"}},"schemaId":"schema_478","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1stores~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_478","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_478"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stores/liststores"}],"panels":[]}]},"httpPath":"/stores/{tenantId}"},{"label":"Creates a new store record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/stores/createstore","routeSlug":"/apis/commerce/commerce-v1/stores/createstore","metadata":{"seo":{"title":"Creates a new store record that does not already exist.","description":"This method will auto-generate an ID and create a new store. If an ID is specified for the store, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createStore","name":"Creates a new store record that does not already exist.","isWebhook":false,"pointer":"/paths/~1stores~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new store record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new store. If an ID is specified for the store, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1stores~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Store"}},"schemaId":"components/schemas/Store","pointer":"/paths/~1stores~1{tenantId}/post/requestBody","description":"The store that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/stores/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Store"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/stores/{tenantId}","href":"stores/createstore","openApiOperationId":"createStore","summary":"Creates a new store record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Store","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Store"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The store was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Store"}},"schemaId":"components/schemas/Store","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The store you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The store could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add store based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1stores~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Store","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Store"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stores/createstore"}],"panels":[]}]},"httpPath":"/stores/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/stores/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/stores/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1stores~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1stores~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1stores~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/stores/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/stores/{tenantId}/batch","href":"stores/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The store could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve store based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1stores~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stores/executebatchoperations"}],"panels":[]}]},"httpPath":"/stores/{tenantId}/batch"},{"label":"Gets the public store info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/stores/getpublicstoreinfo","routeSlug":"/apis/commerce/commerce-v1/stores/getpublicstoreinfo","metadata":{"seo":{"title":"Gets the public store info","description":"Gets the public store info"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPublicStoreInfo","name":"Gets the public store info","isWebhook":false,"pointer":"/paths/~1stores~1{tenantId}~1public~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the public store info","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the public store info"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The tenant","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The id of the store","required":true}],"pointer":"/paths/~1stores~1{tenantId}~1public~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/stores/{tenantId}/public/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/stores/{tenantId}/public/{id}","href":"stores/getpublicstoreinfo","openApiOperationId":"getPublicStoreInfo","summary":"Gets the public store info"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The store was retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StorePublic"}},"schemaId":"components/schemas/StorePublic","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1stores~1{tenantId}~1public~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StorePublic","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StorePublic"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stores/getpublicstoreinfo"}],"panels":[]}]},"httpPath":"/stores/{tenantId}/public/{id}"},{"label":"Returns a store from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/stores/deletestore","routeSlug":"/apis/commerce/commerce-v1/stores/deletestore","metadata":{"seo":{"title":"Returns a store from the system by its ID.","description":"This method will delete a store with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteStore","name":"Returns a store from the system by its ID.","isWebhook":false,"pointer":"/paths/~1stores~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a store from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a store with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the store to delete.","required":true}],"pointer":"/paths/~1stores~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/stores/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/stores/{tenantId}/{id}","href":"stores/deletestore","openApiOperationId":"deleteStore","summary":"Returns a store from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The store was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The store could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The store could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete store based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1stores~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stores/deletestore"}],"panels":[]}]},"httpPath":"/stores/{tenantId}/{id}"},{"label":"Returns a store from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/stores/getstore","routeSlug":"/apis/commerce/commerce-v1/stores/getstore","metadata":{"seo":{"title":"Returns a store from the system by its ID.","description":"This method will look up a store by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStore","name":"Returns a store from the system by its ID.","isWebhook":false,"pointer":"/paths/~1stores~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a store from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a store by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the store to return.","required":true}],"pointer":"/paths/~1stores~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1stores~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/stores/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/stores/{tenantId}/{id}","href":"stores/getstore","openApiOperationId":"getStore","summary":"Returns a store from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The store was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Store"}},"schemaId":"components/schemas/Store","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The store could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve store based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1stores~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Store","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Store"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stores/getstore"}],"panels":[]}]},"httpPath":"/stores/{tenantId}/{id}"},{"label":"Partially updates a store with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/stores/patchstore","routeSlug":"/apis/commerce/commerce-v1/stores/patchstore","metadata":{"seo":{"title":"Partially updates a store with the specified ID.","description":"This method will patch an existing store with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchStore","name":"Partially updates a store with the specified ID.","isWebhook":false,"pointer":"/paths/~1stores~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a store with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing store with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the store to patch.","required":true}],"pointer":"/paths/~1stores~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1stores~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/stores/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/stores/{tenantId}/{id}","href":"stores/patchstore","openApiOperationId":"patchStore","summary":"Partially updates a store with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The store was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Store"}},"schemaId":"components/schemas/Store","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The store could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The store could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve store based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1stores~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Store","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Store"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stores/patchstore"}],"panels":[]}]},"httpPath":"/stores/{tenantId}/{id}"},{"label":"Updates a store with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/stores/updatestore","routeSlug":"/apis/commerce/commerce-v1/stores/updatestore","metadata":{"seo":{"title":"Updates a store with the specified ID.","description":"This method will update an existing store with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateStore","name":"Updates a store with the specified ID.","isWebhook":false,"pointer":"/paths/~1stores~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a store with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing store with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the store to update.","required":true}],"pointer":"/paths/~1stores~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Store"}},"schemaId":"components/schemas/Store","pointer":"/paths/~1stores~1{tenantId}~1{id}/put/requestBody","description":"The updated store that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/stores/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Store"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/stores/{tenantId}/{id}","href":"stores/updatestore","openApiOperationId":"updateStore","summary":"Updates a store with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Store","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Store"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The store was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Store"}},"schemaId":"components/schemas/Store","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The store supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The store could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The store could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve store based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1stores~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Store","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Store"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stores/updatestore"}],"panels":[]}]},"httpPath":"/stores/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Stores"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stores","showPageActions":true},{"nodeType":"markdoc","content":"Stores"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/stores/{tenantId}","summary":"Gets all of the stores in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stores/liststores","deprecated":false},{"title":"/stores/{tenantId}","summary":"Creates a new store record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/stores/createstore","deprecated":false},{"title":"/stores/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/stores/executebatchoperations","deprecated":false},{"title":"/stores/{tenantId}/public/{id}","summary":"Gets the public store info","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stores/getpublicstoreinfo","deprecated":false},{"title":"/stores/{tenantId}/{id}","summary":"Returns a store from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/stores/deletestore","deprecated":false},{"title":"/stores/{tenantId}/{id}","summary":"Returns a store from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stores/getstore","deprecated":false},{"title":"/stores/{tenantId}/{id}","summary":"Partially updates a store with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/stores/patchstore","deprecated":false},{"title":"/stores/{tenantId}/{id}","summary":"Updates a store with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/stores/updatestore","deprecated":false}]}]}]}]}},{"type":"group","label":"Tax Classes","link":"/apis/commerce/commerce-v1/tax-classes","routeSlug":"/apis/commerce/commerce-v1/tax-classes","items":[{"label":"Gets all of the tax classes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-classes/listtaxclasses","routeSlug":"/apis/commerce/commerce-v1/tax-classes/listtaxclasses","metadata":{"seo":{"title":"Gets all of the tax classes in the system.","description":"This method will scan all tax classes and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTaxClasses","name":"Gets all of the tax classes in the system.","isWebhook":false,"pointer":"/paths/~1taxClasses~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the tax classes in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all tax classes and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1taxClasses~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1taxClasses~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/taxClasses/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/taxClasses/{tenantId}","href":"tax-classes/listtaxclasses","openApiOperationId":"listTaxClasses","summary":"Gets all of the tax classes in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The tax classeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_479"}},"schemaId":"schema_479","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1taxClasses~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_479","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_479"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-classes/listtaxclasses"}],"panels":[]}]},"httpPath":"/taxClasses/{tenantId}"},{"label":"Creates a new tax class record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-classes/createtaxclass","routeSlug":"/apis/commerce/commerce-v1/tax-classes/createtaxclass","metadata":{"seo":{"title":"Creates a new tax class record that does not already exist.","description":"This method will auto-generate an ID and create a new tax class. If an ID is specified for the tax class, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTaxClass","name":"Creates a new tax class record that does not already exist.","isWebhook":false,"pointer":"/paths/~1taxClasses~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new tax class record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new tax class. If an ID is specified for the tax class, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1taxClasses~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaxClass"}},"schemaId":"components/schemas/TaxClass","pointer":"/paths/~1taxClasses~1{tenantId}/post/requestBody","description":"The tax class that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/taxClasses/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TaxClass"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/taxClasses/{tenantId}","href":"tax-classes/createtaxclass","openApiOperationId":"createTaxClass","summary":"Creates a new tax class record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/TaxClass","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaxClass"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The tax class was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxClass"}},"schemaId":"components/schemas/TaxClass","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The tax class you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The tax class could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add tax class based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1taxClasses~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaxClass","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxClass"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-classes/createtaxclass"}],"panels":[]}]},"httpPath":"/taxClasses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-classes/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/tax-classes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1taxClasses~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1taxClasses~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1taxClasses~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/taxClasses/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/taxClasses/{tenantId}/batch","href":"tax-classes/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The tax class could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve tax class based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1taxClasses~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-classes/executebatchoperations"}],"panels":[]}]},"httpPath":"/taxClasses/{tenantId}/batch"},{"label":"Returns a tax class from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-classes/deletetaxclass","routeSlug":"/apis/commerce/commerce-v1/tax-classes/deletetaxclass","metadata":{"seo":{"title":"Returns a tax class from the system by its ID.","description":"This method will delete a tax class with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTaxClass","name":"Returns a tax class from the system by its ID.","isWebhook":false,"pointer":"/paths/~1taxClasses~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a tax class from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a tax class with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the tax class to delete.","required":true}],"pointer":"/paths/~1taxClasses~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/taxClasses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/taxClasses/{tenantId}/{id}","href":"tax-classes/deletetaxclass","openApiOperationId":"deleteTaxClass","summary":"Returns a tax class from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The tax class was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The tax class could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The tax class could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete tax class based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1taxClasses~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-classes/deletetaxclass"}],"panels":[]}]},"httpPath":"/taxClasses/{tenantId}/{id}"},{"label":"Returns a tax class from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-classes/gettaxclass","routeSlug":"/apis/commerce/commerce-v1/tax-classes/gettaxclass","metadata":{"seo":{"title":"Returns a tax class from the system by its ID.","description":"This method will look up a tax class by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTaxClass","name":"Returns a tax class from the system by its ID.","isWebhook":false,"pointer":"/paths/~1taxClasses~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a tax class from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a tax class by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the tax class to return.","required":true}],"pointer":"/paths/~1taxClasses~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1taxClasses~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/taxClasses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/taxClasses/{tenantId}/{id}","href":"tax-classes/gettaxclass","openApiOperationId":"getTaxClass","summary":"Returns a tax class from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The tax class was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxClass"}},"schemaId":"components/schemas/TaxClass","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The tax class could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve tax class based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1taxClasses~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaxClass","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxClass"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-classes/gettaxclass"}],"panels":[]}]},"httpPath":"/taxClasses/{tenantId}/{id}"},{"label":"Partially updates a tax class with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-classes/patchtaxclass","routeSlug":"/apis/commerce/commerce-v1/tax-classes/patchtaxclass","metadata":{"seo":{"title":"Partially updates a tax class with the specified ID.","description":"This method will patch an existing tax class with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchTaxClass","name":"Partially updates a tax class with the specified ID.","isWebhook":false,"pointer":"/paths/~1taxClasses~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a tax class with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing tax class with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the tax class to patch.","required":true}],"pointer":"/paths/~1taxClasses~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1taxClasses~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/taxClasses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/taxClasses/{tenantId}/{id}","href":"tax-classes/patchtaxclass","openApiOperationId":"patchTaxClass","summary":"Partially updates a tax class with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The tax class was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxClass"}},"schemaId":"components/schemas/TaxClass","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The tax class could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The tax class could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve tax class based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1taxClasses~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaxClass","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxClass"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-classes/patchtaxclass"}],"panels":[]}]},"httpPath":"/taxClasses/{tenantId}/{id}"},{"label":"Updates a tax class with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-classes/updatetaxclass","routeSlug":"/apis/commerce/commerce-v1/tax-classes/updatetaxclass","metadata":{"seo":{"title":"Updates a tax class with the specified ID.","description":"This method will update an existing tax class with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTaxClass","name":"Updates a tax class with the specified ID.","isWebhook":false,"pointer":"/paths/~1taxClasses~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a tax class with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing tax class with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the tax class to update.","required":true}],"pointer":"/paths/~1taxClasses~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaxClass"}},"schemaId":"components/schemas/TaxClass","pointer":"/paths/~1taxClasses~1{tenantId}~1{id}/put/requestBody","description":"The updated tax class that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/taxClasses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TaxClass"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/taxClasses/{tenantId}/{id}","href":"tax-classes/updatetaxclass","openApiOperationId":"updateTaxClass","summary":"Updates a tax class with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/TaxClass","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaxClass"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The tax class was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxClass"}},"schemaId":"components/schemas/TaxClass","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The tax class supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The tax class could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The tax class could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve tax class based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1taxClasses~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaxClass","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxClass"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-classes/updatetaxclass"}],"panels":[]}]},"httpPath":"/taxClasses/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Tax Classes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tax Classes","showPageActions":true},{"nodeType":"markdoc","content":"Tax Classes"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/taxClasses/{tenantId}","summary":"Gets all of the tax classes in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tax-classes/listtaxclasses","deprecated":false},{"title":"/taxClasses/{tenantId}","summary":"Creates a new tax class record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tax-classes/createtaxclass","deprecated":false},{"title":"/taxClasses/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tax-classes/executebatchoperations","deprecated":false},{"title":"/taxClasses/{tenantId}/{id}","summary":"Returns a tax class from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tax-classes/deletetaxclass","deprecated":false},{"title":"/taxClasses/{tenantId}/{id}","summary":"Returns a tax class from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tax-classes/gettaxclass","deprecated":false},{"title":"/taxClasses/{tenantId}/{id}","summary":"Partially updates a tax class with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/tax-classes/patchtaxclass","deprecated":false},{"title":"/taxClasses/{tenantId}/{id}","summary":"Updates a tax class with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tax-classes/updatetaxclass","deprecated":false}]}]}]}]}},{"type":"group","label":"Tax Configurations","link":"/apis/commerce/commerce-v1/tax-configurations","routeSlug":"/apis/commerce/commerce-v1/tax-configurations","items":[{"label":"Returns a tax configuration from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-configurations/deletetaxconfiguration","routeSlug":"/apis/commerce/commerce-v1/tax-configurations/deletetaxconfiguration","metadata":{"seo":{"title":"Returns a tax configuration from the system by its ID.","description":"This method will delete a tax configuration with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTaxConfiguration","name":"Returns a tax configuration from the system by its ID.","isWebhook":false,"pointer":"/paths/~1taxConfigurations~1{tenantId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a tax configuration from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a tax configuration with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1taxConfigurations~1{tenantId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/taxConfigurations/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/taxConfigurations/{tenantId}","href":"tax-configurations/deletetaxconfiguration","openApiOperationId":"deleteTaxConfiguration","summary":"Returns a tax configuration from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The tax configuration was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The tax configuration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The tax configuration could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete tax configuration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1taxConfigurations~1{tenantId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-configurations/deletetaxconfiguration"}],"panels":[]}]},"httpPath":"/taxConfigurations/{tenantId}"},{"label":"Returns a tax configuration from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-configurations/gettaxconfiguration","routeSlug":"/apis/commerce/commerce-v1/tax-configurations/gettaxconfiguration","metadata":{"seo":{"title":"Returns a tax configuration from the system by its ID.","description":"This method will look up a tax configuration by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTaxConfiguration","name":"Returns a tax configuration from the system by its ID.","isWebhook":false,"pointer":"/paths/~1taxConfigurations~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a tax configuration from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a tax configuration by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1taxConfigurations~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1taxConfigurations~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/taxConfigurations/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/taxConfigurations/{tenantId}","href":"tax-configurations/gettaxconfiguration","openApiOperationId":"getTaxConfiguration","summary":"Returns a tax configuration from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The tax configuration was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxConfiguration"}},"schemaId":"components/schemas/TaxConfiguration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The tax configuration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve tax configuration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1taxConfigurations~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaxConfiguration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxConfiguration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-configurations/gettaxconfiguration"}],"panels":[]}]},"httpPath":"/taxConfigurations/{tenantId}"},{"label":"Partially updates a tax configuration with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-configurations/patchtaxconfiguration","routeSlug":"/apis/commerce/commerce-v1/tax-configurations/patchtaxconfiguration","metadata":{"seo":{"title":"Partially updates a tax configuration with the specified ID.","description":"This method will patch an existing tax configuration with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchTaxConfiguration","name":"Partially updates a tax configuration with the specified ID.","isWebhook":false,"pointer":"/paths/~1taxConfigurations~1{tenantId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a tax configuration with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing tax configuration with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1taxConfigurations~1{tenantId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1taxConfigurations~1{tenantId}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/taxConfigurations/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/taxConfigurations/{tenantId}","href":"tax-configurations/patchtaxconfiguration","openApiOperationId":"patchTaxConfiguration","summary":"Partially updates a tax configuration with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The tax configuration was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxConfiguration"}},"schemaId":"components/schemas/TaxConfiguration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The tax configuration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The tax configuration could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve tax configuration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1taxConfigurations~1{tenantId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaxConfiguration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxConfiguration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-configurations/patchtaxconfiguration"}],"panels":[]}]},"httpPath":"/taxConfigurations/{tenantId}"},{"label":"Creates a new tax configuration record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-configurations/createtaxconfiguration","routeSlug":"/apis/commerce/commerce-v1/tax-configurations/createtaxconfiguration","metadata":{"seo":{"title":"Creates a new tax configuration record that does not already exist.","description":"This method will auto-generate an ID and create a new tax configuration. If an ID is specified for the tax configuration, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTaxConfiguration","name":"Creates a new tax configuration record that does not already exist.","isWebhook":false,"pointer":"/paths/~1taxConfigurations~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new tax configuration record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new tax configuration. If an ID is specified for the tax configuration, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1taxConfigurations~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaxConfiguration"}},"schemaId":"components/schemas/TaxConfiguration","pointer":"/paths/~1taxConfigurations~1{tenantId}/post/requestBody","description":"The tax configuration that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/taxConfigurations/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TaxConfiguration"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/taxConfigurations/{tenantId}","href":"tax-configurations/createtaxconfiguration","openApiOperationId":"createTaxConfiguration","summary":"Creates a new tax configuration record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/TaxConfiguration","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaxConfiguration"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The tax configuration was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxConfiguration"}},"schemaId":"components/schemas/TaxConfiguration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The tax configuration you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The tax configuration could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add tax configuration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1taxConfigurations~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaxConfiguration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxConfiguration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-configurations/createtaxconfiguration"}],"panels":[]}]},"httpPath":"/taxConfigurations/{tenantId}"},{"label":"Updates a tax configuration with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-configurations/updatetaxconfiguration","routeSlug":"/apis/commerce/commerce-v1/tax-configurations/updatetaxconfiguration","metadata":{"seo":{"title":"Updates a tax configuration with the specified ID.","description":"This method will update an existing tax configuration with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTaxConfiguration","name":"Updates a tax configuration with the specified ID.","isWebhook":false,"pointer":"/paths/~1taxConfigurations~1{tenantId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a tax configuration with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing tax configuration with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1taxConfigurations~1{tenantId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaxConfiguration"}},"schemaId":"components/schemas/TaxConfiguration","pointer":"/paths/~1taxConfigurations~1{tenantId}/put/requestBody","description":"The updated tax configuration that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/taxConfigurations/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TaxConfiguration"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/taxConfigurations/{tenantId}","href":"tax-configurations/updatetaxconfiguration","openApiOperationId":"updateTaxConfiguration","summary":"Updates a tax configuration with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/TaxConfiguration","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaxConfiguration"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The tax configuration was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxConfiguration"}},"schemaId":"components/schemas/TaxConfiguration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The tax configuration supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The tax configuration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The tax configuration could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve tax configuration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1taxConfigurations~1{tenantId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaxConfiguration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxConfiguration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-configurations/updatetaxconfiguration"}],"panels":[]}]},"httpPath":"/taxConfigurations/{tenantId}"}],"content":{"contentType":"group","meta":{"name":"Tax Configurations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tax Configurations","showPageActions":true},{"nodeType":"markdoc","content":"Tax Configurations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/taxConfigurations/{tenantId}","summary":"Returns a tax configuration from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tax-configurations/deletetaxconfiguration","deprecated":false},{"title":"/taxConfigurations/{tenantId}","summary":"Returns a tax configuration from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tax-configurations/gettaxconfiguration","deprecated":false},{"title":"/taxConfigurations/{tenantId}","summary":"Partially updates a tax configuration with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/tax-configurations/patchtaxconfiguration","deprecated":false},{"title":"/taxConfigurations/{tenantId}","summary":"Creates a new tax configuration record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tax-configurations/createtaxconfiguration","deprecated":false},{"title":"/taxConfigurations/{tenantId}","summary":"Updates a tax configuration with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tax-configurations/updatetaxconfiguration","deprecated":false}]}]}]}]}},{"type":"group","label":"Tax Products","link":"/apis/commerce/commerce-v1/tax-products","routeSlug":"/apis/commerce/commerce-v1/tax-products","items":[{"label":"Gets all of the tax products in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-products/listtaxproducts","routeSlug":"/apis/commerce/commerce-v1/tax-products/listtaxproducts","metadata":{"seo":{"title":"Gets all of the tax products in the system.","description":"This method will scan all tax products and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTaxProducts","name":"Gets all of the tax products in the system.","isWebhook":false,"pointer":"/paths/~1taxProducts~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the tax products in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all tax products and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1taxProducts~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1taxProducts~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/taxProducts/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/taxProducts/{tenantId}","href":"tax-products/listtaxproducts","openApiOperationId":"listTaxProducts","summary":"Gets all of the tax products in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The tax productswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_480"}},"schemaId":"schema_480","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1taxProducts~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_480","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_480"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-products/listtaxproducts"}],"panels":[]}]},"httpPath":"/taxProducts/{tenantId}"},{"label":"Creates a new tax product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-products/createtaxproduct","routeSlug":"/apis/commerce/commerce-v1/tax-products/createtaxproduct","metadata":{"seo":{"title":"Creates a new tax product record that does not already exist.","description":"This method will auto-generate an ID and create a new tax product. If an ID is specified for the tax product, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTaxProduct","name":"Creates a new tax product record that does not already exist.","isWebhook":false,"pointer":"/paths/~1taxProducts~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new tax product record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new tax product. If an ID is specified for the tax product, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1taxProducts~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaxProduct"}},"schemaId":"components/schemas/TaxProduct","pointer":"/paths/~1taxProducts~1{tenantId}/post/requestBody","description":"The tax product that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/taxProducts/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TaxProduct"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/taxProducts/{tenantId}","href":"tax-products/createtaxproduct","openApiOperationId":"createTaxProduct","summary":"Creates a new tax product record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/TaxProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaxProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The tax product was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxProduct"}},"schemaId":"components/schemas/TaxProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The tax product you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The tax product could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add tax product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1taxProducts~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaxProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-products/createtaxproduct"}],"panels":[]}]},"httpPath":"/taxProducts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-products/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/tax-products/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1taxProducts~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1taxProducts~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1taxProducts~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/taxProducts/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/taxProducts/{tenantId}/batch","href":"tax-products/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The tax product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve tax product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1taxProducts~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-products/executebatchoperations"}],"panels":[]}]},"httpPath":"/taxProducts/{tenantId}/batch"},{"label":"Returns a tax product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-products/deletetaxproduct","routeSlug":"/apis/commerce/commerce-v1/tax-products/deletetaxproduct","metadata":{"seo":{"title":"Returns a tax product from the system by its ID.","description":"This method will delete a tax product with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTaxProduct","name":"Returns a tax product from the system by its ID.","isWebhook":false,"pointer":"/paths/~1taxProducts~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a tax product from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a tax product with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the tax product to delete.","required":true}],"pointer":"/paths/~1taxProducts~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/taxProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/taxProducts/{tenantId}/{id}","href":"tax-products/deletetaxproduct","openApiOperationId":"deleteTaxProduct","summary":"Returns a tax product from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The tax product was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The tax product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The tax product could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete tax product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1taxProducts~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-products/deletetaxproduct"}],"panels":[]}]},"httpPath":"/taxProducts/{tenantId}/{id}"},{"label":"Returns a tax product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-products/gettaxproduct","routeSlug":"/apis/commerce/commerce-v1/tax-products/gettaxproduct","metadata":{"seo":{"title":"Returns a tax product from the system by its ID.","description":"This method will look up a tax product by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTaxProduct","name":"Returns a tax product from the system by its ID.","isWebhook":false,"pointer":"/paths/~1taxProducts~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a tax product from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a tax product by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the tax product to return.","required":true}],"pointer":"/paths/~1taxProducts~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1taxProducts~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/taxProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/taxProducts/{tenantId}/{id}","href":"tax-products/gettaxproduct","openApiOperationId":"getTaxProduct","summary":"Returns a tax product from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The tax product was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxProduct"}},"schemaId":"components/schemas/TaxProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The tax product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve tax product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1taxProducts~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaxProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-products/gettaxproduct"}],"panels":[]}]},"httpPath":"/taxProducts/{tenantId}/{id}"},{"label":"Partially updates a tax product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-products/patchtaxproduct","routeSlug":"/apis/commerce/commerce-v1/tax-products/patchtaxproduct","metadata":{"seo":{"title":"Partially updates a tax product with the specified ID.","description":"This method will patch an existing tax product with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchTaxProduct","name":"Partially updates a tax product with the specified ID.","isWebhook":false,"pointer":"/paths/~1taxProducts~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a tax product with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing tax product with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the tax product to patch.","required":true}],"pointer":"/paths/~1taxProducts~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1taxProducts~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/taxProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/taxProducts/{tenantId}/{id}","href":"tax-products/patchtaxproduct","openApiOperationId":"patchTaxProduct","summary":"Partially updates a tax product with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The tax product was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxProduct"}},"schemaId":"components/schemas/TaxProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The tax product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The tax product could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve tax product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1taxProducts~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaxProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-products/patchtaxproduct"}],"panels":[]}]},"httpPath":"/taxProducts/{tenantId}/{id}"},{"label":"Updates a tax product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-products/updatetaxproduct","routeSlug":"/apis/commerce/commerce-v1/tax-products/updatetaxproduct","metadata":{"seo":{"title":"Updates a tax product with the specified ID.","description":"This method will update an existing tax product with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTaxProduct","name":"Updates a tax product with the specified ID.","isWebhook":false,"pointer":"/paths/~1taxProducts~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a tax product with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing tax product with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the tax product to update.","required":true}],"pointer":"/paths/~1taxProducts~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaxProduct"}},"schemaId":"components/schemas/TaxProduct","pointer":"/paths/~1taxProducts~1{tenantId}~1{id}/put/requestBody","description":"The updated tax product that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/taxProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TaxProduct"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/taxProducts/{tenantId}/{id}","href":"tax-products/updatetaxproduct","openApiOperationId":"updateTaxProduct","summary":"Updates a tax product with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/TaxProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaxProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The tax product was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxProduct"}},"schemaId":"components/schemas/TaxProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The tax product supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The tax product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The tax product could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve tax product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1taxProducts~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaxProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tax-products/updatetaxproduct"}],"panels":[]}]},"httpPath":"/taxProducts/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Tax Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tax Products","showPageActions":true},{"nodeType":"markdoc","content":"Tax Products"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/taxProducts/{tenantId}","summary":"Gets all of the tax products in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tax-products/listtaxproducts","deprecated":false},{"title":"/taxProducts/{tenantId}","summary":"Creates a new tax product record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tax-products/createtaxproduct","deprecated":false},{"title":"/taxProducts/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tax-products/executebatchoperations","deprecated":false},{"title":"/taxProducts/{tenantId}/{id}","summary":"Returns a tax product from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tax-products/deletetaxproduct","deprecated":false},{"title":"/taxProducts/{tenantId}/{id}","summary":"Returns a tax product from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tax-products/gettaxproduct","deprecated":false},{"title":"/taxProducts/{tenantId}/{id}","summary":"Partially updates a tax product with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/tax-products/patchtaxproduct","deprecated":false},{"title":"/taxProducts/{tenantId}/{id}","summary":"Updates a tax product with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tax-products/updatetaxproduct","deprecated":false}]}]}]}]}},{"type":"group","label":"Warehouse Bins","link":"/apis/commerce/commerce-v1/warehouse-bins","routeSlug":"/apis/commerce/commerce-v1/warehouse-bins","items":[{"label":"Gets all of the warehouse bins in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouse-bins/listwarehousebins","routeSlug":"/apis/commerce/commerce-v1/warehouse-bins/listwarehousebins","metadata":{"seo":{"title":"Gets all of the warehouse bins in the system.","description":"This method will scan all warehouse bins and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listWarehouseBins","name":"Gets all of the warehouse bins in the system.","isWebhook":false,"pointer":"/paths/~1warehouseBins~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the warehouse bins in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all warehouse bins and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1warehouseBins~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1warehouseBins~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/warehouseBins/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/warehouseBins/{tenantId}","href":"warehouse-bins/listwarehousebins","openApiOperationId":"listWarehouseBins","summary":"Gets all of the warehouse bins in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The warehouse binswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_481"}},"schemaId":"schema_481","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1warehouseBins~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_481","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_481"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/warehouse-bins/listwarehousebins"}],"panels":[]}]},"httpPath":"/warehouseBins/{tenantId}"},{"label":"Creates a new warehouse bin record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouse-bins/createwarehousebin","routeSlug":"/apis/commerce/commerce-v1/warehouse-bins/createwarehousebin","metadata":{"seo":{"title":"Creates a new warehouse bin record that does not already exist.","description":"This method will auto-generate an ID and create a new warehouse bin. If an ID is specified for the warehouse bin, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWarehouseBin","name":"Creates a new warehouse bin record that does not already exist.","isWebhook":false,"pointer":"/paths/~1warehouseBins~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new warehouse bin record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new warehouse bin. If an ID is specified for the warehouse bin, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1warehouseBins~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WarehouseBin"}},"schemaId":"components/schemas/WarehouseBin","pointer":"/paths/~1warehouseBins~1{tenantId}/post/requestBody","description":"The warehouse bin that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/warehouseBins/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WarehouseBin"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/warehouseBins/{tenantId}","href":"warehouse-bins/createwarehousebin","openApiOperationId":"createWarehouseBin","summary":"Creates a new warehouse bin record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/WarehouseBin","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WarehouseBin"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The warehouse bin was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WarehouseBin"}},"schemaId":"components/schemas/WarehouseBin","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The warehouse bin you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The warehouse bin could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add warehouse bin based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1warehouseBins~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WarehouseBin","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WarehouseBin"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/warehouse-bins/createwarehousebin"}],"panels":[]}]},"httpPath":"/warehouseBins/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouse-bins/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/warehouse-bins/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1warehouseBins~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1warehouseBins~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1warehouseBins~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/warehouseBins/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/warehouseBins/{tenantId}/batch","href":"warehouse-bins/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The warehouse bin could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve warehouse bin based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1warehouseBins~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/warehouse-bins/executebatchoperations"}],"panels":[]}]},"httpPath":"/warehouseBins/{tenantId}/batch"},{"label":"Returns a warehouse bin from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouse-bins/deletewarehousebin","routeSlug":"/apis/commerce/commerce-v1/warehouse-bins/deletewarehousebin","metadata":{"seo":{"title":"Returns a warehouse bin from the system by its ID.","description":"This method will delete a warehouse bin with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWarehouseBin","name":"Returns a warehouse bin from the system by its ID.","isWebhook":false,"pointer":"/paths/~1warehouseBins~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a warehouse bin from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a warehouse bin with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the warehouse bin to delete.","required":true}],"pointer":"/paths/~1warehouseBins~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/warehouseBins/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/warehouseBins/{tenantId}/{id}","href":"warehouse-bins/deletewarehousebin","openApiOperationId":"deleteWarehouseBin","summary":"Returns a warehouse bin from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The warehouse bin was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The warehouse bin could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The warehouse bin could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete warehouse bin based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1warehouseBins~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/warehouse-bins/deletewarehousebin"}],"panels":[]}]},"httpPath":"/warehouseBins/{tenantId}/{id}"},{"label":"Returns a warehouse bin from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouse-bins/getwarehousebin","routeSlug":"/apis/commerce/commerce-v1/warehouse-bins/getwarehousebin","metadata":{"seo":{"title":"Returns a warehouse bin from the system by its ID.","description":"This method will look up a warehouse bin by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWarehouseBin","name":"Returns a warehouse bin from the system by its ID.","isWebhook":false,"pointer":"/paths/~1warehouseBins~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a warehouse bin from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a warehouse bin by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the warehouse bin to return.","required":true}],"pointer":"/paths/~1warehouseBins~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1warehouseBins~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/warehouseBins/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/warehouseBins/{tenantId}/{id}","href":"warehouse-bins/getwarehousebin","openApiOperationId":"getWarehouseBin","summary":"Returns a warehouse bin from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The warehouse bin was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WarehouseBin"}},"schemaId":"components/schemas/WarehouseBin","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The warehouse bin could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve warehouse bin based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1warehouseBins~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WarehouseBin","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WarehouseBin"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/warehouse-bins/getwarehousebin"}],"panels":[]}]},"httpPath":"/warehouseBins/{tenantId}/{id}"},{"label":"Partially updates a warehouse bin with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouse-bins/patchwarehousebin","routeSlug":"/apis/commerce/commerce-v1/warehouse-bins/patchwarehousebin","metadata":{"seo":{"title":"Partially updates a warehouse bin with the specified ID.","description":"This method will patch an existing warehouse bin with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchWarehouseBin","name":"Partially updates a warehouse bin with the specified ID.","isWebhook":false,"pointer":"/paths/~1warehouseBins~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a warehouse bin with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing warehouse bin with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the warehouse bin to patch.","required":true}],"pointer":"/paths/~1warehouseBins~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1warehouseBins~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/warehouseBins/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/warehouseBins/{tenantId}/{id}","href":"warehouse-bins/patchwarehousebin","openApiOperationId":"patchWarehouseBin","summary":"Partially updates a warehouse bin with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The warehouse bin was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WarehouseBin"}},"schemaId":"components/schemas/WarehouseBin","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The warehouse bin could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The warehouse bin could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve warehouse bin based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1warehouseBins~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WarehouseBin","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WarehouseBin"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/warehouse-bins/patchwarehousebin"}],"panels":[]}]},"httpPath":"/warehouseBins/{tenantId}/{id}"},{"label":"Updates a warehouse bin with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouse-bins/updatewarehousebin","routeSlug":"/apis/commerce/commerce-v1/warehouse-bins/updatewarehousebin","metadata":{"seo":{"title":"Updates a warehouse bin with the specified ID.","description":"This method will update an existing warehouse bin with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWarehouseBin","name":"Updates a warehouse bin with the specified ID.","isWebhook":false,"pointer":"/paths/~1warehouseBins~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a warehouse bin with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing warehouse bin with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the warehouse bin to update.","required":true}],"pointer":"/paths/~1warehouseBins~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WarehouseBin"}},"schemaId":"components/schemas/WarehouseBin","pointer":"/paths/~1warehouseBins~1{tenantId}~1{id}/put/requestBody","description":"The updated warehouse bin that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/warehouseBins/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WarehouseBin"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/warehouseBins/{tenantId}/{id}","href":"warehouse-bins/updatewarehousebin","openApiOperationId":"updateWarehouseBin","summary":"Updates a warehouse bin with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/WarehouseBin","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WarehouseBin"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The warehouse bin was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WarehouseBin"}},"schemaId":"components/schemas/WarehouseBin","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The warehouse bin supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The warehouse bin could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The warehouse bin could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve warehouse bin based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1warehouseBins~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WarehouseBin","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WarehouseBin"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/warehouse-bins/updatewarehousebin"}],"panels":[]}]},"httpPath":"/warehouseBins/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Warehouse Bins"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Warehouse Bins","showPageActions":true},{"nodeType":"markdoc","content":"Warehouse Bins"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/warehouseBins/{tenantId}","summary":"Gets all of the warehouse bins in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/warehouse-bins/listwarehousebins","deprecated":false},{"title":"/warehouseBins/{tenantId}","summary":"Creates a new warehouse bin record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/warehouse-bins/createwarehousebin","deprecated":false},{"title":"/warehouseBins/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/warehouse-bins/executebatchoperations","deprecated":false},{"title":"/warehouseBins/{tenantId}/{id}","summary":"Returns a warehouse bin from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/warehouse-bins/deletewarehousebin","deprecated":false},{"title":"/warehouseBins/{tenantId}/{id}","summary":"Returns a warehouse bin from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/warehouse-bins/getwarehousebin","deprecated":false},{"title":"/warehouseBins/{tenantId}/{id}","summary":"Partially updates a warehouse bin with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/warehouse-bins/patchwarehousebin","deprecated":false},{"title":"/warehouseBins/{tenantId}/{id}","summary":"Updates a warehouse bin with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/warehouse-bins/updatewarehousebin","deprecated":false}]}]}]}]}},{"type":"group","label":"Warehouses","link":"/apis/commerce/commerce-v1/warehouses","routeSlug":"/apis/commerce/commerce-v1/warehouses","items":[{"label":"Gets all of the warehouses in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouses/listwarehouses","routeSlug":"/apis/commerce/commerce-v1/warehouses/listwarehouses","metadata":{"seo":{"title":"Gets all of the warehouses in the system.","description":"This method will scan all warehouses and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listWarehouses","name":"Gets all of the warehouses in the system.","isWebhook":false,"pointer":"/paths/~1warehouses~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the warehouses in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all warehouses and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1warehouses~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_459","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1warehouses~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/warehouses/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/warehouses/{tenantId}","href":"warehouses/listwarehouses","openApiOperationId":"listWarehouses","summary":"Gets all of the warehouses in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The warehouseswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_482"}},"schemaId":"schema_482","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1warehouses~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_482","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_482"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/warehouses/listwarehouses"}],"panels":[]}]},"httpPath":"/warehouses/{tenantId}"},{"label":"Creates a new warehouse record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouses/createwarehouse","routeSlug":"/apis/commerce/commerce-v1/warehouses/createwarehouse","metadata":{"seo":{"title":"Creates a new warehouse record that does not already exist.","description":"This method will auto-generate an ID and create a new warehouse. If an ID is specified for the warehouse, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWarehouse","name":"Creates a new warehouse record that does not already exist.","isWebhook":false,"pointer":"/paths/~1warehouses~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new warehouse record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new warehouse. If an ID is specified for the warehouse, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1warehouses~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Warehouse"}},"schemaId":"components/schemas/Warehouse","pointer":"/paths/~1warehouses~1{tenantId}/post/requestBody","description":"The warehouse that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/warehouses/{tenantId}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Warehouse"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/warehouses/{tenantId}","href":"warehouses/createwarehouse","openApiOperationId":"createWarehouse","summary":"Creates a new warehouse record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Warehouse","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Warehouse"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The warehouse was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Warehouse"}},"schemaId":"components/schemas/Warehouse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The warehouse you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The warehouse could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to add warehouse based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1warehouses~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Warehouse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Warehouse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/warehouses/createwarehouse"}],"panels":[]}]},"httpPath":"/warehouses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouses/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/warehouses/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1warehouses~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1warehouses~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1warehouses~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/warehouses/{tenantId}/batch","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/warehouses/{tenantId}/batch","href":"warehouses/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The warehouse could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve warehouse based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1warehouses~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/warehouses/executebatchoperations"}],"panels":[]}]},"httpPath":"/warehouses/{tenantId}/batch"},{"label":"Returns a warehouse from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouses/deletewarehouse","routeSlug":"/apis/commerce/commerce-v1/warehouses/deletewarehouse","metadata":{"seo":{"title":"Returns a warehouse from the system by its ID.","description":"This method will delete a warehouse with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWarehouse","name":"Returns a warehouse from the system by its ID.","isWebhook":false,"pointer":"/paths/~1warehouses~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a warehouse from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a warehouse with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the warehouse to delete.","required":true}],"pointer":"/paths/~1warehouses~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/warehouses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/warehouses/{tenantId}/{id}","href":"warehouses/deletewarehouse","openApiOperationId":"deleteWarehouse","summary":"Returns a warehouse from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The warehouse was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The warehouse could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The warehouse could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to delete warehouse based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1warehouses~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/warehouses/deletewarehouse"}],"panels":[]}]},"httpPath":"/warehouses/{tenantId}/{id}"},{"label":"Returns a warehouse from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouses/getwarehouse","routeSlug":"/apis/commerce/commerce-v1/warehouses/getwarehouse","metadata":{"seo":{"title":"Returns a warehouse from the system by its ID.","description":"This method will look up a warehouse by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWarehouse","name":"Returns a warehouse from the system by its ID.","isWebhook":false,"pointer":"/paths/~1warehouses~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a warehouse from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a warehouse by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the warehouse to return.","required":true}],"pointer":"/paths/~1warehouses~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_459","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_459","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1warehouses~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/warehouses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_459"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_459"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/warehouses/{tenantId}/{id}","href":"warehouses/getwarehouse","openApiOperationId":"getWarehouse","summary":"Returns a warehouse from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The warehouse was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Warehouse"}},"schemaId":"components/schemas/Warehouse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The warehouse could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve warehouse based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1warehouses~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Warehouse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Warehouse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/warehouses/getwarehouse"}],"panels":[]}]},"httpPath":"/warehouses/{tenantId}/{id}"},{"label":"Partially updates a warehouse with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouses/patchwarehouse","routeSlug":"/apis/commerce/commerce-v1/warehouses/patchwarehouse","metadata":{"seo":{"title":"Partially updates a warehouse with the specified ID.","description":"This method will patch an existing warehouse with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchWarehouse","name":"Partially updates a warehouse with the specified ID.","isWebhook":false,"pointer":"/paths/~1warehouses~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a warehouse with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing warehouse with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the warehouse to patch.","required":true}],"pointer":"/paths/~1warehouses~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1warehouses~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/warehouses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/warehouses/{tenantId}/{id}","href":"warehouses/patchwarehouse","openApiOperationId":"patchWarehouse","summary":"Partially updates a warehouse with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The warehouse was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Warehouse"}},"schemaId":"components/schemas/Warehouse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The warehouse could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The warehouse could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve warehouse based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1warehouses~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Warehouse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Warehouse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/warehouses/patchwarehouse"}],"panels":[]}]},"httpPath":"/warehouses/{tenantId}/{id}"},{"label":"Updates a warehouse with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouses/updatewarehouse","routeSlug":"/apis/commerce/commerce-v1/warehouses/updatewarehouse","metadata":{"seo":{"title":"Updates a warehouse with the specified ID.","description":"This method will update an existing warehouse with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWarehouse","name":"Updates a warehouse with the specified ID.","isWebhook":false,"pointer":"/paths/~1warehouses~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a warehouse with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing warehouse with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_459","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_459","description":"The ID of the warehouse to update.","required":true}],"pointer":"/paths/~1warehouses~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Warehouse"}},"schemaId":"components/schemas/Warehouse","pointer":"/paths/~1warehouses~1{tenantId}~1{id}/put/requestBody","description":"The updated warehouse that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/warehouses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_459"},{"name":"id","in":"path","required":true,"schemaId":"schema_459"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Warehouse"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/warehouses/{tenantId}/{id}","href":"warehouses/updatewarehouse","openApiOperationId":"updateWarehouse","summary":"Updates a warehouse with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/commerce/commerce-v1","description":"Mock server","isMockServer":true},{"url":"https://commerce.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Warehouse","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Warehouse"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The warehouse was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Warehouse"}},"schemaId":"components/schemas/Warehouse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"400","description":"The warehouse supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"404","description":"The warehouse could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"409","description":"The warehouse could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"429","description":"Limit exceeded... unable to retrieve warehouse based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_461"}],"pointer":"/paths/~1warehouses~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Warehouse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Warehouse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/warehouses/updatewarehouse"}],"panels":[]}]},"httpPath":"/warehouses/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Warehouses"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Warehouses","showPageActions":true},{"nodeType":"markdoc","content":"Warehouses"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/warehouses/{tenantId}","summary":"Gets all of the warehouses in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/warehouses/listwarehouses","deprecated":false},{"title":"/warehouses/{tenantId}","summary":"Creates a new warehouse record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/warehouses/createwarehouse","deprecated":false},{"title":"/warehouses/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/warehouses/executebatchoperations","deprecated":false},{"title":"/warehouses/{tenantId}/{id}","summary":"Returns a warehouse from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/warehouses/deletewarehouse","deprecated":false},{"title":"/warehouses/{tenantId}/{id}","summary":"Returns a warehouse from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/warehouses/getwarehouse","deprecated":false},{"title":"/warehouses/{tenantId}/{id}","summary":"Partially updates a warehouse with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/warehouses/patchwarehouse","deprecated":false},{"title":"/warehouses/{tenantId}/{id}","summary":"Updates a warehouse with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/warehouses/updatewarehouse","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"additionalProperties":false,"description":"A complete address","properties":{"city":{"description":"The city of the address","title":"City","type":"string"},"country":{"description":"The country ISO code","title":"Country","type":"string"},"country_name":{"description":"The full name of hte country","title":"Country Name","type":"string"},"county":{"description":"The county","title":"County","type":"string"},"latitude":{"format":"double","title":"Latitude","type":"number"},"line1":{"description":"The first line of the address","title":"Line 1","type":"string"},"line2":{"description":"The second line of the address","title":"Line 2","type":"string"},"line3":{"description":"The third line of the address","title":"Line 3","type":"string"},"longitude":{"format":"double","title":"Longitude","type":"number"},"postal_code":{"description":"The zip/postal code","title":"Postal Code","type":"string"},"state":{"description":"The state/province of the address","title":"State","type":"string"},"time_zone_id":{"title":"Time Zone","type":"string"}},"type":"object"}},"components/schemas/BatchOperationRequest":{"id":"components/schemas/BatchOperationRequest","kind":"json-schema","title":"BatchOperationRequest","data":{"additionalProperties":false,"properties":{"operations":{"items":{"additionalProperties":false,"properties":{"id":{"description":"The ID of the record","oneOf":[{"x-required":true}],"title":"ID","type":"string"},"object":{"title":"Object","type":"object"},"operation":{"enum":["create","delete","patch","read","update"],"title":"Operation","type":"string"},"patch_directives":{"items":{"additionalProperties":false,"properties":{"op":{"description":"The operation","enum":["add","copy","move","remove","replace","test"],"title":"Op","type":"string"},"path":{"description":"The JSON path","title":"Path","type":"string"},"value":{"title":"Value","type":"string"}},"required":["op","path"],"type":"object"},"maxItems":100,"minItems":1,"oneOf":[{"x-required":true}],"type":"array"}},"required":["operation"],"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/BatchOperationResponse":{"id":"components/schemas/BatchOperationResponse","kind":"json-schema","title":"BatchOperationResponse","data":{"additionalProperties":false,"properties":{"error_count":{"description":"Number of error results","format":"float","title":"Error Count","type":"number"},"results":{"items":{"additionalProperties":false,"properties":{"error_message":{"title":"Error Message","type":"string"},"id":{"description":"The ID of the record","title":"ID","type":"string"},"object":{"title":"Object","type":"object"},"operation":{"enum":["create","delete","patch","read","update"],"title":"Operation","type":"string"},"outcome":{"enum":["error","no change","success"],"title":"Outcome","type":"string"}},"required":["id","operation"],"type":"object"},"type":"array"},"success_count":{"description":"Number of successful results","format":"float","title":"Success Count","type":"number"}},"type":"object"}},"components/schemas/Cancellation":{"id":"components/schemas/Cancellation","kind":"json-schema","title":"Cancellation","data":{"additionalProperties":false,"properties":{"action":{"description":"What to do with payments made on the order","enum":["issue credit","issue refund"],"title":"Action","type":"string"},"base_currency_code":{"title":"Base Currency Code","type":"string"},"base_currency_symbol":{"title":"Base Currency Symbol","type":"string"},"batch_id":{"description":"The batch the cancellation should be in","title":"Batch","type":"string"},"business_unit_id":{"description":"The business unit the cancellation should be in","title":"Business Unit","type":"string"},"currency_code":{"description":"The cancellation currency","title":"Currency Code","type":"string"},"currency_symbol":{"description":"The cancellation currency symbol","title":"Currency Symbol","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date of the cancellation","format":"date-time","title":"Date","type":"string"},"do_not_perform_electronic_refund":{"description":"If set, the refund process will NOT perform an electronic refund","title":"Do Not Perform Electronic Refund","type":"boolean"},"id":{"description":"The unique, string identifier of this cancellation","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"ignore_payment_gateway_errors":{"description":"Whether or not the cancellation should be processed, even if the payment gateway has an error","title":"Ignore Payment Gateway Errors","type":"boolean"},"line_items":{"items":{"additionalProperties":false,"oneOf":[{"type":"object","properties":{},"additionalProperties":false}],"properties":{"order_line_item_id":{"description":"The order line item ID being cancelled","title":"Order Line Item","type":"string"},"product_id":{"description":"The product ID","oneOf":[{"x-required":true}],"title":"Product","type":"string"},"product_type":{"description":"The product type","oneOf":[{"x-required":true}],"title":"Product Type","type":"string"},"quantity":{"description":"The quantity being cancelled","title":"Quantity","type":"integer"},"waive_cancellation_fees":{"description":"Whether or not the cancellation should waive cancellation fees","title":"Waive Cancellation Fees","type":"boolean"}},"required":["order_line_item_id","quantity"],"type":"object"},"minItems":1,"type":"array"},"notes":{"description":"Any refund notes","title":"Notes","type":"string"},"number":{"description":"The unique, string identifier of this return","title":"Number","type":"integer"},"order_id":{"description":"The order being cancelled","title":"Order","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["action","batch_id","business_unit_id","currency_code","id","line_items","number","order_id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/CancellationFee":{"id":"components/schemas/CancellationFee","kind":"json-schema","title":"CancellationFee","data":{"additionalProperties":false,"properties":{"business_unit_id":{"description":"The business unit of the product","title":"Business Unit","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this miscellaneous product","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether this product is active/used","title":"Is Active","type":"boolean"},"name":{"description":"The name of the miscellaneous product","title":"Name","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type":{"description":"The product type","enum":["commerce-cancellation-fees"],"title":"Type","type":"string"}},"required":["business_unit_id","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Cart":{"id":"components/schemas/Cart","kind":"json-schema","title":"Cart","data":{"additionalProperties":false,"properties":{"cart_total":{"description":"The total amount of the items in the cart","format":"float","title":"Cart Total","type":"number"},"currency_code":{"description":"The current code of the cart","title":"Currency Code","type":"string"},"currency_symbol":{"description":"The currency symbol for the cart","title":"Currency Symbol","type":"string"},"id":{"description":"The unique, string identifier of this cart - usually the user ID","pattern":"^[\\w-:]+$","title":"ID","type":"string"},"items":{"items":{"additionalProperties":false,"properties":{"item_total":{"description":"The total of the item in the cart","format":"float","title":"Item Total","type":"number"},"modifier_options":{"items":{"additionalProperties":false,"properties":{"modifier_option_id":{"description":"The modifier option ID","title":"Modifier Option","type":"string"},"modifier_option_value":{"description":"The value of the option","title":"Modifier Option Value","type":"string"}},"required":["modifier_option_id"],"type":"object"},"type":"array"},"product_id":{"description":"The merchandise in the cart","title":"Product","type":"string"},"quantity":{"description":"The quantity of the item","format":"float","minimum":0,"title":"Quantity","type":"number"},"variant_options":{"items":{"additionalProperties":false,"properties":{"variant_option_id":{"description":"The variant option ID","title":"Variant Option","type":"string"},"variant_option_value":{"description":"The value of the option","title":"Variant Option Value","type":"string"}},"required":["variant_option_id"],"type":"object"},"type":"array"}},"required":["item_total","product_id","quantity"],"type":"object"},"type":"array"},"notes":{"title":"Notes","type":"string"},"store_id":{"description":"The store to which this cart belongs","title":"Store","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["cart_total","currency_code","currency_symbol","id","store_id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/CheckEligibilityResponse":{"id":"components/schemas/CheckEligibilityResponse","kind":"json-schema","title":"CheckEligibilityResponse","data":{"additionalProperties":false,"properties":{"eligible":{"description":"Whether the contact is eligible","title":"Eligible","type":"boolean"},"reason":{"description":"The reason for ineligibility","title":"Reason","type":"string"}},"type":"object"}},"components/schemas/CheckPriceResponse":{"id":"components/schemas/CheckPriceResponse","kind":"json-schema","title":"CheckPriceResponse","data":{"additionalProperties":false,"properties":{"price":{"description":"The price","format":"double","title":"Price","type":"number"}},"type":"object"}},"components/schemas/Coupon":{"id":"components/schemas/Coupon","kind":"json-schema","title":"Coupon","data":{"additionalProperties":false,"properties":{"amount":{"description":"Amount of the discount","format":"float","title":"Amount","type":"number"},"applies_to_career_center_packages":{"description":"Whether or not this coupon applies to career center packages","title":"Applies To Career Center Packages","type":"boolean"},"applies_to_miscellaneous_products":{"description":"Whether or not this coupon applies to misc products","title":"Applies To Miscellaneous Products","type":"boolean"},"code_generation_html":{"description":"HTML you can add into HTML generation for the code","title":"Code Generation Html","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"discount_product_id":{"description":"The product uses for the discount code when it is at the order level","title":"Discount Product","type":"string"},"expiration_date":{"description":"The date/time that this coupon expires","format":"date-time","title":"Expiration Date","type":"string"},"id":{"description":"The unique, string identifier of this coupon","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether this coupon is enabled","title":"Is Active","type":"boolean"},"limit_to_product_categories":{"description":"Limit purchase to particular product categories","items":{"type":"string"},"title":"Limit To Product Categories","type":"array"},"limit_to_products":{"description":"Limit purchase to particular products","items":{"type":"string"},"title":"Limit To Products","type":"array"},"limit_total_uses":{"description":"The maximum number of times this coupon can be used","title":"Limit Total Uses","type":"integer"},"limit_uses_per_customer":{"description":"The maximum number of times this coupon can be used by a particular customer","title":"Limit Uses Per Customer","type":"integer"},"maximum_discount":{"description":"The optional maximum discount that this coupon can yield, irrespective of its configuration","format":"float","title":"Maximum Discount","type":"number"},"minimum_purchase":{"description":"Minimum a customer must purchase to qualify for coupon","format":"double","title":"Minimum Purchase","type":"number"},"name":{"description":"The name of the coupon","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type":{"description":"The type of discount to apply","enum":["fixed amount off each item","fixed amount off order","fixed amount off shipping","free shipping","percentage off each item"],"title":"Type","type":"string"}},"required":["amount","discount_product_id","id","is_active","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type"],"type":"object"}},"components/schemas/CouponCode":{"id":"components/schemas/CouponCode","kind":"json-schema","title":"CouponCode","data":{"additionalProperties":false,"properties":{"contact_id":{"description":"The contact","title":"Contact","type":"string"},"coupon_id":{"description":"The ID of the associated coupon","title":"Coupon","type":"string"},"coupon_type":{"description":"The type of coupon","pattern":"\\-coupons$","title":"Coupon Type","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"eligibility_criteria":{"additionalProperties":false,"description":"The criteria to use","properties":{"advanced_rule_error_message":{"description":"The error message to show when the advanced rule fails","title":"Advanced Rule Error Message","type":"string"},"advanced_rules":{"title":"Advanced Rules","type":"object"},"age_restrictions":{"additionalProperties":false,"properties":{"maximum_age":{"description":"The maximum age of the contact","format":"float","title":"Maximum Age","type":"number"},"minimum_age":{"description":"The minimum age of the contact","format":"float","title":"Minimum Age","type":"number"}},"title":"Age Restrictions","type":"object"},"award_options":{"additionalProperties":false,"properties":{"award_ids":{"items":{"type":"string"},"title":"Awards","type":"array"},"award_type_ids":{"items":{"type":"string"},"title":"Award Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Award Options","type":"object"},"award_recipients":{"description":"If set, only people who have received awards","title":"Award Recipients","type":"boolean"},"by_location":{"description":"If true, then filter by location","title":"By Location","type":"boolean"},"certificants":{"description":"If set, only people with specific certifications","title":"Certificants","type":"boolean"},"certification_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"program_ids":{"items":{"type":"string"},"title":"Programs","type":"array"}},"title":"Certification Options","type":"object"},"committee_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"committee_ids":{"items":{"type":"string"},"title":"Committees","type":"array"},"committee_position_ids":{"items":{"type":"string"},"title":"Committee Positions","type":"array"},"committee_type_ids":{"items":{"type":"string"},"title":"Committee Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Committee Member Options","type":"object"},"committee_members":{"description":"If set, active members who belong to a committee can purchase","title":"Committee Members","type":"boolean"},"custom_logic_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"lambda_function_id":{"description":"The custom lambda function to use","title":"Lambda Function","type":"string"}},"required":["lambda_function_id"],"title":"Custom Logic Options","type":"object"},"customer_type":{"enum":["contact","organization"],"title":"Customer Type","type":"string"},"donor_options":{"additionalProperties":false,"properties":{"donor_club_ids":{"items":{"type":"string"},"title":"Donor Clubs","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Donor Options","type":"object"},"donors":{"description":"If true, only donors","title":"Donors","type":"boolean"},"enable_advanced_rules":{"description":"Enable advanced JSON rules","title":"Enable Advanced Rules","type":"boolean"},"enable_age_restrictions":{"description":"Age registrations","title":"Enable Age Restrictions","type":"boolean"},"enable_custom_logic":{"description":"If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion","title":"Enable Custom Logic","type":"boolean"},"enable_entitlement_restrictions":{"description":"If set, then you must have certain entitlements","title":"Enable Entitlement Restrictions","type":"boolean"},"enable_expression":{"description":"Whether or not to enable an expression for evaluation","title":"Enable Expression","type":"boolean"},"enable_organization_restrictions":{"description":"If set, you can restrict organizations","title":"Enable Organization Restrictions","type":"boolean"},"enable_status_restriction":{"description":"If set, you can restrict by status","title":"Enable Status Restriction","type":"boolean"},"entitlement_restrictions":{"items":{"additionalProperties":false,"properties":{"quantity":{"description":"The quantity you must have","format":"float","title":"Quantity","type":"number"},"type_id":{"description":"The type of entitlement","title":"Type","type":"string"}},"required":["type_id"],"type":"object"},"type":"array"},"event_registration_options":{"additionalProperties":false,"properties":{"event_ids":{"items":{"type":"string"},"title":"Events","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"registration_category_ids":{"items":{"type":"string"},"title":"Registration Categories","type":"array"}},"title":"Event Registration Options","type":"object"},"event_registrations":{"description":"If set, only people who have registered for events","title":"Event Registrations","type":"boolean"},"expression":{"description":"The expression","title":"Expression","type":"string"},"expression_error_message":{"description":"The error message to show when the expression fails","title":"Expression Error Message","type":"string"},"location":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"countries":{"description":"Countries","items":{"type":"string"},"title":"Countries","type":"array"},"negate_logic":{"description":"If true, the logic in this section is negated; so NOT from these places","title":"Negate Logic","type":"boolean"}},"title":"Location","type":"object"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"chapter_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"chapter_ids":{"items":{"type":"string"},"title":"Chapters","type":"array"},"chapter_type_ids":{"items":{"type":"string"},"title":"Chapter Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Chapter Member Options","type":"object"},"chapter_members":{"description":"If set, active members who belong to a chapter can purchase","title":"Chapter Members","type":"boolean"},"member_package_ids":{"description":"The member package","items":{"type":"string"},"title":"Member Packages","type":"array"},"member_status_reason_ids":{"items":{"type":"string"},"title":"Member Status Reasons","type":"array"},"member_statuses":{"items":{"enum":["active","inactive","suspended"],"type":"string"},"title":"Member Statuses","type":"array"},"member_type_ids":{"description":"The member types","items":{"type":"string"},"title":"Member Types","type":"array"},"section_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"section_ids":{"items":{"type":"string"},"title":"Sections","type":"array"},"section_type_ids":{"items":{"type":"string"},"title":"Section Types","type":"array"}},"title":"Section Member Options","type":"object"},"section_members":{"description":"If set, active members who belong to a section can purchase","title":"Section Members","type":"boolean"}},"title":"Member Options","type":"object"},"members":{"description":"If set, active members can purchase this","title":"Members","type":"boolean"},"non_members":{"description":"If set, only nonmembers can purchase","title":"Non Members","type":"boolean"},"organization_restrictions":{"additionalProperties":false,"properties":{"contact_role_ids":{"items":{"type":"string"},"title":"Contact Roles","type":"array"},"organization_type_ids":{"items":{"type":"string"},"title":"Organization Types","type":"array"}},"title":"Organization Restrictions","type":"object"},"status_restrictions":{"description":"The statuses","items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Restrictions","type":"array"},"use_organization_for_eligibility":{"description":"If checked, a person's organization is used to check for eligibility, rather than the person themselves","title":"Use Organization For Eligibility","type":"boolean"}},"title":"Eligibility Criteria","type":"object"},"enable_coupon_ownership":{"description":"Enable the idea that a coupon can be owned by a contact/organization","title":"Enable Coupon Ownership","type":"boolean"},"enable_eligibility_criteria":{"description":"If true, eligibility criteria is applied to the coupon code","title":"Enable Eligibility Criteria","type":"boolean"},"enable_restricted_contacts":{"description":"If true, this coupon is restricted only to certain contacts","title":"Enable Restricted Contacts","type":"boolean"},"enable_restricted_organizations":{"description":"If true, this coupon is restricted only to certain organizations","title":"Enable Restricted Organizations","type":"boolean"},"id":{"description":"The unique, string identifier of this coupon code","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this coupon code is active","title":"Is Active","type":"boolean"},"maximum_number_of_total_uses":{"description":"The maximum number of total uses","minimum":1,"oneOf":[{"enum":[1]}],"title":"Maximum Number Of Total Uses","type":"integer"},"maximum_number_of_uses_per_customer":{"description":"The maximum number of total uses for a given customer","minimum":1,"oneOf":[{"enum":[1]}],"title":"Maximum Number Of Uses Per Customer","type":"integer"},"maximum_number_of_uses_per_organization":{"description":"The maximum number of total uses per contacts of an organization","minimum":1,"title":"Maximum Number Of Uses Per Organization","type":"integer"},"name":{"description":"The name of the coupon code - used to identify the owner","title":"Name","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"order_id":{"description":"The order id tied to this code","title":"Order","type":"string"},"order_line_item_id":{"title":"Order Line Item","type":"string"},"organization_id":{"description":"The organization","title":"Organization","type":"string"},"owner_type":{"description":"The owner of the code","enum":["contact","organization"],"oneOf":[{"type":"string"}],"title":"Owner Type","type":"string"},"restricted_contacts":{"items":{"additionalProperties":false,"properties":{"contact_id":{"title":"Contact","type":"string"}},"required":["contact_id"],"type":"object"},"minItems":1,"type":"array"},"restricted_organizations":{"items":{"additionalProperties":false,"properties":{"organization_id":{"title":"Organization","type":"string"}},"required":["organization_id"],"type":"object"},"minItems":1,"type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type":{"description":"The type of coupon","enum":["multi use","single use"],"title":"Type","type":"string"},"valid_from":{"description":"Date/time at which the code begins to be valid","format":"date-time","title":"Valid From","type":"string"},"valid_until":{"description":"Expiration date","format":"date-time","title":"Valid Until","type":"string"}},"required":["contact_id","coupon_id","coupon_type","eligibility_criteria","id","maximum_number_of_total_uses","maximum_number_of_uses_per_customer","organization_id","owner_type","restricted_contacts","restricted_organizations","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/CouponCodeGenProcess":{"id":"components/schemas/CouponCodeGenProcess","kind":"json-schema","title":"CouponCodeGenProcess","data":{"additionalProperties":false,"properties":{"code_template":{"description":"The pattern for determining the coupon code","pattern":"(.*[\\*\\@\\#].*){6,}","title":"Code Template","type":"string"},"confirmation_email":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Confirmation Email","type":"object"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"enable_confirmation_email":{"description":"If true, the user receives an email when the code has been assigned","title":"Enable Confirmation Email","type":"boolean"},"id":{"description":"The unique, string identifier of this coupon code gen process","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this coupon code gen process is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the coupon code gen process","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["code_template","confirmation_email","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/CouponUsage":{"id":"components/schemas/CouponUsage","kind":"json-schema","title":"CouponUsage","data":{"additionalProperties":false,"properties":{"contact_id":{"description":"The bill to contact","title":"Contact","type":"string"},"coupon_code_id":{"description":"The coupon code id","title":"Coupon Code","type":"string"},"coupon_id":{"description":"The coupon id","title":"Coupon","type":"string"},"coupon_type":{"description":"The type of coupon","title":"Coupon Type","type":"string"},"customer_id":{"description":"The customer ID, concatenated type and contact/org","title":"Customer","type":"string"},"date":{"description":"The order date/date of usage","format":"date-time","title":"Date","type":"string"},"discount":{"description":"The amount that this coupon usage discounted the order","format":"double","title":"Discount","type":"number"},"order_id":{"description":"The order","title":"Order","type":"string"},"order_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order #"},"children":[]}]}]}],"format":"float","title":"Order Number","type":"number"},"order_total":{"description":"The total amount of the order","format":"double","title":"Order Total","type":"number"},"organization_id":{"description":"The bill to organization","title":"Organization","type":"string"}},"type":"object"}},"components/schemas/CustomFieldValue":{"id":"components/schemas/CustomFieldValue","kind":"json-schema","title":"CustomFieldValue","data":{"additionalProperties":false,"properties":{"boolean_value":{"description":"The boolean value","title":"Boolean Value","type":"boolean"},"custom_field_id":{"description":"The unique identifier of the custom field","title":"Custom Field","type":"string"},"file_url_value":{"description":"The pointer to a file value","title":"File Url Value","type":"string"},"list_value":{"description":"The list value","items":{"type":"string"},"title":"List Value","type":"array"},"numeric_value":{"description":"The numeric value","format":"float","title":"Numeric Value","type":"number"},"string_value":{"description":"The string value of the custom field","title":"String Value","type":"string"},"table_value":{"description":"A list of objects (a table)","items":{"additionalProperties":false,"properties":{},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/DiscountProduct":{"id":"components/schemas/DiscountProduct","kind":"json-schema","title":"DiscountProduct","data":{"additionalProperties":false,"properties":{"business_unit_id":{"description":"The business unit of the product","title":"Business Unit","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this miscellaneous product","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether this product is active/used","title":"Is Active","type":"boolean"},"name":{"description":"The name of the miscellaneous product","title":"Name","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type":{"description":"The product type","enum":["commerce-discount-products"],"title":"Type","type":"string"}},"required":["business_unit_id","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Entitlement":{"id":"components/schemas/Entitlement","kind":"json-schema","title":"Entitlement","data":{"additionalProperties":false,"properties":{"contact_id":{"title":"Contact","type":"string"},"expiration_date":{"description":"The expiration of the entitlement","title":"Expiration Date","type":"string"},"id":{"description":"The unique, string identifier of this entitlement","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"notes":{"description":"Any notes for the entitlement","title":"Notes","type":"string"},"order_id":{"description":"The order ID that generated the entitlement","title":"Order","type":"string"},"order_line_item_id":{"description":"The order line item id that generated the entitlement","title":"Order Line Item","type":"string"},"order_line_item_quantity":{"description":"The quantity assigned per order line item quantity","format":"float","title":"Order Line Item Quantity","type":"number"},"organization_id":{"title":"Organization","type":"string"},"owner_type":{"description":"The type of owner","enum":["contact","organization"],"title":"Owner Type","type":"string"},"quantity":{"description":"The quantity of the entitlement","format":"float","title":"Quantity","type":"number"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type_id":{"description":"The entitlement type","title":"Type","type":"string"}},"required":["contact_id","id","organization_id","owner_type","quantity","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type_id"],"type":"object"}},"components/schemas/EntitlementType":{"id":"components/schemas/EntitlementType","kind":"json-schema","title":"EntitlementType","data":{"additionalProperties":false,"properties":{"id":{"description":"The unique, string identifier of this entitlement type","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this entitlement type is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the entitlement type","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/InventoryTransaction":{"id":"components/schemas/InventoryTransaction","kind":"json-schema","title":"InventoryTransaction","data":{"additionalProperties":false,"properties":{"bin_id":{"description":"The bin for this inventory","title":"Bin","type":"string"},"cancelled_commitment_id":{"description":"Self referencing inventory commitment for cancellations","title":"Cancelled Commitment","type":"string"},"cogs_quantity_remaining":{"description":"For receipts, the COGS quantity remaining ","format":"float","title":"Cogs Quantity Remaining","type":"number"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date of the transaction","format":"date-time","title":"Date","type":"string"},"ending_quantity":{"description":"For receipts, the ending quantity","format":"float","title":"Ending Quantity","type":"number"},"id":{"description":"The unique, string identifier of this inventory transaction","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"inventory_receipt_id":{"description":"Self referencing inventory receipt for adjustments","title":"Inventory Receipt","type":"string"},"invoice_number":{"description":"Invoice number for receipts/purchase orders","title":"Invoice Number","type":"string"},"is_defective":{"description":"Whether or not this is a defective transaction","title":"Is Defective","type":"boolean"},"notes":{"description":"Any important notes","title":"Notes","type":"string"},"order_id":{"anyOf":[{"x-required":true}],"description":"The order responsible for this transaction","title":"Order","type":"string"},"order_line_item_id":{"anyOf":[{"x-required":true}],"description":"The order line item responsible for this transaction","title":"Order Line Item","type":"string"},"product_id":{"description":"The ID of the product holding this inventory","title":"Product","type":"string"},"product_inventory_id":{"description":"The ID of the product inventory to which this transaction is tied","title":"Product Inventory","type":"string"},"product_sku":{"description":"The product SKU (optional)","title":"Product Sku","type":"string"},"product_type":{"description":"The type of product holding this inventory","title":"Product Type","type":"string"},"purchase_order_id":{"description":"For receipts, the purchase order","title":"Purchase Order","type":"string"},"quantity":{"description":"The quantity of this transaction","title":"Quantity","type":"integer"},"quantity_received":{"description":"The quantity received of a purchase order","format":"float","title":"Quantity Received","type":"number"},"related_transactions":{"items":{"additionalProperties":false,"properties":{"transaction_id":{"description":"The ID of the transaction","title":"Transaction","type":"string"},"type":{"description":"The type of transaction","title":"Type","type":"string"}},"type":"object"},"type":"array"},"return_id":{"description":"The return responsible for this transaction","title":"Return","type":"string"},"return_line_item_id":{"description":"The return line item responsible for this transaction","title":"Return Line Item","type":"string"},"shipment_id":{"description":"The shipment that generated this transaction","title":"Shipment","type":"string"},"starting_quantity":{"description":"For receipts, the starting quantity","format":"float","title":"Starting Quantity","type":"number"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_product_type_id":{"title":"Sys Product Type","type":"string"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"target_bin_id":{"description":"For transfers, the target bin","title":"Target Bin","type":"string"},"target_product_inventory_id":{"description":"For transfers, the target warehouse","title":"Target Product Inventory","type":"string"},"target_warehouse_id":{"description":"For transfers, the ID of the target warehouse","title":"Target Warehouse","type":"string"},"total_cost":{"description":"The total cost of the receipt","format":"double","title":"Total Cost","type":"number"},"transfer_id":{"description":"The ID of the transfer","title":"Transfer","type":"string"},"type":{"description":"The type of inventory","enum":["adjustment","backorder","commitment","fulfillment","purchase order","receipt","reservation","return","transfer"],"title":"Type","type":"string"},"unit_cost":{"description":"The unit cost","format":"double","title":"Unit Cost","type":"number"},"warehouse_id":{"description":"The ID of the warehouse for this product inventory","title":"Warehouse","type":"string"}},"required":["ending_quantity","id","product_id","product_inventory_id","product_type","purchase_order_id","quantity","quantity_received","return_id","return_line_item_id","starting_quantity","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","target_warehouse_id","type","warehouse_id"],"type":"object"}},"components/schemas/ListCancellationsResponse":{"id":"components/schemas/ListCancellationsResponse","kind":"json-schema","title":"ListCancellationsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Cancellation"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListCouponCodesResponse":{"id":"components/schemas/ListCouponCodesResponse","kind":"json-schema","title":"ListCouponCodesResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/CouponCode"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListCouponUsagesResponse":{"id":"components/schemas/ListCouponUsagesResponse","kind":"json-schema","title":"ListCouponUsagesResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/CouponUsage"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListEntitlementsResponse":{"id":"components/schemas/ListEntitlementsResponse","kind":"json-schema","title":"ListEntitlementsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Entitlement"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListInventoryTransactionsResponse":{"id":"components/schemas/ListInventoryTransactionsResponse","kind":"json-schema","title":"ListInventoryTransactionsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/InventoryTransaction"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListMerchandisePublicResponse":{"id":"components/schemas/ListMerchandisePublicResponse","kind":"json-schema","title":"ListMerchandisePublicResponse","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/MerchandiseShortPublic"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListOrdersResponse":{"id":"components/schemas/ListOrdersResponse","kind":"json-schema","title":"ListOrdersResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Order"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListProductInventoriesResponse":{"id":"components/schemas/ListProductInventoriesResponse","kind":"json-schema","title":"ListProductInventoriesResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/ProductInventory"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListReturnsResponse":{"id":"components/schemas/ListReturnsResponse","kind":"json-schema","title":"ListReturnsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Return"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListShipmentsResponse":{"id":"components/schemas/ListShipmentsResponse","kind":"json-schema","title":"ListShipmentsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Shipment"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListStandardQueryDefinitionsResponse":{"id":"components/schemas/ListStandardQueryDefinitionsResponse","kind":"json-schema","title":"ListStandardQueryDefinitionsResponse","data":{"items":{"$ref":"#/components/schemas/StandardQueryDefinition"},"type":"array"}},"components/schemas/Merchandise":{"id":"components/schemas/Merchandise","kind":"json-schema","title":"Merchandise","data":{"additionalProperties":false,"properties":{"additional_image_urls":{"description":"Additional images","items":{"type":"string"},"title":"Additional Image Urls","type":"array"},"allow_back_orders":{"description":"If this product is inventoried, whether or not inventories are allowed","title":"Allow Back Orders","type":"boolean"},"allow_customer_to_choose_installment_plan":{"description":"If true, the customer can choose their installment plan","title":"Allow Customer To Choose Installment Plan","type":"boolean"},"bulk_pricing_rules":{"items":{"additionalProperties":false,"properties":{"discount_amount":{"description":"The percentage/flat rate","format":"float","minimum":0,"title":"Discount Amount","type":"number"},"discount_type":{"description":"The type of discount rule","enum":["flat rate","percentage"],"title":"Discount Type","type":"string"},"ending_range":{"description":"The ending range of the rule","minimum":0,"title":"Ending Range","type":"integer"},"starting_range":{"description":"The starting range of the rule","minimum":0,"title":"Starting Range","type":"integer"}},"required":["discount_amount","discount_type"],"type":"object"},"minItems":1,"type":"array"},"bundled_products":{"items":{"additionalProperties":false,"properties":{"member_price":{"description":"The member price","format":"double","title":"Member Price","type":"number"},"price":{"description":"The price to bundle","format":"double","title":"Price","type":"number"},"product_id":{"description":"The product ID","title":"Product","type":"string"},"product_type":{"description":"The product type","title":"Product Type","type":"string"},"quantity":{"description":"The quantity to bundle","title":"Quantity","type":"integer"},"type":{"enum":["bundled product","inline bundled product"],"title":"Type","type":"string"}},"required":["product_id","product_type","quantity","type"],"type":"object"},"minItems":1,"type":"array"},"bundled_products_inventory_handling":{"description":"Whether to track inventory for the entire bundle, or for each product separately","enum":["bundle","each product"],"title":"Bundled Products Inventory Handling","type":"string"},"business_unit_id":{"description":"The business unit of the product","title":"Business Unit","type":"string"},"cancellation_fee":{"description":"Cancellation fees associated with this product","format":"double","title":"Cancellation Fee","type":"number"},"category_ids":{"description":"The categories that this merchandise is in","items":{"type":"string"},"title":"Categories","type":"array"},"commerce_entitlements_to_create":{"items":{"additionalProperties":false,"properties":{"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"quantity":{"description":"The quantity","format":"float","title":"Quantity","type":"number"},"relative_expiration_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"},"type_id":{"description":"The type of entitlement","title":"Type","type":"string"}},"required":["expiration_type","type_id"],"type":"object"},"type":"array"},"coupon_codes":{"items":{"additionalProperties":false,"properties":{"coupon_code_generation_process_id":{"description":"The process by which the coupons are generated","title":"Coupon Code Generation Process","type":"string"},"coupon_code_type":{"enum":["multi use","single use"],"title":"Coupon Code Type","type":"string"},"coupon_id":{"title":"Coupon","type":"string"},"coupon_type":{"title":"Coupon Type","type":"string"},"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"maximum_number_of_total_uses":{"description":"The maximum number of total uses","minimum":1,"oneOf":[{"enum":[1],"x-required":true}],"title":"Maximum Number Of Total Uses","type":"integer"},"maximum_number_of_uses_per_customer":{"description":"The maximum number of total uses for a given customer","minimum":1,"oneOf":[{"enum":[1],"x-required":true}],"title":"Maximum Number Of Uses Per Customer","type":"integer"},"quantity":{"description":"The number of coupons to generate","maximum":250,"title":"Quantity","type":"integer"},"relative_expiration_date":{"additionalProperties":false,"description":"Expiration date relative to purchase","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"},"restrict_to_contact":{"description":"If true, the code generated is restricted to the contact who made the purchase","title":"Restrict To Contact","type":"boolean"},"restrict_to_organization":{"description":"If true, the code generated is restricted to the organization made the purchase","title":"Restrict To Organization","type":"boolean"}},"required":["coupon_code_generation_process_id","coupon_code_type","coupon_id","coupon_type","quantity"],"type":"object"},"minItems":1,"type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"custom_pricing_options":{"additionalProperties":false,"properties":{"lambda_function_id":{"description":"The custom lambda function to use","title":"Lambda Function","type":"string"}},"required":["lambda_function_id"],"title":"Custom Pricing Options","type":"object"},"date_added":{"description":"The date that this product was added to inventory","title":"Date Added","type":"string"},"description":{"description":"Product description to be displayed on the portal","title":"Description","type":"string"},"document_entitlements_to_create":{"items":{"additionalProperties":false,"properties":{"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"file_cabinet_id":{"description":"The file cabinet","title":"File Cabinet","type":"string"},"item_id":{"description":"The item","title":"Item","type":"string"},"library_path":{"description":"The optional path that items will be mounted onto the digital library","title":"Library Path","type":"string"},"relative_expiration_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"}},"required":["expiration_type","file_cabinet_id"],"type":"object"},"type":"array"},"enable_bulk_pricing":{"description":"Whether or not bulk pricing is enabled","title":"Enable Bulk Pricing","type":"boolean"},"enable_bundled_products":{"description":"Whether to enable bundled products","title":"Enable Bundled Products","type":"boolean"},"enable_cancellation_fees":{"description":"Whether or not cancellation fees are applicable","title":"Enable Cancellation Fees","type":"boolean"},"enable_commerce_entitlement_creation":{"description":"If set, document entitlements will be created to access folders or documents","title":"Enable Commerce Entitlement Creation","type":"boolean"},"enable_coupon_code_generation":{"description":"If true, purchasing this product will generate coupons","title":"Enable Coupon Code Generation","type":"boolean"},"enable_custom_pricing":{"description":"If set, the order engine will call out to a custom lambda function for custom/complex pricing","title":"Enable Custom Pricing","type":"boolean"},"enable_document_entitlement_creation":{"description":"If set, document entitlements will be created to access folders or documents","title":"Enable Document Entitlement Creation","type":"boolean"},"enable_modifier_options":{"description":"When sent, customers can change products with customization modifiers","title":"Enable Modifier Options","type":"boolean"},"enable_product_confirmation_email":{"description":"If enabled, a custom email goes out whenever this product is ordered","title":"Enable Product Confirmation Email","type":"boolean"},"enable_purchase_limits":{"description":"If true, purchase limits are in place for this product","title":"Enable Purchase Limits","type":"boolean"},"enable_purchasing_eligibility":{"description":"If set, purchases of this merchandise are restricted","title":"Enable Purchasing Eligibility","type":"boolean"},"enable_restocking_fees":{"description":"Whether or not restocking fees are enabled","title":"Enable Restocking Fees","type":"boolean"},"enable_special_prices":{"description":"Whether to enable special pricing logic","title":"Enable Special Prices","type":"boolean"},"enable_task_generation":{"description":"If set, tasks will be generated","title":"Enable Task Generation","type":"boolean"},"enable_variant_options":{"description":"When sent, customers can change products with variant options","title":"Enable Variant Options","type":"boolean"},"featured_options":{"additionalProperties":false,"properties":{"featured_from":{"description":"Date from which this product should be featured","format":"date-time","title":"Featured From","type":"string"},"featured_until":{"description":"Date until which this product should be featured","format":"date-time","title":"Featured Until","type":"string"}},"title":"Featured Options","type":"object"},"featured_product":{"description":"Whether this is a featured product","title":"Featured Product","type":"boolean"},"foreign_currency_prices":{"items":{"additionalProperties":false,"properties":{"cancellation_fee":{"description":"The cancellation fee of the product for this currency","format":"double","title":"Cancellation Fee","type":"number"},"currency_code":{"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"title":"Currency Code","type":"string"},"member_price":{"description":"The price of the product for a member","format":"double","title":"Member Price","type":"number"},"mode":{"description":"How this foreign currency should be treated","enum":["calculate price","prohibit purchase","set price"],"title":"Mode","type":"string"},"price":{"description":"The price of the product","format":"double","oneOf":[{"x-required":true}],"title":"Price","type":"number"},"restocking_fee":{"description":"The restocking fee of the product for this currency","format":"double","title":"Restocking Fee","type":"number"}},"required":["currency_code"],"type":"object"},"type":"array"},"hide_from_portal":{"description":"If set, this product should not be shown in the portal","title":"Hide From Portal","type":"boolean"},"id":{"description":"The unique, string identifier of this miscellaneous product","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"image_url":{"description":"Image to be displayed of the product","title":"Image Url","type":"string"},"installment_plan_options":{"items":{"additionalProperties":false,"properties":{"additional_cost":{"description":"The additional cost of the installment plan","format":"double","title":"Additional Cost","type":"number"},"installment_plan_id":{"description":"The installment plan that this product supports","title":"Installment Plan","type":"string"},"is_default":{"description":"Whether this is the default installment plan option","title":"Is Default","type":"boolean"}},"required":["installment_plan_id"],"type":"object"},"minItems":1,"type":"array"},"is_active":{"description":"Whether this product is active/used","title":"Is Active","type":"boolean"},"member_price":{"description":"The price of the product for an active member","format":"double","title":"Member Price","type":"number"},"modifier_options":{"items":{"additionalProperties":false,"properties":{"ad_hoc_modifier_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"default_value":{"description":"The default value","title":"Default Value","type":"string"},"enable_character_restriction":{"description":"If true, the UI will restrict the number of characters","title":"Enable Character Restriction","type":"boolean"},"id":{"description":"The id of the modifier option","title":"ID","type":"string"},"maximum_number_of_characters":{"description":"The maximum number of characters","format":"float","oneOf":[{"x-required":true}],"title":"Maximum Number Of Characters","type":"number"},"name":{"description":"The name of the modifier option","title":"Name","type":"string"},"type":{"enum":["checkbox","date","dropdown","text"],"title":"Type","type":"string"},"values":{"items":{"type":"string"},"oneOf":[{"x-required":true}],"title":"Values","type":"array"}},"required":["id","name","type"],"title":"Ad Hoc Modifier Options","type":"object"},"required":{"description":"Whether this option is required","title":"Required","type":"boolean"},"shared_modifier_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"shared_modifier_option_id":{"title":"Shared Modifier Option","type":"string"}},"required":["shared_modifier_option_id"],"title":"Shared Modifier Options","type":"object"},"type":{"enum":["ad hoc","shared"],"title":"Type","type":"string"}},"type":"object"},"minItems":1,"type":"array"},"modifier_rules":{"items":{"additionalProperties":false,"properties":{"enable_price_adjustment":{"description":"Whether or not this rule being triggered should adjust the price","title":"Enable Price Adjustment","type":"boolean"},"enable_weight_adjustment":{"description":"Whether or not this rule being triggered should adjust the price","title":"Enable Weight Adjustment","type":"boolean"},"option_id":{"description":"The ID of the modifier option","title":"Option","type":"string"},"price_adjustment_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"affects":{"enum":["both","member price","price"],"title":"Affects","type":"string"},"amount":{"description":"The adjustment amount","format":"float","title":"Amount","type":"number"},"operation":{"enum":["add","multiply","subtract"],"title":"Operation","type":"string"}},"required":["amount"],"title":"Price Adjustment Options","type":"object"},"trigger_values":{"description":"The values that trigger this rule for dropdown/multiple choice ","items":{"type":"string"},"title":"Trigger Values","type":"array"},"weight_adjustment_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"amount":{"description":"The adjustment amount","format":"float","title":"Amount","type":"number"},"operation":{"enum":["add","multiply","subtract"],"title":"Operation","type":"string"}},"required":["amount"],"title":"Weight Adjustment Options","type":"object"}},"required":["option_id"],"type":"object"},"type":"array"},"name":{"description":"The name of the miscellaneous product","title":"Name","type":"string"},"new_until":{"description":"The date/time until which this merchandise is new","format":"date-time","title":"New Until","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"portal_options":{"additionalProperties":false,"properties":{"available_from":{"description":"The date from which this product should be available","format":"date-time","title":"Available From","type":"string"},"available_until":{"description":"The date until which this product should be available","format":"date-time","title":"Available Until","type":"string"}},"title":"Portal Options","type":"object"},"price":{"description":"The price of the product","format":"double","title":"Price","type":"number"},"product_confirmation_email_options":{"additionalProperties":false,"properties":{"product_confirmation_email_id":{"oneOf":[{"x-required":true}],"title":"Product Confirmation Email","type":"string"},"product_specific_email":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Product Specific Email","type":"object"},"type":{"enum":["product specific","shared"],"title":"Type","type":"string"}},"title":"Product Confirmation Email Options","type":"object"},"publish_to_portal":{"description":"Whether or not this product should be available in the portal","title":"Publish To Portal","type":"boolean"},"purchase_limits":{"additionalProperties":false,"properties":{"error_message":{"description":"The error message to show","title":"Error Message","type":"string"},"maximum":{"description":"The maximum","format":"float","title":"Maximum","type":"number"},"relative_time_window":{"additionalProperties":false,"description":"the time window","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Time Window","type":"object"},"time_period":{"enum":["all time","sliding time window"],"title":"Time Period","type":"string"},"type":{"enum":["per customer"],"title":"Type","type":"string"}},"required":["maximum","time_period","type"],"title":"Purchase Limits","type":"object"},"purchasing_eligibility_criteria":{"title":"Purchasing Eligibility Criteria","type":"object"},"reorder_point":{"description":"The point at which this product should be reordered","title":"Reorder Point","type":"integer"},"restocking_fee":{"description":"Cancellation fees associated with this product","format":"double","title":"Restocking Fee","type":"number"},"sellable_from":{"description":"Date/time from which this product is sellable","format":"date-time","title":"Sellable From","type":"string"},"sellable_until":{"description":"Date/time until which this product is sellable","format":"date-time","title":"Sellable Until","type":"string"},"shippable":{"description":"Whether or not this product is eligible for shipping charges","title":"Shippable","type":"boolean"},"sort_order":{"description":"The sort order of hte product","format":"float","title":"Sort Order","type":"number"},"special_prices":{"items":{"additionalProperties":false,"properties":{"criteria":{"title":"Criteria","type":"object"},"enable_formula":{"description":"if set, a formula is used to calculate the price. If the formula fails, the price is used","title":"Enable Formula","type":"boolean"},"formula":{"description":"The formula evaluated using the expr-eval npm package","oneOf":[{"x-required":true}],"title":"Formula","type":"string"},"name":{"title":"Name","type":"string"},"price":{"format":"float","title":"Price","type":"number"}},"required":["criteria","price"],"type":"object"},"minItems":1,"type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"tasks_to_generate":{"items":{"additionalProperties":false,"properties":{"assignee_type":{"enum":["assignment role","queue","user"],"title":"Assignee Type","type":"string"},"assignment_role_id":{"description":"The assignment role that should receive the ask","oneOf":[{"x-required":true}],"title":"Assignment Role","type":"string"},"description":{"description":"A description","title":"Description","type":"string"},"due_date_type":{"description":"Whether there is a due date","enum":["none","relative date","specific date"],"title":"Due Date Type","type":"string"},"name":{"description":"The name of the task","title":"Name","type":"string"},"notify_assignees":{"description":"Notify assignee when the task is created","title":"Notify Assignees","type":"boolean"},"priority":{"enum":["high","low","normal","urgent"],"title":"Priority","type":"string"},"queue_id":{"description":"The queue that should be assigned the ask","oneOf":[{"x-required":true}],"title":"Queue","type":"string"},"relative_due_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Due Date","type":"object"},"specific_due_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Specific Due Date","type":"string"},"type_id":{"description":"The type of task","title":"Type","type":"string"},"user_id":{"description":"The user that should be assigned the ask","oneOf":[{"x-required":true}],"title":"User","type":"string"}},"required":["assignee_type","due_date_type","name","type_id"],"type":"object"},"type":"array"},"track_inventory":{"description":"Whether or not inventory on this product is tracked","title":"Track Inventory","type":"boolean"},"track_inventory_by":{"enum":["product","sku"],"title":"Track Inventory By","type":"string"},"type":{"description":"The product type","enum":["commerce-merchandise"],"title":"Type","type":"string"},"variant_options":{"items":{"additionalProperties":false,"properties":{"ad_hoc_variant_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"default_value":{"description":"The default value","title":"Default Value","type":"string"},"id":{"description":"The id of the variant","title":"ID","type":"string"},"name":{"description":"The name of the variant","title":"Name","type":"string"},"type":{"enum":["dropdown","radio buttons","rectangle list","swatch"],"title":"Type","type":"string"},"values":{"items":{"type":"string"},"title":"Values","type":"array"}},"required":["id","name","type"],"title":"Ad Hoc Variant Options","type":"object"},"shared_variant_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"shared_variant_option_id":{"title":"Shared Variant Option","type":"string"}},"required":["shared_variant_option_id"],"title":"Shared Variant Options","type":"object"},"type":{"enum":["ad hoc","shared"],"title":"Type","type":"string"}},"type":"object"},"minItems":1,"type":"array"},"variants":{"items":{"additionalProperties":false,"properties":{"image_uri":{"description":"An optional image for this variant","title":"Image Uri","type":"string"},"member_price":{"description":"The member price of this variant, if different than the base","format":"float","title":"Member Price","type":"number"},"not_purchasable":{"description":"Whether or not this is purchasable","title":"Not Purchasable","type":"boolean"},"options":{"description":"The list of variant options that comprise this variant","items":{"additionalProperties":false,"properties":{"option_id":{"description":"The option","title":"Option","type":"string"},"value":{"description":"The value","title":"Value","type":"string"}},"required":["option_id","value"],"type":"object"},"minItems":1,"type":"array"},"price":{"description":"The price of this variant, if different than the base","format":"float","title":"Price","type":"number"},"sku":{"description":"The SKU","title":"Sku","type":"string"},"weight":{"description":"The weight of this variant, if different than the base","format":"float","title":"Weight","type":"number"}},"required":["options"],"type":"object"},"type":"array"},"weight":{"description":"The weight of the product","format":"float","title":"Weight","type":"number"}},"required":["bulk_pricing_rules","bundled_products","business_unit_id","coupon_codes","custom_pricing_options","id","installment_plan_options","modifier_options","name","price","product_confirmation_email_options","purchase_limits","special_prices","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","variant_options"],"type":"object"}},"components/schemas/MerchandisePublic":{"id":"components/schemas/MerchandisePublic","kind":"json-schema","title":"MerchandisePublic","data":{"additionalProperties":false,"properties":{"additional_image_urls":{"description":"Additional images","items":{"type":"string"},"title":"Additional Image Urls","type":"array"},"business_unit_id":{"description":"The biz unit","title":"Business Unit","type":"string"},"category_ids":{"description":"The categories to which this product belongs","items":{"type":"string"},"title":"Categories","type":"array"},"date_added":{"description":"The date that this product was added to inventory","title":"Date Added","type":"string"},"description":{"description":"Product description to be displayed on the portal","title":"Description","type":"string"},"enable_special_prices":{"description":"Special prices are are enabled","title":"Enable Special Prices","type":"boolean"},"id":{"description":"The unique identifier of the merchandise","title":"ID","type":"string"},"image_url":{"description":"Image to be displayed of the product","title":"Image Url","type":"string"},"is_featured":{"description":"Whether this product is featured","title":"Is Featured","type":"boolean"},"is_new":{"description":"Whether this product is new","title":"Is New","type":"boolean"},"member_price":{"description":"The price of the product for an active member in the store currency","format":"double","title":"Member Price","type":"number"},"modifier_options":{"items":{"additionalProperties":false,"properties":{"default_value":{"description":"The default value","title":"Default Value","type":"string"},"enable_character_restriction":{"description":"If true, the UI will restrict the number of characters","title":"Enable Character Restriction","type":"boolean"},"id":{"description":"The id of the modifier option","title":"ID","type":"string"},"maximum_number_of_characters":{"description":"The maximum number of characters","format":"float","title":"Maximum Number Of Characters","type":"number"},"name":{"description":"The name of the modifier option","title":"Name","type":"string"},"required":{"description":"Whether this option is required","title":"Required","type":"boolean"},"type":{"enum":["checkbox","date","dropdown","multiple choice","text"],"title":"Type","type":"string"},"values":{"items":{"type":"string"},"title":"Values","type":"array"}},"required":["id","name","type"],"type":"object"},"type":"array"},"name":{"description":"The name of the merchandise","title":"Name","type":"string"},"price":{"description":"The price of the product in the store currency","format":"double","title":"Price","type":"number"},"sellable_from":{"description":"Date/time from which this product is sellable","format":"date-time","title":"Sellable From","type":"string"},"sellable_until":{"description":"Date/time until which this product is sellable","format":"date-time","title":"Sellable Until","type":"string"},"sort_order":{"description":"The sort order of hte product","format":"float","title":"Sort Order","type":"number"},"track_inventory":{"description":"Whether inventory is tracked","title":"Track Inventory","type":"boolean"},"variant_options":{"items":{"additionalProperties":false,"properties":{"default_value":{"description":"The default value","title":"Default Value","type":"string"},"id":{"description":"The id of the variant","title":"ID","type":"string"},"name":{"description":"The name of the variant","title":"Name","type":"string"},"type":{"enum":["dropdown","radio buttons","rectangle list","swatch"],"title":"Type","type":"string"},"values":{"items":{"type":"string"},"title":"Values","type":"array"}},"required":["id","name","type"],"type":"object"},"type":"array"},"variants":{"items":{"additionalProperties":false,"properties":{"image_uri":{"description":"An optional image for this variant","title":"Image Uri","type":"string"},"member_price":{"description":"The member price of this variant, if different than the base","format":"float","title":"Member Price","type":"number"},"not_purchasable":{"description":"Whether or not this is purchasable","title":"Not Purchasable","type":"boolean"},"options":{"description":"The list of variant options that comprise this variant","items":{"additionalProperties":false,"properties":{"option_id":{"title":"Option","type":"string"},"value":{"title":"Value","type":"string"}},"type":"object"},"minItems":1,"type":"array"},"price":{"description":"The price of this variant, if different than the base","format":"float","title":"Price","type":"number"},"sku":{"description":"The SKU","title":"Sku","type":"string"}},"required":["options"],"type":"object"},"type":"array"}},"required":["price"],"type":"object"}},"components/schemas/MerchandiseSearchParameters":{"id":"components/schemas/MerchandiseSearchParameters","kind":"json-schema","title":"MerchandiseSearchParameters","data":{"additionalProperties":false,"properties":{"category_id":{"items":{"type":"string"},"title":"Category","type":"array"},"id":{"items":{"type":"string"},"title":"ID","type":"array"},"member_price":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Member Price","type":"array"},"price":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Price","type":"array"},"track_inventory":{"title":"Track Inventory","type":"boolean"},"weight":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Weight","type":"array"}},"type":"object"}},"components/schemas/MerchandiseSearchResults":{"id":"components/schemas/MerchandiseSearchResults","kind":"json-schema","title":"MerchandiseSearchResults","data":{"additionalProperties":false,"properties":{"allow_back_orders":{"description":"If this product is inventoried, whether or not inventories are allowed","title":"Allow Back Orders","type":"boolean"},"allow_customer_to_choose_installment_plan":{"title":"Allow Customer To Choose Installment Plan","type":"boolean"},"category_ids":{"description":"The categories that this merchandise is in","items":{"type":"string"},"title":"Categories","type":"array"},"enable_bulk_pricing":{"description":"Whether or not bulk pricing is enabled","title":"Enable Bulk Pricing","type":"boolean"},"enable_cancellation_fees":{"title":"Enable Cancellation Fees","type":"boolean"},"enable_modifier_options":{"description":"When sent, customers can change products with customization modifiers","title":"Enable Modifier Options","type":"boolean"},"enable_purchasing_eligibility":{"title":"Enable Purchasing Eligibility","type":"boolean"},"enable_restocking_fees":{"description":"Whether or not restocking fees are enabled","title":"Enable Restocking Fees","type":"boolean"},"enable_variant_options":{"description":"When sent, customers can change products with variant options","title":"Enable Variant Options","type":"boolean"},"is_active":{"title":"Is Active","type":"boolean"},"member_price":{"format":"float","title":"Member Price","type":"number"},"new_until":{"description":"The date/time until which this merchandise is new","format":"date-time","title":"New Until","type":"string"},"price":{"format":"float","title":"Price","type":"number"},"publish_to_portal":{"title":"Publish To Portal","type":"boolean"},"shippable":{"description":"Whether or not this product is eligible for shipping charges","title":"Shippable","type":"boolean"},"track_inventory":{"title":"Track Inventory","type":"boolean"},"track_inventory_by":{"enum":["product","sku"],"title":"Track Inventory By","type":"string"},"weight":{"description":"The weight of the product","format":"float","title":"Weight","type":"number"}},"type":"object"}},"components/schemas/MerchandiseShortPublic":{"id":"components/schemas/MerchandiseShortPublic","kind":"json-schema","title":"MerchandiseShortPublic","data":{"additionalProperties":false,"properties":{"category_ids":{"description":"The categories to which this product belongs","items":{"type":"string"},"title":"Categories","type":"array"},"date_added":{"description":"The date that this product was added to inventory","title":"Date Added","type":"string"},"enable_special_prices":{"description":"Special prices are are enabled","title":"Enable Special Prices","type":"boolean"},"id":{"description":"The unique identifier of the merchandise","title":"ID","type":"string"},"image_url":{"description":"Image to be displayed of the product","title":"Image Url","type":"string"},"is_featured":{"description":"Whether this product is featured","title":"Is Featured","type":"boolean"},"is_new":{"description":"Whether this product is new","title":"Is New","type":"boolean"},"member_price":{"description":"The price of the product for an active member in the store currency","format":"double","title":"Member Price","type":"number"},"name":{"description":"The name of the merchandise","title":"Name","type":"string"},"price":{"description":"The price of the product in the store currency","format":"double","title":"Price","type":"number"},"sellable_from":{"description":"Date/time from which this product is sellable","format":"date-time","title":"Sellable From","type":"string"},"sellable_until":{"description":"Date/time until which this product is sellable","format":"date-time","title":"Sellable Until","type":"string"},"sort_order":{"description":"The sort order of hte product","format":"float","title":"Sort Order","type":"number"}},"required":["price"],"type":"object"}},"components/schemas/Order":{"id":"components/schemas/Order","kind":"json-schema","title":"Order","data":{"additionalProperties":false,"properties":{"additional_email_confirmation_recipients":{"description":"Additional emails to send confirmation","items":{"type":"string"},"title":"Additional Email Confirmation Recipients","type":"array"},"additional_payments":{"items":{"additionalProperties":false,"properties":{"line_item_ids":{"description":"The order line items that this additional payment should apply to","items":{"type":"string"},"title":"Line Items","type":"array"},"payment_info":{"additionalProperties":false,"properties":{"electronic_payment_info":{"additionalProperties":false,"description":"The electronic payment/card info","oneOf":[{"x-required":true}],"properties":{"card_expiration":{"description":"The card expiration","format":"date","title":"Card Expiration","type":"string"},"card_type":{"description":"The type of card being used, or CHECK if electronic check","enum":["american express","discover","electronic check","mastercard","other","visa"],"title":"Card Type","type":"string"},"merchant_account_id":{"description":"The merchant account to use for this payment","title":"Merchant Account","type":"string"},"merchant_account_tokens":{"items":{"additionalProperties":false,"properties":{"merchant_account_id":{"description":"The merchant account id","title":"Merchant Account","type":"string"},"token":{"description":"The token representing the card/electronic check info","title":"Token","type":"string"}},"required":["merchant_account_id","token"],"type":"object"},"minItems":1,"type":"array"},"payment_account":{"description":"The masked payment account information","title":"Payment Account","type":"string"},"payment_origin":{"description":"Whether or not this is a saved payment method","enum":["ad hoc","saved","single token"],"title":"Payment Origin","type":"string"},"token":{"description":"For integrated payments, the single token","title":"Token","type":"string"}},"required":["payment_origin"],"title":"Electronic Payment Info","type":"object"},"non_electronic_payment_info":{"additionalProperties":false,"description":"Payment info for non-electronic payments","properties":{"bank_account_id":{"description":"The bank account being used for the order","title":"Bank Account","type":"string"},"reference_number":{"description":"The reference number for the payment, if applicable","title":"Reference Number","type":"string"}},"title":"Non Electronic Payment Info","type":"object"},"type":{"description":"The type of payment","enum":["ach","cash","cashiers check","check","credit card","electronic check","money order","offline credit card","payroll deduction","purchase order","store credit","wire transfer"],"title":"Type","type":"string"}},"required":["type"],"title":"Payment Info","type":"object"}},"type":"object"},"minItems":1,"type":"array"},"amount_paid":{"description":"Amount paid on the order","format":"double","title":"Amount Paid","type":"number"},"amount_pending_capture":{"description":"The amount that has been authorized, but not yet captured","format":"double","title":"Amount Pending Capture","type":"number"},"amount_refunded":{"description":"Amount refunded on the order","format":"double","title":"Amount Refunded","type":"number"},"balance_due":{"description":"Balance due on the order","format":"double","title":"Balance Due","type":"number"},"base_currency_code":{"title":"Base Currency Code","type":"string"},"base_currency_symbol":{"title":"Base Currency Symbol","type":"string"},"batch_id":{"description":"The batch the order should be in","title":"Batch","type":"string"},"bill_parent_organization":{"description":"If true, the parent organization is billed","title":"Bill Parent Organization","type":"boolean"},"bill_to_contact_id":{"description":"The contact being billed","title":"Bill To Contact","type":"string"},"bill_to_organization_id":{"description":"The organization being billed","title":"Bill To Organization","type":"string"},"bill_to_type":{"description":"The type of customer being billed","enum":["contact","organization"],"title":"Bill To Type","type":"string"},"billing_address":{"$ref":"#/components/schemas/Address"},"billing_run_action_id":{"description":"The billing run action that created this order; we track it here only to pass it back through the billing service","title":"Billing Run Action","type":"string"},"billing_run_id":{"description":"If this is part of a billing run, the ID ","title":"Billing Run","type":"string"},"billing_run_service":{"description":"If this order was generated by a billing run, the service that initiated it","title":"Billing Run Service","type":"string"},"business_unit_id":{"description":"The business unit of the order","title":"Business Unit","type":"string"},"copy_shipping_info_from_billing_info":{"description":"Indicates that the shipping information was copied from the billing info. For reporting use only","title":"Copy Shipping Info From Billing Info","type":"boolean"},"coupons":{"items":{"additionalProperties":false,"properties":{"coupon_code_id":{"description":"The coupon code","title":"Coupon Code","type":"string"},"coupon_id":{"description":"The ID of the coupon backing the coupon code","title":"Coupon","type":"string"},"coupon_type":{"description":"The type of coupon represented by the coupon code","title":"Coupon Type","type":"string"},"discount":{"description":"The amount that was discounted","format":"double","title":"Discount","type":"number"},"order_line_item_ids":{"description":"The line items that the coupon acted on","items":{"type":"string"},"title":"Order Line Items","type":"array"},"retroactive_application_date":{"description":"If applied retroactively, the date of application","format":"date-time","title":"Retroactive Application Date","type":"string"}},"required":["coupon_code_id"],"type":"object"},"type":"array"},"credit_usages":{"description":"Credits to use when paying the invoices on this order","items":{"additionalProperties":false,"properties":{"amount_to_use":{"description":"The amount of credit to apply","format":"double","title":"Amount To Use","type":"number"},"credit_id":{"description":"The ID of the credit to use","title":"Credit","type":"string"}},"required":["amount_to_use","credit_id"],"type":"object"},"type":"array"},"currency_code":{"description":"The order currency","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"title":"Currency Code","type":"string"},"currency_symbol":{"description":"The currency symbol","title":"Currency Symbol","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"custom_metadata":{"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom metadata that can be used by custom order generation processes for hyper-customized order & invoice forms"},"children":[]}]}]}],"properties":{},"title":"Custom Metadata","type":"object"},"date":{"description":"The date of the order","title":"Date","type":"string"},"default_merchant_account_id":{"description":"The default, calculated merchant account id","title":"Default Merchant Account","type":"string"},"discounts":{"description":"Amount of discounts for the order","format":"double","title":"Discounts","type":"number"},"do_not_apply_open_credits":{"description":"If set, open credits are not applied to this order","title":"Do Not Apply Open Credits","type":"boolean"},"duplicate_prevention_key":{"description":"Temporary value used to prevent duplicate submissions","title":"Duplicate Prevention Key","type":"string"},"event_id":{"description":"The event","title":"Event","type":"string"},"exchange_rate":{"description":"The exchange rate, if applicable","format":"double","title":"Exchange Rate","type":"number"},"expiration_date":{"description":"The deadline after which this order is no longer valid. Used by generateOrder routines to restrict how long before this order can not longer be processes. Example: exhibitor-registration.generateOrder","format":"date-time","title":"Expiration Date","type":"string"},"failure_notice_id":{"description":"The billing notice to run when this order succeeds; we track it here only to pass it back through the billing service","title":"Failure Notice","type":"string"},"id":{"description":"The unique, string identifier of this order","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"installment_schedule_id":{"description":"If this is tied to an installment schedule","title":"Installment Schedule","type":"string"},"invoice_terms_id":{"description":"The terms to be used for generating the invoice","title":"Invoice Terms","type":"string"},"line_items":{"items":{"additionalProperties":false,"properties":{"amount_paid":{"description":"Amount paid on the order item","format":"double","oneOf":[{"x-required":true}],"title":"Amount Paid","type":"number"},"amount_pending_capture":{"description":"The amount that has been authorized, but not yet captured on this item","format":"double","oneOf":[{"x-required":true}],"title":"Amount Pending Capture","type":"number"},"amount_refunded":{"description":"Amount refunded on the order  item","format":"double","oneOf":[{"x-required":true}],"title":"Amount Refunded","type":"number"},"amount_to_pay_upon_creation":{"description":"The amount of this item that should be paid immediately","format":"double","oneOf":[{"x-required":true}],"title":"Amount To Pay Upon Creation","type":"number"},"balance_due":{"description":"Balance due on the order item","format":"double","oneOf":[{"x-required":true}],"title":"Balance Due","type":"number"},"bundled_product_1":{"additionalProperties":false,"properties":{"amount":{"description":"The amount of the bundled product","format":"float","title":"Amount","type":"number"},"product_id":{"description":"The bundled product ID","title":"Product","type":"string"},"product_type":{"description":"The bundled product type","title":"Product Type","type":"string"}},"required":["amount","product_id","product_type"],"title":"Bundled Product 1","type":"object"},"bundled_product_2":{"additionalProperties":false,"properties":{"amount":{"description":"The amount of the bundled product","format":"float","title":"Amount","type":"number"},"product_id":{"description":"The bundled product ID","title":"Product","type":"string"},"product_type":{"description":"The bundled product type","title":"Product Type","type":"string"}},"required":["amount","product_id","product_type"],"title":"Bundled Product 2","type":"object"},"description":{"description":"Optional description of the line item","title":"Description","type":"string"},"discounts":{"description":"Any discounts set on the order item","format":"double","oneOf":[{"x-required":true}],"title":"Discounts","type":"number"},"has_inline_bundled_products":{"description":"If true, this line item has inline products bundled with it","title":"Has Inline Bundled Products","type":"boolean"},"inline_bundled_products":{"items":{"additionalProperties":false,"properties":{"amount":{"description":"The amount of the bundled product","format":"float","title":"Amount","type":"number"},"product_id":{"description":"The bundled product ID","title":"Product","type":"string"},"product_type":{"description":"The bundled product type","title":"Product Type","type":"string"}},"required":["amount","product_id","product_type"],"type":"object"},"minItems":1,"oneOf":[{"x-required":true}],"type":"array"},"installment_plan_id":{"description":"The installment plan to use for this item","oneOf":[{"x-required":true}],"title":"Installment Plan","type":"string"},"installment_schedule_type":{"description":"If creating an installment plan, the type to create","enum":["based on installment plan","perpetual"],"title":"Installment Schedule Type","type":"string"},"modifier_options":{"items":{"additionalProperties":false,"properties":{"option_id":{"description":"The modifier option ID","title":"Option","type":"string"},"option_name":{"title":"Option Name","type":"string"},"value":{"description":"The value of the option","title":"Value","type":"string"}},"required":["option_id"],"type":"object"},"type":"array"},"optional":{"description":"Whether or not this is an \"optional\" item","title":"Optional","type":"boolean"},"order_line_item_id":{"description":"A unique identifier for the order item","oneOf":[{"x-required":true}],"title":"Order Line Item","type":"string"},"override_ship_to_contact_id":{"description":"The contact being shipped to","oneOf":[{"x-required":true}],"title":"Override Ship To Contact","type":"string"},"override_ship_to_organization_id":{"description":"The organization being shipped to","oneOf":[{"x-required":true}],"title":"Override Ship To Organization","type":"string"},"override_ship_to_type":{"description":"The type of customer being shipped to","enum":["contact","organization"],"title":"Override Ship To Type","type":"string"},"parent_line_item_id":{"description":"If this is a linked item, the parent linkage","title":"Parent Line Item","type":"string"},"parent_order_line_item_id":{"description":"The parent item, if applicable","title":"Parent Order Line Item","type":"string"},"payload":{"additionalProperties":false,"description":"Any optional order payload for processing; used by some fulfillment processes (like event registration modification) to support transient objects","properties":{},"title":"Payload","type":"object"},"payload_id":{"description":"Product specific payload used by the product service to process/fulfill the order","title":"Payload","type":"string"},"perpetual_installment_schedule_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"end_date":{"description":"Optional end date","title":"End Date","type":"string"},"number_of_units":{"description":"Number of units","format":"float","minimum":1,"title":"Number Of Units","type":"number"},"unit_of_time":{"enum":["months","quarters","weeks","years"],"title":"Unit Of Time","type":"string"}},"required":["number_of_units","unit_of_time"],"title":"Perpetual Installment Schedule Options","type":"object"},"product_id":{"description":"The id of the product","title":"Product","type":"string"},"product_type":{"description":"The type of product","title":"Product Type","type":"string"},"quantity":{"description":"The quantity of the order item","title":"Quantity","type":"integer"},"quantity_available_for_cancellation":{"description":"The quantity of the order item that can be cancelled","oneOf":[{"x-required":true}],"title":"Quantity Available For Cancellation","type":"integer"},"quantity_available_for_return":{"description":"The quantity of the order item that can be returned","oneOf":[{"x-required":true}],"title":"Quantity Available For Return","type":"integer"},"quantity_cancelled":{"description":"The quantity of the order item that has been cancelled","oneOf":[{"x-required":true}],"title":"Quantity Cancelled","type":"integer"},"quantity_pending_return":{"description":"The quantity of the order item that is pending return","oneOf":[{"x-required":true}],"title":"Quantity Pending Return","type":"integer"},"quantity_returned":{"description":"The quantity of the order item that has been returned","oneOf":[{"x-required":true}],"title":"Quantity Returned","type":"integer"},"quantity_shipped":{"description":"The quantity of the order item that has been shipped","oneOf":[{"x-required":true}],"title":"Quantity Shipped","type":"integer"},"quantity_to_be_shipped":{"description":"The quantity that is available to be shipped","title":"Quantity To Be Shipped","type":"integer"},"related_record_id":{"description":"The record related to this order","title":"Related Record","type":"string"},"related_record_type":{"description":"If theres a record related to this order, list it here","title":"Related Record Type","type":"string"},"related_transactions":{"items":{"additionalProperties":false,"properties":{"amount":{"description":"The amount applied","format":"double","title":"Amount","type":"number"},"date":{"description":"The date/time of the transaction","format":"date-time","title":"Date","type":"string"},"transaction_id":{"description":"The id of the transaction","title":"Transaction","type":"string"},"transaction_line_item_id":{"description":"The line item id of the transaction","title":"Transaction Line Item","type":"string"},"transaction_number":{"description":"The number of the transaction","format":"float","title":"Transaction Number","type":"number"},"type":{"enum":["cancellation","credit","credit memo","credit usage","debit memo","invoice","payment","refund","return","shipment","write off"],"title":"Type","type":"string"}},"required":["amount","date","transaction_id","transaction_line_item_id","transaction_number"],"type":"object"},"type":"array"},"shippable":{"description":"Whether or not this item needs to be shipped","title":"Shippable","type":"boolean"},"sku":{"description":"The SKU of the product, if applicable","title":"Sku","type":"string"},"special_instructions":{"description":"Any special instructions for this item","title":"Special Instructions","type":"string"},"status":{"description":"The order item status","enum":["awaiting payment","awaiting pickup","awaiting shipping","cancelled","completed","disputed","open","partially shipped","returned","shipped","void"],"oneOf":[{"x-required":true}],"title":"Status","type":"string"},"taxes":{"description":"Any taxes set on the order item","format":"double","oneOf":[{"x-required":true}],"title":"Taxes","type":"number"},"total":{"description":"Total amount of the order  item","format":"double","oneOf":[{"x-required":true}],"title":"Total","type":"number"},"total_in_base_currency":{"description":"Total amount of the order","format":"double","oneOf":[{"x-required":true}],"title":"Total In Base Currency","type":"number"},"type":{"description":"The type of order item","enum":["bundled product","cancellation","credit card processing fee","discount","inline bundled product","item","shipping","taxes"],"oneOf":[{"x-required":true}],"title":"Type","type":"string"},"unit_price":{"description":"The unit price of the item","format":"double","oneOf":[{"x-required":true}],"title":"Unit Price","type":"number"},"variant_options":{"items":{"additionalProperties":false,"properties":{"option_id":{"description":"The variant option ID","title":"Option","type":"string"},"option_name":{"title":"Option Name","type":"string"},"value":{"description":"The value of the option","title":"Value","type":"string"}},"required":["option_id"],"type":"object"},"type":"array"},"weight":{"description":"The weight of this item","format":"double","title":"Weight","type":"number"}},"required":["product_id","product_type"],"type":"object"},"minItems":1,"type":"array"},"memo":{"description":"Additional information for the order","title":"Memo","type":"string"},"notes":{"description":"Notes on the order","title":"Notes","type":"string"},"number":{"description":"The number of the order","title":"Number","type":"integer"},"override_order_date":{"description":"If true, the system should override the order date","title":"Override Order Date","type":"boolean"},"pay_for_credit_card_processing_fees":{"description":"If set, this order should be charged credit card processing fees","title":"Pay For Credit Card Processing Fees","type":"boolean"},"pay_using_multiple_methods":{"description":"If set, the order will be paid using more than one payment method","title":"Pay Using Multiple Methods","type":"boolean"},"payload":{"additionalProperties":false,"description":"Any optional order payload for processing; used by some fulfillment processes (like fundraising) to support transient objects","properties":{},"title":"Payload","type":"object"},"payment_info":{"additionalProperties":false,"properties":{"electronic_payment_info":{"additionalProperties":false,"description":"The electronic payment/card info","oneOf":[{"x-required":true}],"properties":{"card_expiration":{"description":"The card expiration","format":"date","title":"Card Expiration","type":"string"},"card_type":{"description":"The type of card being used, or CHECK if electronic check","enum":["american express","discover","electronic check","mastercard","other","visa"],"title":"Card Type","type":"string"},"merchant_account_id":{"description":"The merchant account to use for this payment","title":"Merchant Account","type":"string"},"merchant_account_tokens":{"items":{"additionalProperties":false,"properties":{"merchant_account_id":{"description":"The merchant account id","title":"Merchant Account","type":"string"},"token":{"description":"The token representing the card/electronic check info","title":"Token","type":"string"}},"required":["merchant_account_id","token"],"type":"object"},"minItems":1,"type":"array"},"payment_account":{"description":"The masked payment account information","title":"Payment Account","type":"string"},"payment_origin":{"description":"Whether or not this is a saved payment method","enum":["ad hoc","saved","single token"],"title":"Payment Origin","type":"string"},"token":{"description":"For integrated payments, the single token","title":"Token","type":"string"}},"required":["payment_origin"],"title":"Electronic Payment Info","type":"object"},"non_electronic_payment_info":{"additionalProperties":false,"description":"Payment info for non-electronic payments","properties":{"bank_account_id":{"description":"The bank account being used for the order","title":"Bank Account","type":"string"},"reference_number":{"description":"The reference number for the payment, if applicable","title":"Reference Number","type":"string"}},"title":"Non Electronic Payment Info","type":"object"},"type":{"description":"The type of payment","enum":["ach","cash","cashiers check","check","credit card","electronic check","money order","offline credit card","payroll deduction","purchase order","store credit","wire transfer"],"title":"Type","type":"string"}},"required":["type"],"title":"Payment Info","type":"object"},"payment_method":{"description":"For reporting use only, the payment method of this order","enum":["ach","cash","cashiers check","check","credit card","electronic check","money order","none","offline credit card","payroll deduction","purchase order","store credit","wire transfer"],"title":"Payment Method","type":"string"},"preview_id":{"description":"The caching key to use during preview","title":"Preview","type":"string"},"process_id":{"description":"If a process was used to create this order, that process ID is listed here","title":"Process","type":"string"},"purchase_order_number":{"description":"The customer P.O. number","title":"Purchase Order Number","type":"string"},"send_email_confirmation_to_customer":{"description":"Whether or not to send an email confirmation to the bill to and ship to","title":"Send Email Confirmation To Customer","type":"boolean"},"ship_to_contact_id":{"description":"The contact being shipped to","title":"Ship To Contact","type":"string"},"ship_to_name":{"description":"The addressee","title":"Ship To Name","type":"string"},"ship_to_organization_id":{"description":"The organization being shipped to","title":"Ship To Organization","type":"string"},"ship_to_type":{"description":"The type of customer being shipped to","enum":["contact","organization"],"title":"Ship To Type","type":"string"},"shippable":{"description":"Whether or not this order needs to be shipped","title":"Shippable","type":"boolean"},"shipping_address":{"$ref":"#/components/schemas/Address"},"shipping_charges":{"description":"Shipping charges for the order","format":"double","title":"Shipping Charges","type":"number"},"shipping_method_id":{"description":"The ID of the shipping method for this order","title":"Shipping Method","type":"string"},"shipping_method_name":{"description":"The name of the shipping method for this order","title":"Shipping Method Name","type":"string"},"shipping_method_type":{"description":"The type of shipping method","enum":["flat rate","free","pickup","ship by","ups"],"title":"Shipping Method Type","type":"string"},"shipping_zone_id":{"description":"The id of the shipping zone","title":"Shipping Zone","type":"string"},"special_instructions":{"description":"Any special instructions for this order","title":"Special Instructions","type":"string"},"status":{"description":"The order status","enum":["awaiting payment","awaiting pickup","awaiting shipping","cancelled","completed","disputed","open","partially shipped","returned","shipped","void"],"title":"Status","type":"string"},"store_id":{"description":"The online store","title":"Store","type":"string"},"submission_date":{"description":"The date and time the order was actually submitted","format":"date-time","title":"Submission Date","type":"string"},"subtotal":{"description":"Order subtotal before taxes/shipping/discounts","format":"double","title":"Subtotal","type":"number"},"success_notice_id":{"description":"The billing notice to run when this order succeeds; we track it here only to pass it back through the billing service","title":"Success Notice","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_shippable_status":{"description":"System property - do not use","title":"Sys Shippable Status","type":"string"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"taxes":{"description":"Taxes associated with the order","format":"double","title":"Taxes","type":"number"},"total":{"description":"Total amount of the order","format":"double","title":"Total","type":"number"},"total_in_base_currency":{"description":"Total amount of the order","format":"double","title":"Total In Base Currency","type":"number"},"total_weight":{"description":"The total weight of the order","format":"double","title":"Total Weight","type":"number"},"type":{"description":"The type of order","enum":["advertising insertion order","award application","career center","certification application","certification course registration","certification exam registration","donation form","event registration","exhibitor registration","fundraising gift","fundraising pledge","group membership","legacy","membership","online store","preview","sponsorship","subscription"],"title":"Type","type":"string"},"use_pro_forma_invoices":{"description":"Set if the invoices for the order should be pro forma","title":"Use Pro Forma Invoices","type":"boolean"}},"required":["additional_payments","amount_paid","amount_pending_capture","amount_refunded","balance_due","bill_to_contact_id","bill_to_organization_id","bill_to_type","discounts","event_id","id","line_items","ship_to_contact_id","ship_to_organization_id","ship_to_type","shipping_charges","status","store_id","subtotal","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","taxes","total","total_in_base_currency"],"type":"object"}},"components/schemas/OrderOverrideManifest":{"id":"components/schemas/OrderOverrideManifest","kind":"json-schema","title":"OrderOverrideManifest","data":{"additionalProperties":false,"properties":{"line_items":{"items":{"additionalProperties":false,"properties":{"order_line_item_id":{"description":"The line item","title":"Order Line Item","type":"string"},"override_quantity":{"description":"The overridden quantity","format":"float","title":"Override Quantity","type":"number"},"override_total":{"description":"The overridden total","format":"double","title":"Override Total","type":"number"},"override_unit_price":{"description":"The overridden unit price","format":"double","title":"Override Unit Price","type":"number"}},"required":["order_line_item_id"],"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/OrderPreviewManifest":{"id":"components/schemas/OrderPreviewManifest","kind":"json-schema","title":"OrderPreviewManifest","data":{"additionalProperties":false,"properties":{"additional_payments_due_at_checkout":{"description":"If this order has split payments, these are the additional payments due","format":"double","title":"Additional Payments Due At Checkout","type":"number"},"errors":{"description":"Any processing-wide errors","items":{"additionalProperties":false,"properties":{"code":{"description":"A code for the error","enum":["INVALID_BATCH","INVALID_INSTALLMENT_PLAN","ITEM_SOLD_OUT","NO_DEFAULT_SHIPPING_COST","NO_DEFAULT_SHIPPING_PRODUCT","NO_SHIPPING_ADDRESS","NO_SHIPPING_METHOD_SELECTED","NO_SHIPPING_ZONE","NO_TAX_PRODUCT"],"title":"Code","type":"string"},"message":{"description":"A message describing the error","title":"Message","type":"string"},"order_line_item_id":{"title":"Order Line Item","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"open_credit_balance":{"description":"The balance of open credits avaialble to this order","format":"double","title":"Open Credit Balance","type":"number"},"open_credits":{"items":{"additionalProperties":false,"properties":{"amount_available":{"format":"double","title":"Amount Available","type":"number"},"currency_code":{"title":"Currency Code","type":"string"},"date":{"format":"date","title":"Date","type":"string"},"id":{"title":"ID","type":"string"},"number":{"format":"float","title":"Number","type":"number"}},"type":"object"},"type":"array"},"payments_due":{"items":{"additionalProperties":false,"properties":{"amount_due":{"format":"double","title":"Amount Due","type":"number"},"merchant_account_id":{"title":"Merchant Account","type":"string"}},"required":["amount_due","merchant_account_id"],"type":"object"},"type":"array"},"primary_amount_due_at_checkout":{"description":"The amount due at checkout for primary payment","format":"double","title":"Primary Amount Due At Checkout","type":"number"},"product_availability":{"items":{"additionalProperties":false,"properties":{"order_line_item_id":{"title":"Order Line Item","type":"string"},"status":{"enum":["BACKORDER","OK","SOLD_OUT"],"title":"Status","type":"string"}},"required":["order_line_item_id"],"type":"object"},"type":"array"},"shipping_options":{"items":{"additionalProperties":false,"properties":{"cost":{"description":"The cost of the option","format":"double","title":"Cost","type":"number"},"display_order":{"format":"float","title":"Display Order","type":"number"},"do_not_show_in_portal":{"title":"Do Not Show In Portal","type":"boolean"},"id":{"description":"The id of the option","title":"ID","type":"string"},"name":{"description":"Name of the option","title":"Name","type":"string"}},"required":["cost","id","name"],"type":"object"},"type":"array"},"total_amount_due_at_checkout":{"description":"The total amount due at the time of checkout","format":"double","title":"Total Amount Due At Checkout","type":"number"}},"type":"object"}},"components/schemas/OrderPreviewResponse":{"id":"components/schemas/OrderPreviewResponse","kind":"json-schema","title":"OrderPreviewResponse","data":{"properties":{"line_item_mappings":{"type":"object"},"manifest":{"$ref":"#/components/schemas/OrderPreviewManifest"},"order":{"$ref":"#/components/schemas/Order"},"products":{"items":{"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/OrderSearchParameters":{"id":"components/schemas/OrderSearchParameters","kind":"json-schema","title":"OrderSearchParameters","data":{"additionalProperties":false,"properties":{"amount_paid":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Amount Paid","type":"array"},"balance_due":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Balance Due","type":"array"},"bill_to_contact_id":{"title":"Bill To Contact","type":"string"},"bill_to_organization_id":{"title":"Bill To Organization","type":"string"},"bill_to_type":{"enum":["contact","organization"],"title":"Bill To Type","type":"string"},"date":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Date","type":"array"},"discounts":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Discounts","type":"array"},"id":{"items":{"type":"string"},"title":"ID","type":"array"},"number":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Number","type":"array"},"purchase_order_number":{"items":{"type":"string"},"title":"Purchase Order Number","type":"array"},"ship_to_contact_id":{"title":"Ship To Contact","type":"string"},"ship_to_organization_id":{"title":"Ship To Organization","type":"string"},"ship_to_type":{"enum":["contact","organization"],"title":"Ship To Type","type":"string"},"shipping_method_name":{"items":{"type":"string"},"title":"Shipping Method Name","type":"array"},"status":{"items":{"type":"string"},"title":"Status","type":"array"},"total":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Total","type":"array"},"total_weight":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Total Weight","type":"array"},"type":{"items":{"type":"string"},"title":"Type","type":"array"}},"type":"object"}},"components/schemas/OrderSearchResults":{"id":"components/schemas/OrderSearchResults","kind":"json-schema","title":"OrderSearchResults","data":{"additionalProperties":false,"properties":{"amount_paid":{"format":"float","title":"Amount Paid","type":"number"},"balance_due":{"format":"float","title":"Balance Due","type":"number"},"bill_to_contact_id":{"title":"Bill To Contact","type":"string"},"bill_to_organization_id":{"title":"Bill To Organization","type":"string"},"bill_to_type":{"enum":["contact","organization"],"title":"Bill To Type","type":"string"},"date":{"title":"Date","type":"string"},"discounts":{"format":"float","title":"Discounts","type":"number"},"id":{"title":"ID","type":"string"},"ids":{"description":"ID","title":"Ids","type":"string"},"number":{"format":"float","title":"Number","type":"number"},"purchase_order_number":{"title":"Purchase Order Number","type":"string"},"ship_to_contact_id":{"title":"Ship To Contact","type":"string"},"ship_to_organization_id":{"title":"Ship To Organization","type":"string"},"ship_to_type":{"enum":["contact","organization"],"title":"Ship To Type","type":"string"},"shipping_method_name":{"title":"Shipping Method Name","type":"string"},"status":{"title":"Status","type":"string"},"total":{"format":"float","title":"Total","type":"number"},"total_weight":{"format":"float","title":"Total Weight","type":"number"},"type":{"title":"Type","type":"string"}},"type":"object"}},"components/schemas/OrderWithOverride":{"id":"components/schemas/OrderWithOverride","kind":"json-schema","title":"OrderWithOverride","data":{"properties":{"order":{"$ref":"#/components/schemas/Order"},"override_manifest":{"$ref":"#/components/schemas/OrderOverrideManifest"}},"type":"object"}},"components/schemas/PagedMerchandiseSearchResults":{"id":"components/schemas/PagedMerchandiseSearchResults","kind":"json-schema","title":"PagedMerchandiseSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/MerchandiseSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedOrderSearchResults":{"id":"components/schemas/PagedOrderSearchResults","kind":"json-schema","title":"PagedOrderSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/OrderSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PatchDirective":{"id":"components/schemas/PatchDirective","kind":"json-schema","title":"PatchDirective","data":{"additionalProperties":false,"properties":{"op":{"description":"The operation","enum":["add","copy","move","remove","replace","test"],"title":"Op","type":"string"},"path":{"description":"The JSON path","title":"Path","type":"string"},"value":{"title":"Value","type":"string"}},"required":["op","path"],"type":"object"}},"components/schemas/PreviewEmailRequest":{"id":"components/schemas/PreviewEmailRequest","kind":"json-schema","title":"PreviewEmailRequest","data":{"additionalProperties":false,"properties":{"cancellation_id":{"title":"Cancellation","type":"string"},"coupon_id":{"title":"Coupon","type":"string"},"coupon_type":{"title":"Coupon Type","type":"string"},"destination_email_address":{"title":"Destination Email Address","type":"string"},"email_template":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email Template","type":"object"},"order_id":{"title":"Order","type":"string"},"order_item_line_number":{"format":"float","title":"Order Item Line Number","type":"number"},"return_id":{"title":"Return","type":"string"},"shipment_id":{"title":"Shipment","type":"string"}},"required":["coupon_id","coupon_type","destination_email_address","destination_email_address","shipment_id"],"type":"object"}},"components/schemas/PreviewOrderConfirmationEmailRequest":{"id":"components/schemas/PreviewOrderConfirmationEmailRequest","kind":"json-schema","title":"PreviewOrderConfirmationEmailRequest","data":{"additionalProperties":false,"properties":{"destination_email_address":{"title":"Destination Email Address","type":"string"},"email_template":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email Template","type":"object"},"order_id":{"title":"Order","type":"string"}},"required":["destination_email_address","order_id"],"type":"object"}},"components/schemas/PreviewProductConfirmationEmailRequest":{"id":"components/schemas/PreviewProductConfirmationEmailRequest","kind":"json-schema","title":"PreviewProductConfirmationEmailRequest","data":{"additionalProperties":false,"properties":{"destination_email_address":{"title":"Destination Email Address","type":"string"},"email_template":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email Template","type":"object"},"order_id":{"title":"Order","type":"string"},"order_item_line_number":{"format":"float","minimum":1,"title":"Order Item Line Number","type":"number"}},"required":["destination_email_address","order_id"],"type":"object"}},"components/schemas/ProductCategory":{"id":"components/schemas/ProductCategory","kind":"json-schema","title":"ProductCategory","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"default_product_sort":{"enum":["alphabetical ascending","alphabetical descending","newest items","price ascending","price descending","sort order"],"title":"Default Product Sort","type":"string"},"id":{"description":"The unique, string identifier of this product category","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether this is an active category","title":"Is Active","type":"boolean"},"name":{"description":"The name of the product category","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ProductConfirmationEmail":{"id":"components/schemas/ProductConfirmationEmail","kind":"json-schema","title":"ProductConfirmationEmail","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"email":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email","type":"object"},"id":{"description":"The unique, string identifier of this product confirmation email","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this product confirmation email is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the product confirmation email","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["email","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ProductDescriptionRequest":{"id":"components/schemas/ProductDescriptionRequest","kind":"json-schema","title":"ProductDescriptionRequest","data":{"additionalProperties":false,"properties":{"business_unit_id":{"title":"Business Unit","type":"string"},"currency_code":{"title":"Currency Code","type":"string"},"customer_id":{"title":"Customer","type":"string"},"customer_type":{"enum":["contact","organization"],"title":"Customer Type","type":"string"},"products":{"items":{"additionalProperties":false,"properties":{"id":{"title":"ID","type":"string"},"modifier_options":{"items":{"additionalProperties":false,"properties":{"option_id":{"description":"The modifier option ID","title":"Option","type":"string"},"value":{"description":"The value of the option","title":"Value","type":"string"}},"required":["option_id"],"type":"object"},"type":"array"},"type":{"title":"Type","type":"string"},"variant_options":{"items":{"additionalProperties":false,"properties":{"option_id":{"description":"The variant option ID","title":"Option","type":"string"},"value":{"description":"The value of the option","title":"Value","type":"string"}},"required":["option_id"],"type":"object"},"type":"array"}},"required":["id","type"],"type":"object"},"type":"array"}},"required":["business_unit_id"],"type":"object"}},"components/schemas/ProductDescriptionResponse":{"id":"components/schemas/ProductDescriptionResponse","kind":"json-schema","title":"ProductDescriptionResponse","data":{"additionalProperties":false,"properties":{"currency_code":{"description":"The currency code used","title":"Currency Code","type":"string"},"products":{"items":{"additionalProperties":false,"properties":{"availability":{"enum":["BACKORDER","OK","SOLD_OUT"],"title":"Availability","type":"string"},"id":{"title":"ID","type":"string"},"ineligible":{"description":"Whether the product is ineligible","title":"Ineligible","type":"boolean"},"price":{"format":"double","title":"Price","type":"number"},"type":{"title":"Type","type":"string"}},"required":["id","type"],"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/ProductInventory":{"id":"components/schemas/ProductInventory","kind":"json-schema","title":"ProductInventory","data":{"additionalProperties":false,"properties":{"bin_id":{"description":"The optional bin in which the inventory is located","title":"Bin","type":"string"},"business_unit_id":{"description":"The business unit of the product tied to this inventory","title":"Business Unit","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"expected_replenishment_date":{"description":"The date in which this inventory is expected to be replenished","format":"date","title":"Expected Replenishment Date","type":"string"},"id":{"description":"The unique, string identifier of this product inventory","pattern":"^[\\w-:]+$","title":"ID","type":"string"},"notes":{"description":"Any important notes","title":"Notes","type":"string"},"product_id":{"description":"The ID of the product in this inventory","title":"Product","type":"string"},"product_type":{"description":"The type of product","title":"Product Type","type":"string"},"quantity_available":{"description":"The quantity of inventory available for purchase","title":"Quantity Available","type":"integer"},"quantity_backordered":{"description":"The quantity of inventory that has been backordered","title":"Quantity Backordered","type":"integer"},"quantity_committed":{"description":"The quantity of inventory committed","title":"Quantity Committed","type":"integer"},"quantity_defective":{"description":"The quantity of inventory that is defective","title":"Quantity Defective","type":"integer"},"quantity_on_hand":{"description":"The quantity of inventory on hand","title":"Quantity On Hand","type":"integer"},"quantity_on_order":{"description":"The quantity of inventory on order","title":"Quantity On Order","type":"integer"},"quantity_reserved":{"description":"The quantity of inventory that has been reserved for use other than sale","title":"Quantity Reserved","type":"integer"},"reorder_point":{"description":"The optional point at which this inventory should be replenished","title":"Reorder Point","type":"integer"},"sku":{"description":"The product SKU, if this product has a SKU","title":"Sku","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_product_type_id":{"description":"System property for indexing - do not use","title":"Sys Product Type","type":"string"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"warehouse_id":{"description":"The warehouse in which this inventory is located","title":"Warehouse","type":"string"}},"required":["business_unit_id","id","product_id","product_type","quantity_available","quantity_backordered","quantity_committed","quantity_defective","quantity_on_hand","quantity_on_order","quantity_reserved","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","warehouse_id"],"type":"object"}},"components/schemas/RelatedTransactions":{"id":"components/schemas/RelatedTransactions","kind":"json-schema","title":"RelatedTransactions","data":{"items":{"additionalProperties":false,"properties":{"amount":{"description":"The amount applied","format":"double","type":"number"},"date":{"description":"The date/time of the transaction","format":"date-time","type":"string"},"transaction_id":{"description":"The id of the transaction","type":"string"},"transaction_line_item_id":{"description":"The line item id of the transaction","type":"string"},"transaction_number":{"description":"The number of the transaction","format":"float","type":"number"},"type":{"enum":["cancellation","credit","credit memo","credit usage","debit memo","invoice","payment","refund","return","shipment","write off"],"type":"string"}},"required":["amount","date","transaction_id","transaction_line_item_id","transaction_number"],"type":"object"},"type":"array"}},"components/schemas/RetroCouponRequest":{"id":"components/schemas/RetroCouponRequest","kind":"json-schema","title":"RetroCouponRequest","data":{"additionalProperties":false,"properties":{"coupon_code_id":{"title":"Coupon Code","type":"string"},"options":{"additionalProperties":false,"properties":{"action":{"enum":["credit","refund"],"title":"Action","type":"string"},"batch_id":{"description":"the batch","title":"Batch","type":"string"},"do_not_perform_electronic_refund":{"title":"Do Not Perform Electronic Refund","type":"boolean"},"ignore_payment_gateway_errors":{"title":"Ignore Payment Gateway Errors","type":"boolean"}},"title":"Options","type":"object"},"order_id":{"title":"Order","type":"string"}},"required":["coupon_code_id","order_id"],"type":"object"}},"components/schemas/Return":{"id":"components/schemas/Return","kind":"json-schema","title":"Return","data":{"additionalProperties":false,"properties":{"action":{"description":"What to do with payments made on the order","enum":["issue credit","issue refund"],"title":"Action","type":"string"},"base_currency_code":{"title":"Base Currency Code","type":"string"},"base_currency_symbol":{"title":"Base Currency Symbol","type":"string"},"batch_id":{"description":"The batch the return should be in","title":"Batch","type":"string"},"business_unit_id":{"description":"The business unit the return should be in","title":"Business Unit","type":"string"},"currency_code":{"description":"The return currency","title":"Currency Code","type":"string"},"currency_symbol":{"description":"The cancellation currency symbol","title":"Currency Symbol","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date of the return","format":"date-time","title":"Date","type":"string"},"do_not_perform_electronic_refund":{"description":"If set, the refund process will NOT perform an electronic refund","title":"Do Not Perform Electronic Refund","type":"boolean"},"id":{"description":"The unique, string identifier of this return","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"ignore_payment_gateway_errors":{"description":"Whether or not the return should be processed, even if the payment gateway has an error","title":"Ignore Payment Gateway Errors","type":"boolean"},"line_items":{"items":{"additionalProperties":false,"oneOf":[{"type":"object","properties":{},"additionalProperties":false}],"properties":{"inventory_action":{"description":"What should happen to the inventory when this item is returned","enum":["do not return to inventory","return as defective","return to inventory"],"title":"Inventory Action","type":"string"},"order_line_item_id":{"description":"The order line item ID being returned","title":"Order Line Item","type":"string"},"product_id":{"description":"The product ID","oneOf":[{"x-required":true}],"title":"Product","type":"string"},"product_type":{"description":"The product type","oneOf":[{"x-required":true}],"title":"Product Type","type":"string"},"quantity":{"description":"The quantity being returned","title":"Quantity","type":"integer"},"waive_restocking_fees":{"description":"Whether or not the return should waive restocking fees","title":"Waive Restocking Fees","type":"boolean"}},"required":["inventory_action","order_line_item_id","quantity"],"type":"object"},"minItems":1,"type":"array"},"notes":{"description":"Any refund notes","title":"Notes","type":"string"},"number":{"description":"The unique, string identifier of this return","title":"Number","type":"integer"},"order_id":{"description":"The order being returned","title":"Order","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["action","batch_id","business_unit_id","id","line_items","number","order_id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Setting":{"id":"components/schemas/Setting","kind":"json-schema","title":"Setting","data":{"additionalProperties":false,"properties":{"cancellation_confirmation_email":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Cancellation Confirmation Email","type":"object"},"contact_role_permissions":{"description":"The contact roles that are allowed to manage this scholarship","items":{"additionalProperties":false,"properties":{"manage_coupon_codes":{"description":"This role manage coupon codes associated with the organization","title":"Manage Coupon Codes","type":"boolean"},"role_id":{"description":"The contact role","title":"Role","type":"string"}},"type":"object"},"type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"default_ship_from_address":{"$ref":"#/components/schemas/Address"},"default_store_id":{"description":"The default store","title":"Default Store","type":"string"},"display_policies_at_checkout":{"description":"If set, policies are shown to users at checkout","title":"Display Policies At Checkout","type":"boolean"},"enable_cancellation_confirmation_email":{"description":"If set, you can enable the text of the confirmation email","title":"Enable Cancellation Confirmation Email","type":"boolean"},"enable_order_confirmation_email":{"description":"If set, you can enable the text of the confirmation email","title":"Enable Order Confirmation Email","type":"boolean"},"enable_retroactive_coupons_in_portal":{"description":"If true, users can retroactively apply coupons to orders in the portal","title":"Enable Retroactive Coupons In Portal","type":"boolean"},"enable_return_confirmation_email":{"description":"If set, you can enable the text of the confirmation email","title":"Enable Return Confirmation Email","type":"boolean"},"enable_shipment_confirmation_email":{"description":"If set, you can enable the text of the shipment email","title":"Enable Shipment Confirmation Email","type":"boolean"},"notes":{"description":"The name of the settings","title":"Notes","type":"string"},"order_confirmation_email":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Order Confirmation Email","type":"object"},"policies":{"additionalProperties":false,"properties":{"consumer_data_policy_uri":{"description":"The default consumer data policy to display to customers when checking out","title":"Consumer Data Policy Uri","type":"string"},"refund_policy_uri":{"description":"The refund policy to display to customers when checking out","title":"Refund Policy Uri","type":"string"},"secure_checkout_policy_uri":{"description":"The default secure checkout policy to display to customers when checking out","title":"Secure Checkout Policy Uri","type":"string"},"terms_of_service_uri":{"description":"The default TOS policy to display to customers when checking out","title":"Terms Of Service Uri","type":"string"}},"required":["consumer_data_policy_uri","refund_policy_uri","secure_checkout_policy_uri","terms_of_service_uri"],"title":"Policies","type":"object"},"restrict_retroactive_coupons_by_time_period":{"description":"If true, users in the portal can only retroactively apply coupons to orders within a certain time period","title":"Restrict Retroactive Coupons By Time Period","type":"boolean"},"retroactive_coupon_allowed_time_period":{"description":"The maximum number of a days after an order is processed that a user can retroactively apply a coupon in the portal","format":"float","title":"Retroactive Coupon Allowed Time Period","type":"number"},"return_confirmation_email":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Return Confirmation Email","type":"object"},"shipment_confirmation_email":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Shipment Confirmation Email","type":"object"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["cancellation_confirmation_email","order_confirmation_email","policies","retroactive_coupon_allowed_time_period","return_confirmation_email","shipment_confirmation_email","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/SharedModifierOption":{"id":"components/schemas/SharedModifierOption","kind":"json-schema","title":"SharedModifierOption","data":{"additionalProperties":false,"properties":{"default_value":{"description":"The default value","title":"Default Value","type":"string"},"enable_character_restriction":{"description":"If true, the UI will restrict the number of characters","title":"Enable Character Restriction","type":"boolean"},"id":{"description":"The unique, string identifier of this shared modifier option","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this shared modifier option is active","title":"Is Active","type":"boolean"},"maximum_number_of_characters":{"description":"The maximum number of characters","format":"float","title":"Maximum Number Of Characters","type":"number"},"name":{"description":"The name of the shared modifier option","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type":{"enum":["checkbox","date","dropdown","multiple choice","text"],"title":"Type","type":"string"},"values":{"items":{"type":"string"},"title":"Values","type":"array"}},"required":["id","maximum_number_of_characters","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type","values"],"type":"object"}},"components/schemas/SharedVariantOption":{"id":"components/schemas/SharedVariantOption","kind":"json-schema","title":"SharedVariantOption","data":{"additionalProperties":false,"properties":{"default_value":{"description":"The default value","title":"Default Value","type":"string"},"id":{"description":"The unique, string identifier of this shared variant option","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this shared variant option is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the shared variant option","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type":{"enum":["dropdown","radio buttons","rectangle list","swatch"],"title":"Type","type":"string"},"values":{"items":{"type":"string"},"title":"Values","type":"array"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type"],"type":"object"}},"components/schemas/Shipment":{"id":"components/schemas/Shipment","kind":"json-schema","title":"Shipment","data":{"additionalProperties":false,"properties":{"carrier_integration":{"enum":["none","ups"],"title":"Carrier Integration","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date of the shipment","format":"date-time","title":"Date","type":"string"},"dimensions":{"additionalProperties":false,"properties":{"depth":{"description":"Depth in inches","format":"float","title":"Depth","type":"number"},"height":{"description":"Height in inches","format":"float","title":"Height","type":"number"},"width":{"description":"Width in inches","format":"float","title":"Width","type":"number"}},"required":["depth","height","width"],"title":"Dimensions","type":"object"},"id":{"description":"The unique, string identifier of this shipment","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"line_items":{"items":{"additionalProperties":false,"properties":{"order_line_item_id":{"description":"The order line item ID being fulfilled","title":"Order Line Item","type":"string"},"product_id":{"description":"The id of the product","title":"Product","type":"string"},"product_type":{"description":"The type of product","title":"Product Type","type":"string"},"quantity":{"description":"The quantity of the order item","title":"Quantity","type":"integer"}},"required":["order_line_item_id","product_id","product_type","quantity"],"type":"object"},"minItems":1,"type":"array"},"notes":{"description":"General notes","title":"Notes","type":"string"},"number":{"description":"The unique, string identifier of this shipment","format":"float","title":"Number","type":"number"},"number_of_pieces":{"description":"The number of pieces","format":"float","title":"Number Of Pieces","type":"number"},"order_id":{"description":"The order being fulfilled","title":"Order","type":"string"},"packing_slip_notes":{"description":"Notes for the packing slip","title":"Packing Slip Notes","type":"string"},"send_email_confirmation_to_customer":{"description":"Whether or not the customer should be notified by email","title":"Send Email Confirmation To Customer","type":"boolean"},"shipping_address":{"$ref":"#/components/schemas/Address"},"shipping_label_uri":{"description":"The shipping label, if applicable","title":"Shipping Label Uri","type":"string"},"shipping_method_description":{"description":"User-friendly description for how the shipment was shipped","title":"Shipping Method Description","type":"string"},"shipping_method_id":{"description":"The shipping method ID from the order","title":"Shipping Method","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"tracking_number":{"description":"The tracking number","title":"Tracking Number","type":"string"},"ups_integration":{"additionalProperties":false,"properties":{"packaging_code":{"description":"The UPS packaging code","title":"Packaging Code","type":"string"},"service_code":{"description":"The UPS service code","title":"Service Code","type":"string"}},"required":["packaging_code","service_code"],"title":"Ups Integration","type":"object"},"weight":{"additionalProperties":false,"properties":{"ounces":{"description":"Number of ounces","format":"float","title":"Ounces","type":"number"},"pounds":{"description":"Number of pounds","format":"float","title":"Pounds","type":"number"}},"required":["ounces","pounds"],"title":"Weight","type":"object"}},"required":["dimensions","id","line_items","number","order_id","send_email_confirmation_to_customer","shipping_address","shipping_method_description","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","ups_integration","weight"],"type":"object"}},"components/schemas/ShippingConfiguration":{"id":"components/schemas/ShippingConfiguration","kind":"json-schema","title":"ShippingConfiguration","data":{"additionalProperties":false,"properties":{"default_ship_from_address":{"$ref":"#/components/schemas/Address"},"default_ship_from_name":{"description":"The name of the shipper","title":"Default Ship From Name","type":"string"},"default_shipping_product_id":{"description":"The default shipping product id to use","title":"Default Shipping Product","type":"string"},"notes":{"description":"Any notes about this configuration","title":"Notes","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"zones":{"items":{"additionalProperties":false,"properties":{"countries":{"items":{"additionalProperties":false,"properties":{"country":{"description":"The country","title":"Country","type":"string"}},"required":["country"],"type":"object"},"maxItems":1000,"oneOf":[{"x-required":true}],"type":"array"},"enabled":{"description":"Whether or not this zone is enabled","title":"Enabled","type":"boolean"},"id":{"description":"A unique id for the zone","title":"ID","type":"string"},"name":{"description":"The name of the zone","title":"Name","type":"string"},"postal_code_ranges":{"items":{"additionalProperties":false,"properties":{"end":{"title":"End","type":"string"},"start":{"title":"Start","type":"string"}},"required":["end","start"],"type":"object"},"maxItems":1000,"oneOf":[{"x-required":true}],"type":"array"},"pricing_strategies":{"additionalProperties":false,"properties":{"flat_rate":{"additionalProperties":false,"properties":{"enabled":{"description":"Whether or not the flat rate pricing strategy is enabled","title":"Enabled","type":"boolean"},"shipping_methods":{"items":{"additionalProperties":false,"properties":{"display_name":{"description":"The name to display to the user","title":"Display Name","type":"string"},"display_order":{"description":"Optional number indicating the order to display this method to the user","format":"float","title":"Display Order","type":"number"},"id":{"description":"A unique id for the method","title":"ID","type":"string"},"shipping_product_id":{"description":"The default product to use","title":"Shipping Product","type":"string"},"shipping_rate":{"format":"double","title":"Shipping Rate","type":"number"},"type":{"description":"The type of order calculation","enum":["per item","per order"],"title":"Type","type":"string"}},"required":["display_name","id","shipping_rate","type"],"type":"object"},"type":"array"},"shipping_product_id":{"description":"The default product to use for shipping","title":"Shipping Product","type":"string"}},"title":"Flat Rate","type":"object"},"free":{"additionalProperties":false,"properties":{"display_name":{"description":"Display name for this strategy","title":"Display Name","type":"string"},"display_order":{"description":"Optional number indicating the order to display this method to the user","format":"float","title":"Display Order","type":"number"},"do_not_show_in_portal":{"description":"If true, this option is not available in the portal","title":"Do Not Show In Portal","type":"boolean"},"enabled":{"description":"Whether or not the free pricing strategy is enabled","title":"Enabled","type":"boolean"},"id":{"description":"A unique id for the method","title":"ID","type":"string"},"maximum_order_amount":{"description":"The maximum order amount to qualify for free shipping","format":"double","title":"Maximum Order Amount","type":"number"},"minimum_order_amount":{"description":"The minimum order amount to qualify for free shipping","format":"double","title":"Minimum Order Amount","type":"number"},"shipping_product_id":{"description":"The default product to use for shipping","title":"Shipping Product","type":"string"}},"required":["display_name","id"],"title":"Free","type":"object"},"pick_up_in_store":{"additionalProperties":false,"properties":{"cost":{"description":"The cost of in store pickup","format":"double","title":"Cost","type":"number"},"display_name":{"description":"Display name for this strategy","title":"Display Name","type":"string"},"display_order":{"description":"Optional number indicating the order to display this method to the user","format":"float","title":"Display Order","type":"number"},"do_not_show_in_portal":{"description":"If true, this option is not available in the portal","title":"Do Not Show In Portal","type":"boolean"},"enabled":{"description":"Whether or not the pick up in store strategy is enabled","title":"Enabled","type":"boolean"},"id":{"description":"A unique id for the method","title":"ID","type":"string"},"shipping_product_id":{"description":"The default product to use for shipping","title":"Shipping Product","type":"string"}},"required":["cost","display_name","id"],"title":"Pick Up In Store","type":"object"},"ship_by":{"additionalProperties":false,"properties":{"enabled":{"description":"Whether or not the ship by pricing strategy is enabled","title":"Enabled","type":"boolean"},"shipping_methods":{"items":{"additionalProperties":false,"properties":{"charge_shipping_by":{"enum":["order total","order weight"],"title":"Charge Shipping By","type":"string"},"default_shipping_cost":{"description":"The default amount of shipping","format":"float","title":"Default Shipping Cost","type":"number"},"display_name":{"description":"The display name","title":"Display Name","type":"string"},"display_order":{"description":"Optional number indicating the order to display this method to the user","format":"float","title":"Display Order","type":"number"},"id":{"description":"A unique id for the method","title":"ID","type":"string"},"ranges":{"items":{"additionalProperties":false,"properties":{"cost":{"format":"double","title":"Cost","type":"number"},"from":{"format":"double","title":"From","type":"number"},"up_to":{"format":"double","title":"Up To","type":"number"}},"type":"object"},"minItems":1,"type":"array"},"shipping_product_id":{"description":"The default product to use for shipping","title":"Shipping Product","type":"string"},"type":{"enum":["fixed amount","percent of order total"],"title":"Type","type":"string"}},"required":["charge_shipping_by","default_shipping_cost","display_name","id","ranges","type"],"type":"object"},"type":"array"},"shipping_product_id":{"description":"The default product to use for shipping","title":"Shipping Product","type":"string"}},"title":"Ship By","type":"object"},"ups":{"additionalProperties":false,"properties":{"display_order":{"description":"Optional number indicating the order to display this method to the user","format":"float","title":"Display Order","type":"number"},"do_not_show_in_portal":{"description":"If true, this option is not available in the portal","title":"Do Not Show In Portal","type":"boolean"},"enabled":{"description":"Whether or not this is enabled","title":"Enabled","type":"boolean"},"limit_shipping_options":{"description":"If set, only certain options are shown to the user","title":"Limit Shipping Options","type":"boolean"},"markup_amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A % markup to add to the calculated UPS prices"},"children":[]}]}]}],"format":"float","oneOf":[{"x-required":true}],"title":"Markup Amount","type":"number"},"markup_type":{"description":"Apply a markup to the UPS fees","enum":["amount","none","percentage"],"title":"Markup Type","type":"string"},"override_default_ship_from_address":{"description":"If set, an different ship from address is used","title":"Override Default Ship From Address","type":"boolean"},"ship_from_address":{"$ref":"#/components/schemas/Address"},"shipping_options":{"description":"Allows you to restrict the options shown to the ","items":{"type":"string"},"oneOf":[{"x-required":true}],"title":"Shipping Options","type":"array"},"shipping_product_id":{"description":"The default product to use for shipping","title":"Shipping Product","type":"string"},"ups_account_id":{"description":"The UPS account to use for integration","title":"Ups Account","type":"string"}},"required":["ups_account_id"],"title":"Ups","type":"object"}},"title":"Pricing Strategies","type":"object"},"shipping_product_id":{"description":"The default product to use for shipping","title":"Shipping Product","type":"string"},"states":{"items":{"additionalProperties":false,"properties":{"state":{"description":"The state","title":"State","type":"string"}},"required":["state"],"type":"object"},"maxItems":1000,"oneOf":[{"x-required":true}],"type":"array"},"type":{"enum":["country","postal code","rest of the world","state"],"title":"Type","type":"string"}},"required":["enabled","id","name"],"type":"object"},"type":"array"}},"required":["sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ShippingProduct":{"id":"components/schemas/ShippingProduct","kind":"json-schema","title":"ShippingProduct","data":{"additionalProperties":false,"properties":{"business_unit_id":{"description":"The business unit of the product","title":"Business Unit","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this miscellaneous product","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether this product is active/used","title":"Is Active","type":"boolean"},"name":{"description":"The name of the miscellaneous product","title":"Name","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type":{"description":"The product type","enum":["commerce-shipping-products"],"title":"Type","type":"string"}},"required":["business_unit_id","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/StandardQueryDefinition":{"id":"components/schemas/StandardQueryDefinition","kind":"json-schema","title":"StandardQueryDefinition","data":{"additionalProperties":false,"properties":{"category":{"title":"Category","type":"string"},"definition":{"additionalProperties":false,"properties":{},"title":"Definition","type":"object"},"id":{"title":"ID","type":"string"},"name":{"title":"Name","type":"string"}},"type":"object"}},"components/schemas/Statistic":{"id":"components/schemas/Statistic","kind":"json-schema","title":"Statistic","data":{"additionalProperties":false,"properties":{"dataSource":{"description":"The datasource used to generate this value","title":"Datasource","type":"string"},"error":{"description":"If the cache encountered an error, this is it","title":"Error","type":"string"},"id":{"description":"The unique, string identifier of this statistic","pattern":"^[\\w-:%\\/]+$","title":"ID","type":"string"},"name":{"description":"The name of the statistic","title":"Name","type":"string"},"status":{"description":"The description of the statistic","enum":["error","processing","valid"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"value":{"description":"The numeric value of the statistic","format":"float","title":"Value","type":"number"},"value_difference_numeric":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a value & previous value is present, this is the numeric difference"},"children":[]}]}]}],"format":"float","title":"Value Difference Numeric","type":"number"},"value_difference_percentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a value & previous value is present, this is the percentage difference"},"children":[]}]}]}],"format":"float","title":"Value Difference Percentage","type":"number"},"value_for_previous_period":{"description":"For statistics that can compare values from a previous period, this is the value","format":"float","title":"Value For Previous Period","type":"number"},"values":{"description":"If the stat hs values in a row form, this variable contains it","items":{"additionalProperties":false,"properties":{},"type":"object"},"type":"array"}},"required":["id","name","status","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","value"],"type":"object"}},"components/schemas/StepFunctionExecutionToken":{"id":"components/schemas/StepFunctionExecutionToken","kind":"json-schema","title":"StepFunctionExecutionToken","data":{"additionalProperties":false,"properties":{"executionArn":{"description":"The arn of the execution","title":"Executionarn","type":"string"},"notification_channel":{"description":"The id of the channel where progress updates will be posted","title":"Notification Channel","type":"string"},"notification_publishKey":{"description":"The publish key for the channel where progress updates will be posted","title":"Notification Publishkey","type":"string"},"notification_subscribeKey":{"description":"The subscribe key for the channel where progress updates will be posted","title":"Notification Subscribekey","type":"string"},"start_date":{"description":"The start date of the execution","format":"date-time","title":"Start Date","type":"string"}},"required":["executionArn"],"type":"object"}},"components/schemas/Store":{"id":"components/schemas/Store","kind":"json-schema","title":"Store","data":{"additionalProperties":false,"properties":{"allow_customer_to_choose_installment_plan":{"description":"If true, the customer can choose their installment plan","title":"Allow Customer To Choose Installment Plan","type":"boolean"},"bank_account_id":{"description":"The default bank account that the store should use to receive payments","title":"Bank Account","type":"string"},"bill_my_organization_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Bill My Organization Options","type":"object"},"bill_my_parent_organization_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Bill My Parent Organization Options","type":"object"},"business_unit_id":{"description":"The business unit of the store","title":"Business Unit","type":"string"},"cancellation_confirmation_settings":{"additionalProperties":false,"properties":{"email":{"additionalProperties":false,"description":"The email template to send","oneOf":[{"x-required":true}],"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email","type":"object"},"suppress_email_delivery":{"description":"If true, emails are not sent","title":"Suppress Email Delivery","type":"boolean"}},"title":"Cancellation Confirmation Settings","type":"object"},"cancellation_fee_product_id":{"description":"The ID of the product used for cancellation fees","title":"Cancellation Fee Product","type":"string"},"category_ids":{"items":{"type":"string"},"title":"Categories","type":"array"},"category_inclusion":{"enum":["include all but specified","include all categories","include only specified"],"title":"Category Inclusion","type":"string"},"certification_course_options":{"additionalProperties":false,"properties":{"category_name":{"description":"The optional name of the category","title":"Category Name","type":"string"},"course_ids":{"items":{"type":"string"},"minItems":0,"oneOf":[{"x-required":true}],"title":"Courses","type":"array"},"course_restriction":{"enum":["exclude","include","none"],"title":"Course Restriction","type":"string"},"course_type_ids":{"items":{"type":"string"},"minItems":0,"oneOf":[{"x-required":true}],"title":"Course Types","type":"array"},"course_type_restriction":{"enum":["exclude","include","none"],"title":"Course Type Restriction","type":"string"}},"title":"Certification Course Options","type":"object"},"certification_exam_options":{"additionalProperties":false,"properties":{"category_name":{"description":"The optional name of the category","title":"Category Name","type":"string"},"exam_ids":{"items":{"type":"string"},"minItems":0,"oneOf":[{"x-required":true}],"title":"Exams","type":"array"},"exam_restriction":{"enum":["exclude","include","none"],"title":"Exam Restriction","type":"string"},"image_uri":{"description":"The image to display in the store for exams","title":"Image Uri","type":"string"}},"title":"Certification Exam Options","type":"object"},"checkout_donation_options":{"additionalProperties":false,"properties":{"simple_checkout_donation_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"allow_user_to_specify_custom_amount":{"description":"If set, the user can specify their own custom donation","title":"Allow User To Specify Custom Amount","type":"boolean"},"donation_ask_text":{"description":"The text shown to the user when making the donation","title":"Donation Ask Text","type":"string"},"donation_denominations":{"items":{"format":"double","type":"number"},"title":"Donation Denominations","type":"array"},"donation_information":{"description":"Additional information about the donation","title":"Donation Information","type":"string"},"donation_product_id":{"description":"The misc product that should be used","title":"Donation Product","type":"string"},"override_donation_denominations":{"description":"If set, donation denominations are specified here and the defaults are not used","title":"Override Donation Denominations","type":"boolean"},"suggested_donation":{"description":"A suggested donation","format":"double","title":"Suggested Donation","type":"number"}},"required":["donation_product_id"],"title":"Simple Checkout Donation Options","type":"object"},"type":{"enum":["simple"],"title":"Type","type":"string"}},"title":"Checkout Donation Options","type":"object"},"credit_card_minimum_range_end":{"description":"If set, the maximum amount for which credit cards can be taken","format":"float","title":"Credit Card Minimum Range End","type":"number"},"credit_card_minimum_range_start":{"description":"If set, the minimum amount for which credit cards can be taken","format":"float","title":"Credit Card Minimum Range Start","type":"number"},"credit_card_mode":{"description":"Determines whether or not credit cards are accepted","enum":["disabled","enabled","range"],"title":"Credit Card Mode","type":"string"},"credit_card_processing_fee_mode":{"description":"Determines how credit card processing fees should be handled","enum":["charge","do not charge","prompt user"],"title":"Credit Card Processing Fee Mode","type":"string"},"credit_card_processing_fee_options":{"additionalProperties":false,"properties":{"fee_percentage":{"description":"The fee percentage to charge for credit card processing ","format":"float","title":"Fee Percentage","type":"number"},"maximum_fee":{"description":"The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged","format":"float","title":"Maximum Fee","type":"number"},"minimum_fee":{"description":"The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged","format":"float","title":"Minimum Fee","type":"number"},"product_id":{"description":"The misc product to use for the credit card processing","title":"Product","type":"string"},"prompt_sub_text":{"description":"Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used","title":"Prompt Sub Text","type":"string"},"prompt_text":{"description":"The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used","title":"Prompt Text","type":"string"}},"required":["fee_percentage","product_id"],"title":"Credit Card Processing Fee Options","type":"object"},"default_certification_course_image_uri":{"description":"The image to display in the store for courses","title":"Default Certification Course Image Uri","type":"string"},"default_certification_exam_image_uri":{"description":"The image to display in the store for exams","title":"Default Certification Exam Image Uri","type":"string"},"default_event_registration_image_uri":{"description":"The image to display in the store for event registrations","title":"Default Event Registration Image Uri","type":"string"},"default_membership_package_image_uri":{"description":"The image to display in the store for membership","title":"Default Membership Package Image Uri","type":"string"},"default_merchandise_image_uri":{"description":"The default image to show for products with no image","title":"Default Merchandise Image Uri","type":"string"},"default_product_sort":{"enum":["alphabetical ascending","alphabetical descending","newest items","price ascending","price descending","sort order"],"title":"Default Product Sort","type":"string"},"disable_electronic_payment_vaulting":{"description":"If set, in the portal people are not allowed to save credit cards","title":"Disable Electronic Payment Vaulting","type":"boolean"},"enable_bill_my_organization":{"description":"If set, the user has the option to bill their organization","title":"Enable Bill My Organization","type":"boolean"},"enable_bill_my_parent_organization":{"description":"If set, the user has the option to bill their organization's parent organization","title":"Enable Bill My Parent Organization","type":"boolean"},"enable_donations_at_checkout":{"description":"If selected, users will be prompted to make a donation upon checking out","title":"Enable Donations At Checkout","type":"boolean"},"enable_electronic_checks":{"description":"If set, electronic checks are allowed","title":"Enable Electronic Checks","type":"boolean"},"enable_pay_later":{"description":"If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed","title":"Enable Pay Later","type":"boolean"},"enable_payroll_deduction":{"description":"If set, payroll deduction is allowed","title":"Enable Payroll Deduction","type":"boolean"},"enable_split_payments":{"description":"If set, users are allowed to split payments","title":"Enable Split Payments","type":"boolean"},"event_registration_options":{"additionalProperties":false,"properties":{"category_name":{"description":"The optional name of the category","title":"Category Name","type":"string"},"event_ids":{"items":{"type":"string"},"minItems":0,"oneOf":[{"x-required":true}],"title":"Events","type":"array"},"event_restriction":{"enum":["exclude","include","none"],"title":"Event Restriction","type":"string"},"event_type_ids":{"items":{"type":"string"},"minItems":0,"oneOf":[{"x-required":true}],"title":"Event Types","type":"array"},"event_type_restriction":{"enum":["exclude","include","none"],"title":"Event Type Restriction","type":"string"}},"title":"Event Registration Options","type":"object"},"home_category_id":{"description":"The \"home\" category of products to display when someone lands on the store","title":"Home Category","type":"string"},"id":{"description":"The unique, string identifier of this store","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"installment_plan_options":{"items":{"additionalProperties":false,"properties":{"additional_cost":{"description":"The additional cost of the installment plan","format":"double","title":"Additional Cost","type":"number"},"installment_plan_id":{"description":"The installment plan that this product supports","title":"Installment Plan","type":"string"},"is_default":{"description":"Whether this is the default installment plan option","title":"Is Default","type":"boolean"}},"required":["installment_plan_id"],"type":"object"},"minItems":1,"type":"array"},"invoice_payment_terms_id":{"description":"The payment terms for invoices; if left blank, default is used","title":"Invoice Payment Terms","type":"string"},"invoice_template_id":{"description":"The template to use for invoices created during this process","title":"Invoice Template","type":"string"},"invoice_terms_id":{"description":"Default invoice terms for non-electronic payments made to the store","title":"Invoice Terms","type":"string"},"is_active":{"description":"Whether or not this store is active","title":"Is Active","type":"boolean"},"membership_package_options":{"additionalProperties":false,"properties":{"category_name":{"description":"The optional name of the category","title":"Category Name","type":"string"},"membership_package_ids":{"items":{"type":"string"},"minItems":0,"oneOf":[{"x-required":true}],"title":"Membership Packages","type":"array"},"membership_package_restriction":{"enum":["exclude","include","none"],"title":"Membership Package Restriction","type":"string"},"membership_type_ids":{"items":{"type":"string"},"minItems":0,"oneOf":[{"x-required":true}],"title":"Membership Types","type":"array"},"membership_type_restriction":{"enum":["exclude","include","none"],"title":"Membership Type Restriction","type":"string"}},"title":"Membership Package Options","type":"object"},"merchant_account_id":{"description":"The merchant account that the store should use to receive payments","title":"Merchant Account","type":"string"},"name":{"description":"The name of the store","title":"Name","type":"string"},"order_confirmation_settings":{"additionalProperties":false,"properties":{"email":{"additionalProperties":false,"description":"The email template to send","oneOf":[{"x-required":true}],"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email","type":"object"},"suppress_email_delivery":{"description":"If true, emails are not sent","title":"Suppress Email Delivery","type":"boolean"}},"title":"Order Confirmation Settings","type":"object"},"override_cancellation_confirmation_email":{"description":"If set, you can override the text of the confirmation email","title":"Override Cancellation Confirmation Email","type":"boolean"},"override_order_confirmation_email":{"description":"If set, you can override the text of the confirmation email","title":"Override Order Confirmation Email","type":"boolean"},"override_return_confirmation_email":{"description":"If set, you can override the text of the confirmation email","title":"Override Return Confirmation Email","type":"boolean"},"override_shipment_confirmation_email":{"description":"If set, you can override the text of the shipment email","title":"Override Shipment Confirmation Email","type":"boolean"},"pay_later_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Pay Later Options","type":"object"},"restocking_fee_product_id":{"description":"The ID of the product used for restocking fees","title":"Restocking Fee Product","type":"string"},"return_confirmation_settings":{"additionalProperties":false,"properties":{"email":{"additionalProperties":false,"description":"The email template to send","oneOf":[{"x-required":true}],"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email","type":"object"},"suppress_email_delivery":{"description":"If true, emails are not sent","title":"Suppress Email Delivery","type":"boolean"}},"title":"Return Confirmation Settings","type":"object"},"sell_certification_courses":{"description":"If set, this store sells certification courses","title":"Sell Certification Courses","type":"boolean"},"sell_certification_exams":{"description":"If set, this store sells certification exams","title":"Sell Certification Exams","type":"boolean"},"sell_event_registration_packages":{"description":"If set, this store sells event registration packages","title":"Sell Event Registration Packages","type":"boolean"},"sell_membership_packages":{"description":"If set, this store sells membership packages","title":"Sell Membership Packages","type":"boolean"},"shipment_confirmation_settings":{"additionalProperties":false,"properties":{"email":{"additionalProperties":false,"description":"The email template to send","oneOf":[{"x-required":true}],"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email","type":"object"},"suppress_email_delivery":{"description":"If true, emails are not sent","title":"Suppress Email Delivery","type":"boolean"}},"title":"Shipment Confirmation Settings","type":"object"},"special_instructions":{"description":"Instructions shown to the user","title":"Special Instructions","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"use_pro_forma_invoices":{"description":"Whether to use pro forma invoices when user elects to pay later","title":"Use Pro Forma Invoices","type":"boolean"}},"required":["bank_account_id","business_unit_id","cancellation_confirmation_settings","category_ids","certification_course_options","certification_exam_options","checkout_donation_options","credit_card_processing_fee_options","event_registration_options","id","installment_plan_options","membership_package_options","merchant_account_id","name","order_confirmation_settings","return_confirmation_settings","shipment_confirmation_settings","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/StorePublic":{"id":"components/schemas/StorePublic","kind":"json-schema","title":"StorePublic","data":{"additionalProperties":false,"properties":{"allow_customer_to_choose_installment_plan":{"description":"If true, the customer can choose their installment plan","title":"Allow Customer To Choose Installment Plan","type":"boolean"},"bank_account_id":{"description":"The default bank account that the store should use to receive payments","title":"Bank Account","type":"string"},"bill_my_organization_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Bill My Organization Options","type":"object"},"bill_my_parent_organization_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Bill My Parent Organization Options","type":"object"},"business_unit_id":{"description":"The business unit of the store","title":"Business Unit","type":"string"},"cancellation_fee_product_id":{"description":"The ID of the product used for cancellation fees","title":"Cancellation Fee Product","type":"string"},"categories":{"items":{"additionalProperties":false,"properties":{"default_product_sort":{"title":"Default Product Sort","type":"string"},"id":{"title":"ID","type":"string"},"name":{"title":"Name","type":"string"}},"type":"object"},"type":"array"},"category_inclusion":{"enum":["include all but specified","include all categories","include only specified"],"title":"Category Inclusion","type":"string"},"certification_course_options":{"additionalProperties":false,"properties":{"category_name":{"description":"The optional name of the category","title":"Category Name","type":"string"},"course_ids":{"items":{"type":"string"},"minItems":0,"oneOf":[{"x-required":true}],"title":"Courses","type":"array"},"course_restriction":{"enum":["exclude","include","none"],"title":"Course Restriction","type":"string"},"course_type_ids":{"items":{"type":"string"},"minItems":0,"oneOf":[{"x-required":true}],"title":"Course Types","type":"array"},"course_type_restriction":{"enum":["exclude","include","none"],"title":"Course Type Restriction","type":"string"}},"title":"Certification Course Options","type":"object"},"certification_exam_options":{"additionalProperties":false,"properties":{"category_name":{"description":"The optional name of the category","title":"Category Name","type":"string"},"exam_ids":{"items":{"type":"string"},"minItems":0,"oneOf":[{"x-required":true}],"title":"Exams","type":"array"},"exam_restriction":{"enum":["exclude","include","none"],"title":"Exam Restriction","type":"string"},"image_uri":{"description":"The image to display in the store for exams","title":"Image Uri","type":"string"}},"title":"Certification Exam Options","type":"object"},"checkout_donation_options":{"additionalProperties":false,"properties":{"simple_checkout_donation_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"allow_user_to_specify_custom_amount":{"description":"If set, the user can specify their own custom donation","title":"Allow User To Specify Custom Amount","type":"boolean"},"donation_ask_text":{"description":"The text shown to the user when making the donation","title":"Donation Ask Text","type":"string"},"donation_denominations":{"items":{"format":"double","type":"number"},"title":"Donation Denominations","type":"array"},"donation_information":{"description":"Additional information about the donation","title":"Donation Information","type":"string"},"donation_product_id":{"description":"The misc product that should be used","title":"Donation Product","type":"string"},"override_donation_denominations":{"description":"If set, donation denominations are specified here and the defaults are not used","title":"Override Donation Denominations","type":"boolean"},"suggested_donation":{"description":"A suggested donation","format":"double","title":"Suggested Donation","type":"number"}},"required":["donation_product_id"],"title":"Simple Checkout Donation Options","type":"object"},"type":{"enum":["simple"],"title":"Type","type":"string"}},"title":"Checkout Donation Options","type":"object"},"credit_card_minimum_range_end":{"description":"If set, the maximum amount for which credit cards can be taken","format":"float","title":"Credit Card Minimum Range End","type":"number"},"credit_card_minimum_range_start":{"description":"If set, the minimum amount for which credit cards can be taken","format":"float","title":"Credit Card Minimum Range Start","type":"number"},"credit_card_mode":{"description":"Determines whether or not credit cards are accepted","enum":["disabled","enabled","range"],"title":"Credit Card Mode","type":"string"},"credit_card_processing_fee_mode":{"description":"Determines how credit card processing fees should be handled","enum":["charge","do not charge","prompt user"],"title":"Credit Card Processing Fee Mode","type":"string"},"credit_card_processing_fee_options":{"additionalProperties":false,"properties":{"fee_percentage":{"description":"The fee percentage to charge for credit card processing ","format":"float","title":"Fee Percentage","type":"number"},"maximum_fee":{"description":"The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged","format":"float","title":"Maximum Fee","type":"number"},"minimum_fee":{"description":"The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged","format":"float","title":"Minimum Fee","type":"number"},"product_id":{"description":"The misc product to use for the credit card processing","title":"Product","type":"string"},"prompt_sub_text":{"description":"Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used","title":"Prompt Sub Text","type":"string"},"prompt_text":{"description":"The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used","title":"Prompt Text","type":"string"}},"required":["fee_percentage","product_id"],"title":"Credit Card Processing Fee Options","type":"object"},"currency_code":{"description":"The store currency code","title":"Currency Code","type":"string"},"currency_symbol":{"description":"The store currency symbol","title":"Currency Symbol","type":"string"},"default_certification_course_image_uri":{"description":"The image to display in the store for courses","title":"Default Certification Course Image Uri","type":"string"},"default_certification_exam_image_uri":{"description":"The image to display in the store for exams","title":"Default Certification Exam Image Uri","type":"string"},"default_event_registration_image_uri":{"description":"The image to display in the store for event registrations","title":"Default Event Registration Image Uri","type":"string"},"default_membership_package_image_uri":{"description":"The image to display in the store for membership","title":"Default Membership Package Image Uri","type":"string"},"default_merchandise_image_uri":{"description":"The default merchandise image","title":"Default Merchandise Image Uri","type":"string"},"default_product_sort":{"enum":["alphabetical ascending","alphabetical descending","newest items","price ascending","price descending","sort order"],"title":"Default Product Sort","type":"string"},"disable_electronic_payment_vaulting":{"description":"If set, in the portal people are not allowed to save credit cards","title":"Disable Electronic Payment Vaulting","type":"boolean"},"enable_bill_my_organization":{"description":"If set, the user has the option to bill their organization","title":"Enable Bill My Organization","type":"boolean"},"enable_bill_my_parent_organization":{"description":"If set, the user has the option to bill their organization's parent organization","title":"Enable Bill My Parent Organization","type":"boolean"},"enable_donations_at_checkout":{"description":"If selected, users will be prompted to make a donation upon checking out","title":"Enable Donations At Checkout","type":"boolean"},"enable_electronic_checks":{"description":"If set, electronic checks are allowed","title":"Enable Electronic Checks","type":"boolean"},"enable_pay_later":{"description":"If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed","title":"Enable Pay Later","type":"boolean"},"enable_payroll_deduction":{"description":"If set, payroll deduction is allowed","title":"Enable Payroll Deduction","type":"boolean"},"enable_split_payments":{"description":"If set, users are allowed to split payments","title":"Enable Split Payments","type":"boolean"},"event_registration_options":{"additionalProperties":false,"properties":{"category_name":{"description":"The optional name of the category","title":"Category Name","type":"string"},"event_ids":{"items":{"type":"string"},"minItems":0,"oneOf":[{"x-required":true}],"title":"Events","type":"array"},"event_restriction":{"enum":["exclude","include","none"],"title":"Event Restriction","type":"string"},"event_type_ids":{"items":{"type":"string"},"minItems":0,"oneOf":[{"x-required":true}],"title":"Event Types","type":"array"},"event_type_restriction":{"enum":["exclude","include","none"],"title":"Event Type Restriction","type":"string"}},"title":"Event Registration Options","type":"object"},"home_category_id":{"description":"The home category","title":"Home Category","type":"string"},"id":{"description":"The id of hte store","title":"ID","type":"string"},"installment_plan_options":{"items":{"additionalProperties":false,"properties":{"additional_cost":{"description":"The additional cost of the installment plan","format":"double","title":"Additional Cost","type":"number"},"installment_plan_id":{"description":"The installment plan that this product supports","title":"Installment Plan","type":"string"},"is_default":{"description":"Whether this is the default installment plan option","title":"Is Default","type":"boolean"}},"required":["installment_plan_id"],"type":"object"},"minItems":1,"type":"array"},"invoice_payment_terms_id":{"description":"The payment terms for invoices; if left blank, default is used","title":"Invoice Payment Terms","type":"string"},"invoice_template_id":{"description":"The template to use for invoices created during this process","title":"Invoice Template","type":"string"},"membership_package_options":{"additionalProperties":false,"properties":{"category_name":{"description":"The optional name of the category","title":"Category Name","type":"string"},"membership_package_ids":{"items":{"type":"string"},"minItems":0,"oneOf":[{"x-required":true}],"title":"Membership Packages","type":"array"},"membership_package_restriction":{"enum":["exclude","include","none"],"title":"Membership Package Restriction","type":"string"},"membership_type_ids":{"items":{"type":"string"},"minItems":0,"oneOf":[{"x-required":true}],"title":"Membership Types","type":"array"},"membership_type_restriction":{"enum":["exclude","include","none"],"title":"Membership Type Restriction","type":"string"}},"title":"Membership Package Options","type":"object"},"merchant_account_id":{"description":"The merchant account that the store should use to receive payments","title":"Merchant Account","type":"string"},"name":{"description":"The name of the store","title":"Name","type":"string"},"pay_later_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Pay Later Options","type":"object"},"restocking_fee_product_id":{"description":"The ID of the product used for restocking fees","title":"Restocking Fee Product","type":"string"},"sell_certification_courses":{"description":"If set, this store sells certification courses","title":"Sell Certification Courses","type":"boolean"},"sell_certification_exams":{"description":"If set, this store sells certification exams","title":"Sell Certification Exams","type":"boolean"},"sell_event_registration_packages":{"description":"If set, this store sells event registration packages","title":"Sell Event Registration Packages","type":"boolean"},"sell_membership_packages":{"description":"If set, this store sells membership packages","title":"Sell Membership Packages","type":"boolean"},"special_instructions":{"description":"Instructions shown to the user","title":"Special Instructions","type":"string"},"use_pro_forma_invoices":{"description":"Whether to use pro forma invoices when user elects to pay later","title":"Use Pro Forma Invoices","type":"boolean"}},"required":["bank_account_id","business_unit_id","certification_course_options","certification_exam_options","checkout_donation_options","credit_card_processing_fee_options","event_registration_options","installment_plan_options","membership_package_options","merchant_account_id"],"type":"object"}},"components/schemas/TaxClass":{"id":"components/schemas/TaxClass","kind":"json-schema","title":"TaxClass","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this tax class","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this class is active/enabled","title":"Is Active","type":"boolean"},"name":{"description":"The name of the tax class","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/TaxConfiguration":{"id":"components/schemas/TaxConfiguration","kind":"json-schema","title":"TaxConfiguration","data":{"additionalProperties":false,"properties":{"default_tax_product_id":{"description":"The default tax product id to use","title":"Default Tax Product","type":"string"},"notes":{"description":"Any notes about this configuration","title":"Notes","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"zones":{"items":{"additionalProperties":false,"properties":{"countries":{"items":{"additionalProperties":false,"properties":{"country":{"description":"The country","title":"Country","type":"string"}},"required":["country"],"type":"object"},"type":"array"},"enabled":{"description":"Whether or not this zone is enabled","title":"Enabled","type":"boolean"},"id":{"description":"A unique id for the zone","title":"ID","type":"string"},"name":{"description":"The name of the zone","title":"Name","type":"string"},"postal_code_ranges":{"items":{"additionalProperties":false,"properties":{"end":{"title":"End","type":"string"},"start":{"title":"Start","type":"string"}},"required":["end","start"],"type":"object"},"type":"array"},"rates":{"items":{"additionalProperties":false,"properties":{"classes":{"items":{"additionalProperties":false,"properties":{"class_id":{"description":"The ID of the tax class","title":"Class","type":"string"},"rate":{"description":"The tax rate percentage, from 0-100","format":"double","maximum":100,"minimum":0,"title":"Rate","type":"number"},"tax_product_id":{"description":"The default product to use for this rate/tax class","title":"Tax Product","type":"string"}},"required":["class_id"],"type":"object"},"type":"array"},"enabled":{"description":"Whether or not this rate is enabled","title":"Enabled","type":"boolean"},"name":{"description":"The name of the rate","title":"Name","type":"string"},"tax_product_id":{"description":"The tax product to use for this rate","title":"Tax Product","type":"string"}},"required":["enabled","name"],"type":"object"},"type":"array"},"states":{"items":{"additionalProperties":false,"properties":{"state":{"description":"The state","title":"State","type":"string"}},"required":["state"],"type":"object"},"type":"array"},"tax_product_id":{"description":"The default product to use for tax","title":"Tax Product","type":"string"},"type":{"enum":["country","postal code","rest of the world","state"],"title":"Type","type":"string"}},"required":["enabled","id","name"],"type":"object"},"type":"array"}},"required":["sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/TaxProduct":{"id":"components/schemas/TaxProduct","kind":"json-schema","title":"TaxProduct","data":{"additionalProperties":false,"properties":{"business_unit_id":{"description":"The business unit of the product","title":"Business Unit","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this miscellaneous product","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether this product is active/used","title":"Is Active","type":"boolean"},"name":{"description":"The name of the miscellaneous product","title":"Name","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type":{"description":"The product type","enum":["commerce-tax-products"],"title":"Type","type":"string"}},"required":["business_unit_id","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Warehouse":{"id":"components/schemas/Warehouse","kind":"json-schema","title":"Warehouse","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"default_reorder_point":{"description":"The default point at which an item should be reordered","format":"float","minimum":0,"title":"Default Reorder Point","type":"number"},"description":{"description":"Description of the warehouse","title":"Description","type":"string"},"enable_bins":{"description":"Whether or not this warehouse should track bins","title":"Enable Bins","type":"boolean"},"fulfillment_priority":{"description":"The order in which the warehouse should be displayed/processed","format":"float","title":"Fulfillment Priority","type":"number"},"id":{"description":"The unique, string identifier of this warehouse","pattern":"^[\\w_]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not the warehouse is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the warehouse","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/WarehouseBin":{"id":"components/schemas/WarehouseBin","kind":"json-schema","title":"WarehouseBin","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"description":{"description":"Any notes","title":"Description","type":"string"},"id":{"description":"The unique, string identifier of this warehouse bin","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not the warehouse bin is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the warehouse bin","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"warehouse_id":{"description":"The warehouse in  which this bin is located","title":"Warehouse","type":"string"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","warehouse_id"],"type":"object"}},"schema_459":{"kind":"json-schema","data":{"type":"string"},"id":"schema_459"},"schema_460":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/CancellationFee"},"type":"array"},"id":"schema_460"},"schema_461":{"kind":"json-schema","data":{"type":"object","properties":{"Access-Control-Allow-Headers":{"type":"string"},"Access-Control-Allow-Methods":{"type":"string"},"Access-Control-Allow-Origin":{"type":"string"}}},"id":"schema_461"},"schema_462":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/PatchDirective"},"type":"array"},"id":"schema_462"},"schema_463":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/CouponCodeGenProcess"},"type":"array"},"id":"schema_463"},"schema_464":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Coupon"},"type":"array"},"id":"schema_464"},"schema_465":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/DiscountProduct"},"type":"array"},"id":"schema_465"},"schema_466":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/EntitlementType"},"type":"array"},"id":"schema_466"},"schema_467":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Merchandise"},"type":"array"},"id":"schema_467"},"schema_468":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Order"},"type":"array"},"id":"schema_468"},"schema_469":{"kind":"json-schema","data":{"type":"object"},"id":"schema_469"},"schema_470":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ProductCategory"},"type":"array"},"id":"schema_470"},"schema_471":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ProductConfirmationEmail"},"type":"array"},"id":"schema_471"},"schema_472":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ProductInventory"},"type":"array"},"id":"schema_472"},"schema_473":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/SharedModifierOption"},"type":"array"},"id":"schema_473"},"schema_474":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/SharedVariantOption"},"type":"array"},"id":"schema_474"},"schema_475":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Shipment"},"type":"array"},"id":"schema_475"},"schema_476":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ShippingProduct"},"type":"array"},"id":"schema_476"},"schema_477":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_477"},"schema_478":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Store"},"type":"array"},"id":"schema_478"},"schema_479":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/TaxClass"},"type":"array"},"id":"schema_479"},"schema_480":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/TaxProduct"},"type":"array"},"id":"schema_480"},"schema_481":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/WarehouseBin"},"type":"array"},"id":"schema_481"},"schema_482":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Warehouse"},"type":"array"},"id":"schema_482"}},"exampleStore":{},"securitySchemeStore":{"knox-authorizer":{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"servers":[{"url":"/_mock/apis/commerce/commerce-v1","isMockServer":true,"description":"Mock server"},{"url":"https://commerce.api.rhythmsoftware.com"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/apis/commerce/commerce-v1","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/commerce/commerce-v1.json?download"},{"url":"/_bundle/apis/commerce/commerce-v1.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Commerce (Orders & Inventory)","description":"The Orders & Inventory, or Commerce, API is focused on the processing and fulfillment of Orders. Additionally, you can use\nthis API to manage your inventory, merchandise, and online store.\n\nLike most of the other Rhythm apps, the Commerce API includes endpoints for Query Definitions. These endpoints are commonly\nused to retrieve saved queries, which can then be executed using the Query endpoints of the System API. \n"}},"baseSlug":"/apis/commerce/commerce-v1","routesMapping":{}}