5 lines
204 KiB
JSON
5 lines
204 KiB
JSON
{
|
|
"componentChunkName": "component---src-templates-reference-page-js",
|
|
"path": "/api/store",
|
|
"result": {"pageContext":{"data":{"sections":[{"section":{"section_name":"Auth","paths":[{"name":"/auth","methods":[{"tags":["Auth"],"summary":"Authenticate Customer","description":"Logs a Customer in and authorizes them to view their details. Successful authentication will set a session cookie in the Customer's browser.","method":"post","operationId":"PostAuth","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/customer","property":"customer","description":null,"json":"{\n \"customer\": {\n \"id\": \"cus_01F0YESQXFZ5WKMHTXJ4JDPBDZ\",\n \"email\": \"test1@email.com\",\n \"first_name\": null,\n \"last_name\": null,\n \"billing_address_id\": null,\n \"password_hash\": null,\n \"phone\": null,\n \"has_account\": false,\n \"orders\": [],\n \"created_at\": \"2021-03-16T21:24:20.015Z\",\n \"updated_at\": \"2021-03-16T21:24:20.015Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n}","items":null}]}],"requestBody":{"type":"object","required":["email","password"],"properties":[{"description":"The Customer's email.","property":"email","type":"string","nestedModel":null},{"description":"The Customer's password.","property":"password","type":"string","nestedModel":null}]},"parameters":[]},{"tags":["Auth"],"summary":"Log out","description":"Destroys a Customer's authenticated session.","method":"delete","operationId":"DeleteAuth","responses":[{"status":"200","description":"OK","content":null}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":null},{"tags":["Auth"],"summary":"Get Session","description":"Gets the currently logged in Customer.","method":"get","operationId":"GetAuth","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/customer","property":"customer","description":null,"json":"{\n \"customer\": {\n \"id\": \"cus_01F0YESQXFZ5WKMHTXJ4JDPBDZ\",\n \"email\": \"test1@email.com\",\n \"first_name\": null,\n \"last_name\": null,\n \"billing_address_id\": null,\n \"password_hash\": null,\n \"phone\": null,\n \"has_account\": false,\n \"orders\": [],\n \"created_at\": \"2021-03-16T21:24:20.015Z\",\n \"updated_at\": \"2021-03-16T21:24:20.015Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":null}]},{"name":"/auth/{email}","methods":[{"tags":["Auth"],"summary":"Check if email has account","description":"Checks if a Customer with the given email has signed up.","method":"get","operationId":"GetAuthEmail","responses":[{"status":"200","description":"OK","content":[{"_ref":null,"property":"exists","description":null,"json":null,"items":null}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"The Customer's email.","in":"path","name":"email","required":true,"schema":{"type":"string"}}]}]}],"schema":null}},{"section":{"section_name":"Collection","paths":[{"name":"/collections/{id}","methods":[{"tags":["Collection"],"summary":"Retrieve a Product Collection","description":"Retrieves a Product Collection.","method":"get","operationId":"GetCollectionsCollection","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/product_collection","property":"collection","description":null,"json":"{\n \"collection\": {\n \"id\": \"pcol_01F0YESBFAZ0DV6V831JXWH0BG\",\n \"title\": \"Summer Collection\",\n \"handle\": \"summer-collection\",\n \"created_at\": \"2021-03-16T21:24:07.273Z\",\n \"updated_at\": \"2021-03-16T21:24:07.273Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"The id of the Product Collection","in":"path","name":"id","required":true,"schema":{"type":"string"}}]}]},{"name":"/collections","methods":[{"tags":["Collection"],"summary":"List Product Collections","description":"Retrieve a list of Product Collection.","method":"get","operationId":"GetCollections","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/product_collection","property":"collection","description":null,"json":"{\n \"collection\": {\n \"id\": \"pcol_01F0YESBFAZ0DV6V831JXWH0BG\",\n \"title\": \"Summer Collection\",\n \"handle\": \"summer-collection\",\n \"created_at\": \"2021-03-16T21:24:07.273Z\",\n \"updated_at\": \"2021-03-16T21:24:07.273Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"The number of collections to skip before starting to collect the collections set","in":"query","name":"offset","required":null,"schema":{"type":"integer"}},{"description":"The number of collections to return","in":"query","name":"limit","required":null,"schema":{"type":"integer"}}]}]}],"schema":{"object":"{\n \"id\": \"pcol_01F0YESBFAZ0DV6V831JXWH0BG\",\n \"title\": \"Summer Collection\",\n \"handle\": \"summer-collection\",\n \"created_at\": \"2021-03-16T21:24:07.273Z\",\n \"updated_at\": \"2021-03-16T21:24:07.273Z\",\n \"deleted_at\": null,\n \"metadata\": null\n}","description":"Product Collections represents a group of Products that are related.","properties":[{"property":"id","type":"string","description":"The id of the Product Collection. This value will be prefixed with `pcol_`.","format":null,"nestedModel":null},{"property":"title","type":"string","description":"The title that the Product Collection is identified by.","format":null,"nestedModel":null},{"property":"handle","type":"string","description":"A unique string that identifies the Product Collection - can for example be used in slug structures.","format":null,"nestedModel":null},{"property":"products","type":"array","description":"The Products contained in the Product Collection.","format":null,"nestedModel":null},{"property":"created_at","type":"string","description":"The date with timezone at which the resource was created.","format":"date-time","nestedModel":null},{"property":"updated_at","type":"string","description":"The date with timezone at which the resource was last updated.","format":"date-time","nestedModel":null},{"property":"deleted_at","type":"string","description":"The date with timezone at which the resource was last updated.","format":"date-time","nestedModel":null},{"property":"metadata","type":"object","description":"An optional key-value map with additional information.","format":null,"nestedModel":null}]}}},{"section":{"section_name":"Gift Card","paths":[{"name":"/gift-cards/{code}","methods":[{"tags":["Gift Card"],"summary":"Retrieve Gift Card by Code","description":"Retrieves a Gift Card by its associated unqiue code.","method":"get","operationId":"GetGiftCardsCode","responses":[{"status":"200","description":"OK","content":[{"_ref":null,"property":"id","description":"The id of the Gift Card","json":null,"items":null},{"_ref":null,"property":"code","description":"The code of the Gift Card","json":null,"items":null},{"_ref":null,"property":"value","description":"The original value of the Gift Card.","json":null,"items":null},{"_ref":null,"property":"balance","description":"The current balanace of the Gift Card","json":null,"items":null},{"_ref":"#/components/schemas/region","property":"region","description":null,"json":"{\n \"region\": {\n \"id\": \"reg_01F0YES4R67TXXC1QBQ8P54A8Y\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"payment_providers\": [],\n \"fulfillment_providers\": [\n {\n \"id\": \"test-ful\",\n \"is_installed\": true\n }\n ],\n \"created_at\": \"2021-03-16T21:24:00.389Z\",\n \"updated_at\": \"2021-03-16T21:24:00.389Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"The unique Gift Card code.","in":"path","name":"code","required":true,"schema":{"type":"string"}}]}]}],"schema":{"object":"{\n \"id\": \"gift_01F0YESEKYJ5578VCAPV4XYFDP\",\n \"code\": \"1J3U-WXO0-SZ0H-O5QU\",\n \"value\": 1000,\n \"balance\": 1000,\n \"region_id\": \"reg_01F0YESEJP4H8Q517XSPGK6TD6\",\n \"region\": {\n \"id\": \"reg_01F0YESEJP4H8Q517XSPGK6TD6\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"payment_providers\": [],\n \"fulfillment_providers\": [],\n \"created_at\": \"2021-03-16T21:24:10.454Z\",\n \"updated_at\": \"2021-03-16T21:24:10.454Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"is_disabled\": false,\n \"ends_at\": null,\n \"created_at\": \"2021-03-16T21:24:10.484Z\",\n \"updated_at\": \"2021-03-16T21:24:10.484Z\",\n \"deleted_at\": null,\n \"metadata\": null\n}","description":"Gift Cards are redeemable and represent a value that can be used towards the payment of an Order.","properties":[{"property":"id","type":"string","description":"The id of the Gift Card. This value will be prefixed by `gift_`.","format":null,"nestedModel":null},{"property":"code","type":"string","description":"The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.","format":null,"nestedModel":null},{"property":"value","type":"integer","description":"The value that the Gift Card represents.","format":null,"nestedModel":null},{"property":"balance","type":"integer","description":"The remaining value on the Gift Card.","format":null,"nestedModel":null},{"property":"region_id","type":"string","description":"The id of the Region in which the Gift Card is available.","format":null,"nestedModel":null},{"property":"region","type":null,"description":"The Region in which the Gift Card is available.","format":null,"nestedModel":{"title":"Region","properties":[{"property":"id","type":"string"},{"property":"name","type":"string"},{"property":"currency_code","type":"string"},{"property":"tax_rate","type":"number"},{"property":"tax_code","type":"string"},{"property":"countries","type":"array"},{"property":"payment_providers","type":"array"},{"property":"fulfillment_providers","type":"array"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"deleted_at","type":"string"},{"property":"metadata","type":"object"}]}},{"property":"order_id","type":"string","description":"The id of the Order that the Gift Card was purchased in.","format":null,"nestedModel":null},{"property":"is_disabled","type":"boolean","description":"Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.","format":null,"nestedModel":null},{"property":"ends_at","type":"string","description":"The time at which the Gift Card can no longer be used.","format":"date-time","nestedModel":null},{"property":"created_at","type":"string","description":"The date with timezone at which the resource was created.","format":"date-time","nestedModel":null},{"property":"updated_at","type":"string","description":"The date with timezone at which the resource was last updated.","format":"date-time","nestedModel":null},{"property":"deleted_at","type":"string","description":"The date with timezone at which the resource was deleted.","format":"date-time","nestedModel":null},{"property":"metadata","type":"object","description":"An optional key-value map with additional information.","format":null,"nestedModel":null}]}}},{"section":{"section_name":"Customer","paths":[{"name":"/customers/me/addresses","methods":[{"tags":["Customer"],"summary":"Add a Shipping Address","description":"Adds a Shipping Address to a Customer's saved addresses.","method":"post","operationId":"PostCustomersCustomerAddresses","responses":[{"status":"200","description":"A successful response","content":[{"_ref":"#/components/schemas/customer","property":"customer","description":null,"json":"{\n \"customer\": {\n \"id\": \"cus_01F0YESQXFZ5WKMHTXJ4JDPBDZ\",\n \"email\": \"test1@email.com\",\n \"first_name\": null,\n \"last_name\": null,\n \"billing_address_id\": null,\n \"password_hash\": null,\n \"phone\": null,\n \"has_account\": false,\n \"orders\": [],\n \"created_at\": \"2021-03-16T21:24:20.015Z\",\n \"updated_at\": \"2021-03-16T21:24:20.015Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n}","items":null}]}],"requestBody":{"type":null,"required":["address"],"properties":[{"description":"The Address to add to the Customer.","property":"address","type":null,"nestedModel":{"title":"Address","properties":[{"property":"id","type":"string"},{"property":"customer_id","type":"string"},{"property":"company","type":"string"},{"property":"first_name","type":"string"},{"property":"last_name","type":"string"},{"property":"address_1","type":"string"},{"property":"address_2","type":"string"},{"property":"city","type":"string"},{"property":"country_code","type":"string"},{"property":"country","type":null}]}}]},"parameters":null}]},{"name":"/customers","methods":[{"tags":["Customer"],"summary":"Create a Customer","description":"Creates a Customer account.","method":"post","operationId":"PostCustomers","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/customer","property":"customer","description":null,"json":"{\n \"customer\": {\n \"id\": \"cus_01F0YESQXFZ5WKMHTXJ4JDPBDZ\",\n \"email\": \"test1@email.com\",\n \"first_name\": null,\n \"last_name\": null,\n \"billing_address_id\": null,\n \"password_hash\": null,\n \"phone\": null,\n \"has_account\": false,\n \"orders\": [],\n \"created_at\": \"2021-03-16T21:24:20.015Z\",\n \"updated_at\": \"2021-03-16T21:24:20.015Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n}","items":null}]}],"requestBody":{"type":"object","required":["email","first_name","last_name","password"],"properties":[{"description":"The Customer's email address.","property":"email","type":"string","nestedModel":null},{"description":"The Customer's first name.","property":"first_name","type":"string","nestedModel":null},{"description":"The Customer's last name.","property":"last_name","type":"string","nestedModel":null},{"description":"The Customer's password for login.","property":"password","type":"string","nestedModel":null},{"description":"The Customer's phone number.","property":"phone","type":"string","nestedModel":null}]},"parameters":[]}]},{"name":"/customers/me/addresses/{address_id}","methods":[{"tags":["Customer"],"summary":"Delete an Address","description":"Removes an Address from the Customer's saved addresse.","method":"delete","operationId":"DeleteCustomersCustomerAddressesAddress","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/customer","property":"customer","description":null,"json":"{\n \"customer\": {\n \"id\": \"cus_01F0YESQXFZ5WKMHTXJ4JDPBDZ\",\n \"email\": \"test1@email.com\",\n \"first_name\": null,\n \"last_name\": null,\n \"billing_address_id\": null,\n \"password_hash\": null,\n \"phone\": null,\n \"has_account\": false,\n \"orders\": [],\n \"created_at\": \"2021-03-16T21:24:20.015Z\",\n \"updated_at\": \"2021-03-16T21:24:20.015Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"The id of the Address to remove.","in":"path","name":"address_id","required":true,"schema":{"type":"string"}}]},{"tags":["Customer"],"summary":"Update a Shipping Address","description":"Updates a Customer's saved Shipping Address.","method":"post","operationId":"PostCustomersCustomerAddressesAddress","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/customer","property":"customer","description":null,"json":"{\n \"customer\": {\n \"id\": \"cus_01F0YESQXFZ5WKMHTXJ4JDPBDZ\",\n \"email\": \"test1@email.com\",\n \"first_name\": null,\n \"last_name\": null,\n \"billing_address_id\": null,\n \"password_hash\": null,\n \"phone\": null,\n \"has_account\": false,\n \"orders\": [],\n \"created_at\": \"2021-03-16T21:24:20.015Z\",\n \"updated_at\": \"2021-03-16T21:24:20.015Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[{"description":"The updated Address.","property":"address","type":null,"nestedModel":{"title":"Address","properties":[{"property":"id","type":"string"},{"property":"customer_id","type":"string"},{"property":"company","type":"string"},{"property":"first_name","type":"string"},{"property":"last_name","type":"string"},{"property":"address_1","type":"string"},{"property":"address_2","type":"string"},{"property":"city","type":"string"},{"property":"country_code","type":"string"},{"property":"country","type":null}]}}]},"parameters":[{"description":"The id of the Address to update.","in":"path","name":"address_id","required":true,"schema":{"type":"string"}}]}]},{"name":"/customers/me","methods":[{"tags":["Customer"],"summary":"Retrieves a Customer","description":"Retrieves a Customer - the Customer must be logged in to retrieve their details.","method":"get","operationId":"GetCustomersCustomer","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/customer","property":"customer","description":null,"json":"{\n \"customer\": {\n \"id\": \"cus_01F0YESQXFZ5WKMHTXJ4JDPBDZ\",\n \"email\": \"test1@email.com\",\n \"first_name\": null,\n \"last_name\": null,\n \"billing_address_id\": null,\n \"password_hash\": null,\n \"phone\": null,\n \"has_account\": false,\n \"orders\": [],\n \"created_at\": \"2021-03-16T21:24:20.015Z\",\n \"updated_at\": \"2021-03-16T21:24:20.015Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":null},{"tags":["Customer"],"summary":"Update Customer details","description":"Updates a Customer's saved details.","method":"post","operationId":"PostCustomersCustomer","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/customer","property":"customer","description":null,"json":"{\n \"customer\": {\n \"id\": \"cus_01F0YESQXFZ5WKMHTXJ4JDPBDZ\",\n \"email\": \"test1@email.com\",\n \"first_name\": null,\n \"last_name\": null,\n \"billing_address_id\": null,\n \"password_hash\": null,\n \"phone\": null,\n \"has_account\": false,\n \"orders\": [],\n \"created_at\": \"2021-03-16T21:24:20.015Z\",\n \"updated_at\": \"2021-03-16T21:24:20.015Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[{"description":"The Customer's first name.","property":"first_name","type":"string","nestedModel":null},{"description":"The Customer's last name.","property":"last_name","type":"string","nestedModel":null},{"description":"The Address to be used for billing purposes.","property":"billing_address","type":null,"nestedModel":{"title":"Address","properties":[{"property":"id","type":"string"},{"property":"customer_id","type":"string"},{"property":"company","type":"string"},{"property":"first_name","type":"string"},{"property":"last_name","type":"string"},{"property":"address_1","type":"string"},{"property":"address_2","type":"string"},{"property":"city","type":"string"},{"property":"country_code","type":"string"},{"property":"country","type":null}]}},{"description":"The Customer's password.","property":"password","type":"string","nestedModel":null},{"description":"The Customer's phone number.","property":"phone","type":"string","nestedModel":null},{"description":"The email of the customer.","property":"email","type":"string","nestedModel":null},{"description":"Metadata about the customer.","property":"metadata","type":"object","nestedModel":null}]},"parameters":null}]},{"name":"/customers/me/payment-methods","methods":[{"tags":["Customer"],"summary":"Retrieve saved payment methods","description":"Retrieves a list of a Customer's saved payment methods. Payment methods are saved with Payment Providers and it is their responsibility to fetch saved methods.","method":"get","operationId":"GetCustomersCustomerPaymentMethods","responses":[{"status":"200","description":"OK","content":[{"_ref":null,"property":"payment_methods","description":null,"json":null,"items":{"_ref":null}}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":null}]},{"name":"/customers/me/orders","methods":[{"tags":["Customer"],"summary":"Retrieve Customer Orders","description":"Retrieves a list of a Customer's Orders.","method":"get","operationId":"GetCustomersCustomerOrders","responses":[{"status":"200","description":"OK","content":[{"_ref":null,"property":"count","description":"The total number of Orders.","json":null,"items":null},{"_ref":null,"property":"offset","description":"The offset for pagination.","json":null,"items":null},{"_ref":null,"property":"limit","description":"The maxmimum number of Orders to return,","json":null,"items":null},{"_ref":null,"property":"orders","description":null,"json":"{\n \"orders\": [\n {\n \"id\": \"order_01F0YET7CZ741ECWG1J3N34RXF\",\n \"status\": \"pending\",\n \"fulfillment_status\": \"not_fulfilled\",\n \"payment_status\": \"not_paid\",\n \"display_id\": 1,\n \"cart_id\": null,\n \"customer_id\": \"cus_01F0YET7C3H3D5M8QPNPP5CDAX\",\n \"customer\": {\n \"id\": \"cus_01F0YET7C3H3D5M8QPNPP5CDAX\",\n \"email\": \"test@email.com\",\n \"first_name\": null,\n \"last_name\": null,\n \"billing_address_id\": null,\n \"password_hash\": null,\n \"phone\": null,\n \"has_account\": false,\n \"created_at\": \"2021-03-16T21:24:35.843Z\",\n \"updated_at\": \"2021-03-16T21:24:35.843Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"email\": \"test@email.com\",\n \"billing_address\": {\n \"id\": \"addr_01F0YET7CZZX0842X5AHQYAZ80\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": \"lebron\",\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": null,\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"shipping_address\": {\n \"id\": \"addr_01F0YET7CZDHXHXYJ3JTXPH4T7\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": \"lebron\",\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": \"us\",\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"region_id\": \"reg_01F0YET7BZTARY9MKN1SJ7AAXF\",\n \"region\": {\n \"id\": \"reg_01F0YET7BZTARY9MKN1SJ7AAXF\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"payment_providers\": [],\n \"fulfillment_providers\": [],\n \"created_at\": \"2021-03-16T21:24:35.839Z\",\n \"updated_at\": \"2021-03-16T21:24:35.839Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"currency_code\": \"usd\",\n \"tax_rate\": 0,\n \"discounts\": [\n {\n \"id\": \"test-discount\",\n \"code\": \"TEST134\",\n \"is_dynamic\": false,\n \"rule_id\": \"dru_01F0YET7CZQDGWTFQYY8T4KYRZ\",\n \"rule\": {\n \"id\": \"dru_01F0YET7CZQDGWTFQYY8T4KYRZ\",\n \"description\": \"Test Discount\",\n \"type\": \"percentage\",\n \"value\": 10,\n \"allocation\": \"total\",\n \"usage_limit\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"is_disabled\": false,\n \"parent_discount_id\": null,\n \"starts_at\": \"2021-03-16T21:24:35.871Z\",\n \"ends_at\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ],\n \"gift_cards\": [],\n \"shipping_methods\": [\n {\n \"id\": \"sm_01F0YET7DR2E7CYVSDHM593QG2\",\n \"shipping_option_id\": \"so_01F0YET7C758MMXF1WNVCPGKZJ\",\n \"order_id\": \"order_01F0YET7CZ741ECWG1J3N34RXF\",\n \"claim_order_id\": null,\n \"cart_id\": null,\n \"swap_id\": null,\n \"return_id\": null,\n \"shipping_option\": {\n \"id\": \"so_01F0YET7C758MMXF1WNVCPGKZJ\",\n \"name\": \"test-option\",\n \"region_id\": \"reg_01F0YET7BZTARY9MKN1SJ7AAXF\",\n \"profile_id\": \"sp_01F0YET7AF62TCC9CMWK5TXXAQ\",\n \"provider_id\": \"test-ful\",\n \"price_type\": \"flat_rate\",\n \"amount\": 1000,\n \"is_return\": false,\n \"data\": {},\n \"created_at\": \"2021-03-16T21:24:35.846Z\",\n \"updated_at\": \"2021-03-16T21:24:35.846Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"price\": 1000,\n \"data\": {}\n }\n ],\n \"payments\": [\n {\n \"id\": \"test-payment\",\n \"swap_id\": null,\n \"cart_id\": null,\n \"order_id\": \"order_01F0YET7CZ741ECWG1J3N34RXF\",\n \"amount\": 10000,\n \"currency_code\": \"usd\",\n \"amount_refunded\": 0,\n \"provider_id\": \"test\",\n \"data\": {},\n \"captured_at\": null,\n \"canceled_at\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"metadata\": null,\n \"idempotency_key\": null\n }\n ],\n \"fulfillments\": [],\n \"returns\": [],\n \"claims\": [],\n \"refunds\": [],\n \"swaps\": [],\n \"items\": [\n {\n \"id\": \"test-item\",\n \"cart_id\": null,\n \"order_id\": \"order_01F0YET7CZ741ECWG1J3N34RXF\",\n \"swap_id\": null,\n \"claim_order_id\": null,\n \"title\": \"Line Item\",\n \"description\": \"Line Item Desc\",\n \"thumbnail\": \"https://test.js/1234\",\n \"is_giftcard\": false,\n \"should_merge\": true,\n \"allow_discounts\": true,\n \"has_shipping\": null,\n \"unit_price\": 8000,\n \"variant_id\": \"variant_01F0YET7BMD9FGWA5NTPBWT2SS\",\n \"variant\": {\n \"id\": \"variant_01F0YET7BMD9FGWA5NTPBWT2SS\",\n \"title\": \"test variant\",\n \"product_id\": \"prod_01F0YET7BA4AQ8WEK687BNWP3N\",\n \"product\": {\n \"id\": \"prod_01F0YET7BA4AQ8WEK687BNWP3N\",\n \"title\": \"test product\",\n \"subtitle\": null,\n \"description\": null,\n \"handle\": \"test-product\",\n \"is_giftcard\": false,\n \"thumbnail\": null,\n \"profile_id\": \"sp_01F0YET7AF62TCC9CMWK5TXXAQ\",\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"collection_id\": null,\n \"type_id\": null,\n \"created_at\": \"2021-03-16T21:24:35.818Z\",\n \"updated_at\": \"2021-03-16T21:24:35.818Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"sku\": null,\n \"barcode\": null,\n \"ean\": null,\n \"upc\": null,\n \"inventory_quantity\": 1,\n \"allow_backorder\": false,\n \"manage_inventory\": true,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"created_at\": \"2021-03-16T21:24:35.828Z\",\n \"updated_at\": \"2021-03-16T21:24:35.828Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"quantity\": 1,\n \"fulfilled_quantity\": 1,\n \"returned_quantity\": null,\n \"shipped_quantity\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"metadata\": null,\n \"refundable\": 7200\n }\n ],\n \"gift_card_transactions\": [],\n \"canceled_at\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"metadata\": null,\n \"shipping_total\": 1000,\n \"gift_card_total\": 0,\n \"discount_total\": 800,\n \"tax_total\": 0,\n \"subtotal\": 8000,\n \"total\": 8200,\n \"refunded_total\": 0,\n \"refundable_amount\": 8200\n }\n ]\n}","items":{"_ref":"#/components/schemas/order"}}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"How many addresses to return.","in":"query","name":"limit","required":null,"schema":{"type":"integer"}},{"description":"The offset in the resulting addresses.","in":"query","name":"offset","required":null,"schema":{"type":"integer"}},{"description":"(Comma separated string) Which fields should be included in the resulting addresses.","in":"query","name":"fields","required":null,"schema":{"type":"string"}},{"description":"(Comma separated string) Which relations should be expanded in the resulting addresses.","in":"query","name":"expand","required":null,"schema":{"type":"string"}}]}]},{"name":"/customers/password-token","methods":[{"tags":["Customer"],"summary":"Creates a reset password token","description":"Creates a reset password token to be used in a subsequent /reset-password request. The password token should be sent out of band e.g. via email and will not be returned.","method":"post","operationId":"PostCustomersCustomerPasswordToken","responses":[{"status":"204","description":"OK","content":null}],"requestBody":{"type":"object","required":["email"],"properties":[{"description":"Email of the user whose password should be reset.","property":"email","type":"string","nestedModel":null}]},"parameters":[]}]},{"name":"/customers/reset-password","methods":[{"tags":["Customer"],"summary":"Resets Customer password","description":"Resets a Customer's password using a password token created by a previous /password-token request.","method":"post","operationId":"PostCustomersResetPassword","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/customer","property":"customer","description":null,"json":"{\n \"customer\": {\n \"id\": \"cus_01F0YESQXFZ5WKMHTXJ4JDPBDZ\",\n \"email\": \"test1@email.com\",\n \"first_name\": null,\n \"last_name\": null,\n \"billing_address_id\": null,\n \"password_hash\": null,\n \"phone\": null,\n \"has_account\": false,\n \"orders\": [],\n \"created_at\": \"2021-03-16T21:24:20.015Z\",\n \"updated_at\": \"2021-03-16T21:24:20.015Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n}","items":null}]}],"requestBody":{"type":"object","required":["email","token","password"],"properties":[{"description":"The Customer's email.","property":"email","type":"string","nestedModel":null},{"description":"The password token created by a /password-token request.","property":"token","type":"string","nestedModel":null},{"description":"The new password to set for the Customer.","property":"password","type":"string","nestedModel":null}]},"parameters":[]}]}],"schema":{"object":"{\n \"id\": \"cus_01F0YESQXFZ5WKMHTXJ4JDPBDZ\",\n \"email\": \"test1@email.com\",\n \"first_name\": null,\n \"last_name\": null,\n \"billing_address_id\": null,\n \"password_hash\": null,\n \"phone\": null,\n \"has_account\": false,\n \"orders\": [],\n \"created_at\": \"2021-03-16T21:24:20.015Z\",\n \"updated_at\": \"2021-03-16T21:24:20.015Z\",\n \"deleted_at\": null,\n \"metadata\": null\n}","description":"Represents a customer","properties":[{"property":"id","type":"string","description":null,"format":null,"nestedModel":null},{"property":"email","type":"string","description":null,"format":null,"nestedModel":null},{"property":"billing_address_id","type":"string","description":null,"format":null,"nestedModel":null},{"property":"billing_address","type":null,"description":"The Customer's billing address.","format":null,"nestedModel":{"title":"Address","properties":[{"property":"id","type":"string"},{"property":"customer_id","type":"string"},{"property":"company","type":"string"},{"property":"first_name","type":"string"},{"property":"last_name","type":"string"},{"property":"address_1","type":"string"},{"property":"address_2","type":"string"},{"property":"city","type":"string"},{"property":"country_code","type":"string"},{"property":"country","type":null}]}},{"property":"shipping_addresses","type":"array","description":null,"format":null,"nestedModel":{"title":"Address","properties":[{"property":"id","type":"string"},{"property":"customer_id","type":"string"},{"property":"company","type":"string"},{"property":"first_name","type":"string"},{"property":"last_name","type":"string"},{"property":"address_1","type":"string"},{"property":"address_2","type":"string"},{"property":"city","type":"string"},{"property":"country_code","type":"string"},{"property":"country","type":null}]}},{"property":"first_name","type":"string","description":null,"format":null,"nestedModel":null},{"property":"last_name","type":"string","description":null,"format":null,"nestedModel":null},{"property":"phone","type":"string","description":null,"format":null,"nestedModel":null},{"property":"has_account","type":"boolean","description":null,"format":null,"nestedModel":null},{"property":"created_at","type":"string","description":null,"format":"date-time","nestedModel":null},{"property":"updated_at","type":"string","description":null,"format":"date-time","nestedModel":null},{"property":"deleted_at","type":"string","description":null,"format":"date-time","nestedModel":null},{"property":"metadata","type":"object","description":null,"format":null,"nestedModel":null}]}}},{"section":{"section_name":"Cart","paths":[{"name":"/carts/{id}/shipping-methods","methods":[{"tags":["Cart"],"summary":"Add a Shipping Method","description":"Adds a Shipping Method to the Cart.","method":"post","operationId":"PostCartsCartShippingMethod","responses":[{"status":"200","description":"A successful response","content":[{"_ref":"#/components/schemas/cart","property":"cart","description":null,"json":"{\n \"cart\": {\n \"id\": \"cart_01F0YES82DA12W88KQ90EY6W4C\",\n \"email\": null,\n \"billing_address_id\": null,\n \"billing_address\": null,\n \"shipping_address_id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"shipping_address\": {\n \"id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": null,\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": \"us\",\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.766Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"items\": [],\n \"region_id\": \"region\",\n \"region\": {\n \"id\": \"region\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"countries\": [\n {\n \"id\": 236,\n \"iso_2\": \"us\",\n \"iso_3\": \"usa\",\n \"num_code\": 840,\n \"name\": \"UNITED STATES\",\n \"display_name\": \"United States\",\n \"region_id\": \"region\"\n }\n ],\n \"payment_providers\": [],\n \"fulfillment_providers\": [],\n \"created_at\": \"2021-03-16T21:24:03.743Z\",\n \"updated_at\": \"2021-03-16T21:24:03.743Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"discounts\": [],\n \"gift_cards\": [],\n \"customer_id\": null,\n \"payment_sessions\": [],\n \"payment_id\": null,\n \"payment\": null,\n \"shipping_methods\": [],\n \"type\": \"default\",\n \"completed_at\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.857Z\",\n \"deleted_at\": null,\n \"metadata\": null,\n \"idempotency_key\": null,\n \"context\": {\n \"ip\": \"::ffff:127.0.0.1\",\n \"user_agent\": \"axios/0.21.1\"\n },\n \"shipping_total\": 0,\n \"discount_total\": 0,\n \"tax_total\": 0,\n \"gift_card_total\": 0,\n \"subtotal\": 0,\n \"total\": 0\n }\n}","items":null}]}],"requestBody":{"type":"object","required":["option_id"],"properties":[{"description":"id of the shipping option to create the method from","property":"option_id","type":"string","nestedModel":null},{"description":"Used to hold any data that the shipping method may need to process the fulfillment of the order. Look at the documentation for your installed fulfillment providers to find out what to send.","property":"data","type":"object","nestedModel":null}]},"parameters":[{"description":"The cart id.","in":"path","name":"id","required":true,"schema":{"type":"string"}}]}]},{"name":"/carts/{id}/complete","methods":[{"tags":["Cart"],"summary":"Complete a Cart","description":"Completes a cart. The following steps will be performed. Payment authorization is attempted and if more work is required, we simply return the cart for further updates. If payment is authorized and order is not yet created, we make sure to do so. The completion of a cart can be performed idempotently with a provided header `Idempotency-Key`. If not provided, we will generate one for the request.","method":"post","operationId":"PostCartsCartComplete","responses":[{"status":"200","description":"If a cart was successfully authorized, but requires further action from the user the response body will contain the cart with an updated payment session. If the Cart was successfully completed the response body will contain the newly created Order.","content":null}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"The Cart id.","in":"path","name":"id","required":true,"schema":{"type":"string"}}]}]},{"name":"/carts","methods":[{"tags":["Cart"],"summary":"Create a Cart","description":"Creates a Cart within the given region and with the initial items. If no `region_id` is provided the cart will be associated with the first Region available. If no items are provided the cart will be empty after creation. If a user is logged in the cart's customer id and email will be set.","method":"post","operationId":"PostCart","responses":[{"status":"200","description":"Successfully created a new Cart","content":[{"_ref":"#/components/schemas/cart","property":"cart","description":null,"json":"{\n \"cart\": {\n \"id\": \"cart_01F0YES82DA12W88KQ90EY6W4C\",\n \"email\": null,\n \"billing_address_id\": null,\n \"billing_address\": null,\n \"shipping_address_id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"shipping_address\": {\n \"id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": null,\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": \"us\",\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.766Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"items\": [],\n \"region_id\": \"region\",\n \"region\": {\n \"id\": \"region\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"countries\": [\n {\n \"id\": 236,\n \"iso_2\": \"us\",\n \"iso_3\": \"usa\",\n \"num_code\": 840,\n \"name\": \"UNITED STATES\",\n \"display_name\": \"United States\",\n \"region_id\": \"region\"\n }\n ],\n \"payment_providers\": [],\n \"fulfillment_providers\": [],\n \"created_at\": \"2021-03-16T21:24:03.743Z\",\n \"updated_at\": \"2021-03-16T21:24:03.743Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"discounts\": [],\n \"gift_cards\": [],\n \"customer_id\": null,\n \"payment_sessions\": [],\n \"payment_id\": null,\n \"payment\": null,\n \"shipping_methods\": [],\n \"type\": \"default\",\n \"completed_at\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.857Z\",\n \"deleted_at\": null,\n \"metadata\": null,\n \"idempotency_key\": null,\n \"context\": {\n \"ip\": \"::ffff:127.0.0.1\",\n \"user_agent\": \"axios/0.21.1\"\n },\n \"shipping_total\": 0,\n \"discount_total\": 0,\n \"tax_total\": 0,\n \"gift_card_total\": 0,\n \"subtotal\": 0,\n \"total\": 0\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[{"description":"The id of the Region to create the Cart in.","property":"region_id","type":"string","nestedModel":null},{"description":"The 2 character ISO country code to create the Cart in.","property":"country_code","type":"string","nestedModel":null},{"description":"An optional array of `variant_id`, `quantity` pairs to generate Line Items from.","property":"items","type":"array","nestedModel":null},{"description":"An optional object to provide context to the Cart. The `context` field is automatically populated with `ip` and `user_agent`","property":"context","type":"object","nestedModel":null}]},"parameters":null}]},{"name":"/carts/{id}/line-items","methods":[{"tags":["Cart"],"summary":"Add a Line Item","description":"Generates a Line Item with a given Product Variant and adds it to the Cart","method":"post","operationId":"PostCartsCartLineItems","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/cart","property":"cart","description":null,"json":"{\n \"cart\": {\n \"id\": \"cart_01F0YES82DA12W88KQ90EY6W4C\",\n \"email\": null,\n \"billing_address_id\": null,\n \"billing_address\": null,\n \"shipping_address_id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"shipping_address\": {\n \"id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": null,\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": \"us\",\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.766Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"items\": [],\n \"region_id\": \"region\",\n \"region\": {\n \"id\": \"region\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"countries\": [\n {\n \"id\": 236,\n \"iso_2\": \"us\",\n \"iso_3\": \"usa\",\n \"num_code\": 840,\n \"name\": \"UNITED STATES\",\n \"display_name\": \"United States\",\n \"region_id\": \"region\"\n }\n ],\n \"payment_providers\": [],\n \"fulfillment_providers\": [],\n \"created_at\": \"2021-03-16T21:24:03.743Z\",\n \"updated_at\": \"2021-03-16T21:24:03.743Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"discounts\": [],\n \"gift_cards\": [],\n \"customer_id\": null,\n \"payment_sessions\": [],\n \"payment_id\": null,\n \"payment\": null,\n \"shipping_methods\": [],\n \"type\": \"default\",\n \"completed_at\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.857Z\",\n \"deleted_at\": null,\n \"metadata\": null,\n \"idempotency_key\": null,\n \"context\": {\n \"ip\": \"::ffff:127.0.0.1\",\n \"user_agent\": \"axios/0.21.1\"\n },\n \"shipping_total\": 0,\n \"discount_total\": 0,\n \"tax_total\": 0,\n \"gift_card_total\": 0,\n \"subtotal\": 0,\n \"total\": 0\n }\n}","items":null}]}],"requestBody":{"type":"object","required":["variant_id","quantity"],"properties":[{"description":"The id of the Product Variant to generate the Line Item from.","property":"variant_id","type":"string","nestedModel":null},{"description":"The quantity of the Product Variant to add to the Line Item.","property":"quantity","type":"integer","nestedModel":null},{"description":"An optional key-value map with additional details about the Line Item.","property":"metadata","type":"object","nestedModel":null}]},"parameters":[{"description":"The id of the Cart to add the Line Item to.","in":"path","name":"id","required":true,"schema":{"type":"string"}}]}]},{"name":"/carts/{id}/payment-sessions","methods":[{"tags":["Cart"],"summary":"Initialize Payment Sessions","description":"Creates Payment Sessions for each of the available Payment Providers in the Cart's Region.","method":"post","operationId":"PostCartsCartPaymentSessions","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/cart","property":"cart","description":null,"json":"{\n \"cart\": {\n \"id\": \"cart_01F0YES82DA12W88KQ90EY6W4C\",\n \"email\": null,\n \"billing_address_id\": null,\n \"billing_address\": null,\n \"shipping_address_id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"shipping_address\": {\n \"id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": null,\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": \"us\",\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.766Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"items\": [],\n \"region_id\": \"region\",\n \"region\": {\n \"id\": \"region\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"countries\": [\n {\n \"id\": 236,\n \"iso_2\": \"us\",\n \"iso_3\": \"usa\",\n \"num_code\": 840,\n \"name\": \"UNITED STATES\",\n \"display_name\": \"United States\",\n \"region_id\": \"region\"\n }\n ],\n \"payment_providers\": [],\n \"fulfillment_providers\": [],\n \"created_at\": \"2021-03-16T21:24:03.743Z\",\n \"updated_at\": \"2021-03-16T21:24:03.743Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"discounts\": [],\n \"gift_cards\": [],\n \"customer_id\": null,\n \"payment_sessions\": [],\n \"payment_id\": null,\n \"payment\": null,\n \"shipping_methods\": [],\n \"type\": \"default\",\n \"completed_at\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.857Z\",\n \"deleted_at\": null,\n \"metadata\": null,\n \"idempotency_key\": null,\n \"context\": {\n \"ip\": \"::ffff:127.0.0.1\",\n \"user_agent\": \"axios/0.21.1\"\n },\n \"shipping_total\": 0,\n \"discount_total\": 0,\n \"tax_total\": 0,\n \"gift_card_total\": 0,\n \"subtotal\": 0,\n \"total\": 0\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"The id of the Cart.","in":"path","name":"id","required":true,"schema":{"type":"string"}}]}]},{"name":"/carts/{id}/discounts/{code}","methods":[{"tags":["Cart"],"summary":"Remove Discount from Cart","description":"Removes a Discount from a Cart.","method":"delete","operationId":"DeleteCartsCartDiscountsDiscount","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/cart","property":"cart","description":null,"json":"{\n \"cart\": {\n \"id\": \"cart_01F0YES82DA12W88KQ90EY6W4C\",\n \"email\": null,\n \"billing_address_id\": null,\n \"billing_address\": null,\n \"shipping_address_id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"shipping_address\": {\n \"id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": null,\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": \"us\",\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.766Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"items\": [],\n \"region_id\": \"region\",\n \"region\": {\n \"id\": \"region\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"countries\": [\n {\n \"id\": 236,\n \"iso_2\": \"us\",\n \"iso_3\": \"usa\",\n \"num_code\": 840,\n \"name\": \"UNITED STATES\",\n \"display_name\": \"United States\",\n \"region_id\": \"region\"\n }\n ],\n \"payment_providers\": [],\n \"fulfillment_providers\": [],\n \"created_at\": \"2021-03-16T21:24:03.743Z\",\n \"updated_at\": \"2021-03-16T21:24:03.743Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"discounts\": [],\n \"gift_cards\": [],\n \"customer_id\": null,\n \"payment_sessions\": [],\n \"payment_id\": null,\n \"payment\": null,\n \"shipping_methods\": [],\n \"type\": \"default\",\n \"completed_at\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.857Z\",\n \"deleted_at\": null,\n \"metadata\": null,\n \"idempotency_key\": null,\n \"context\": {\n \"ip\": \"::ffff:127.0.0.1\",\n \"user_agent\": \"axios/0.21.1\"\n },\n \"shipping_total\": 0,\n \"discount_total\": 0,\n \"tax_total\": 0,\n \"gift_card_total\": 0,\n \"subtotal\": 0,\n \"total\": 0\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"The id of the Cart.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"The unique Discount code.","in":"path","name":"code","required":true,"schema":{"type":"string"}}]}]},{"name":"/carts/{id}/line-items/{line_id}","methods":[{"tags":["Cart"],"summary":"Delete a Line Item","description":"Removes a Line Item from a Cart.","method":"delete","operationId":"DeleteCartsCartLineItemsItem","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/cart","property":"cart","description":null,"json":"{\n \"cart\": {\n \"id\": \"cart_01F0YES82DA12W88KQ90EY6W4C\",\n \"email\": null,\n \"billing_address_id\": null,\n \"billing_address\": null,\n \"shipping_address_id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"shipping_address\": {\n \"id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": null,\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": \"us\",\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.766Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"items\": [],\n \"region_id\": \"region\",\n \"region\": {\n \"id\": \"region\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"countries\": [\n {\n \"id\": 236,\n \"iso_2\": \"us\",\n \"iso_3\": \"usa\",\n \"num_code\": 840,\n \"name\": \"UNITED STATES\",\n \"display_name\": \"United States\",\n \"region_id\": \"region\"\n }\n ],\n \"payment_providers\": [],\n \"fulfillment_providers\": [],\n \"created_at\": \"2021-03-16T21:24:03.743Z\",\n \"updated_at\": \"2021-03-16T21:24:03.743Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"discounts\": [],\n \"gift_cards\": [],\n \"customer_id\": null,\n \"payment_sessions\": [],\n \"payment_id\": null,\n \"payment\": null,\n \"shipping_methods\": [],\n \"type\": \"default\",\n \"completed_at\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.857Z\",\n \"deleted_at\": null,\n \"metadata\": null,\n \"idempotency_key\": null,\n \"context\": {\n \"ip\": \"::ffff:127.0.0.1\",\n \"user_agent\": \"axios/0.21.1\"\n },\n \"shipping_total\": 0,\n \"discount_total\": 0,\n \"tax_total\": 0,\n \"gift_card_total\": 0,\n \"subtotal\": 0,\n \"total\": 0\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"The id of the Cart.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"The id of the Line Item.","in":"path","name":"line_id","required":true,"schema":{"type":"string"}}]},{"tags":["Cart"],"summary":"Update a Line Item","description":"Updates a Line Item if the desired quantity can be fulfilled.","method":"post","operationId":"PostCartsCartLineItemsItem","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/cart","property":"cart","description":null,"json":"{\n \"cart\": {\n \"id\": \"cart_01F0YES82DA12W88KQ90EY6W4C\",\n \"email\": null,\n \"billing_address_id\": null,\n \"billing_address\": null,\n \"shipping_address_id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"shipping_address\": {\n \"id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": null,\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": \"us\",\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.766Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"items\": [],\n \"region_id\": \"region\",\n \"region\": {\n \"id\": \"region\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"countries\": [\n {\n \"id\": 236,\n \"iso_2\": \"us\",\n \"iso_3\": \"usa\",\n \"num_code\": 840,\n \"name\": \"UNITED STATES\",\n \"display_name\": \"United States\",\n \"region_id\": \"region\"\n }\n ],\n \"payment_providers\": [],\n \"fulfillment_providers\": [],\n \"created_at\": \"2021-03-16T21:24:03.743Z\",\n \"updated_at\": \"2021-03-16T21:24:03.743Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"discounts\": [],\n \"gift_cards\": [],\n \"customer_id\": null,\n \"payment_sessions\": [],\n \"payment_id\": null,\n \"payment\": null,\n \"shipping_methods\": [],\n \"type\": \"default\",\n \"completed_at\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.857Z\",\n \"deleted_at\": null,\n \"metadata\": null,\n \"idempotency_key\": null,\n \"context\": {\n \"ip\": \"::ffff:127.0.0.1\",\n \"user_agent\": \"axios/0.21.1\"\n },\n \"shipping_total\": 0,\n \"discount_total\": 0,\n \"tax_total\": 0,\n \"gift_card_total\": 0,\n \"subtotal\": 0,\n \"total\": 0\n }\n}","items":null}]}],"requestBody":{"type":"object","required":["quantity"],"properties":[{"description":"The quantity to set the Line Item to.","property":"quantity","type":"integer","nestedModel":null}]},"parameters":[{"description":"The id of the Cart.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"The id of the Line Item.","in":"path","name":"line_id","required":true,"schema":{"type":"string"}}]}]},{"name":"/carts/{id}/payment-sessions/{provider_id}","methods":[{"tags":["Cart"],"summary":"Delete a Payment Session","description":"Deletes a Payment Session on a Cart. May be useful if a payment has failed.","method":"delete","operationId":"DeleteCartsCartPaymentSessionsSession","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/cart","property":"cart","description":null,"json":"{\n \"cart\": {\n \"id\": \"cart_01F0YES82DA12W88KQ90EY6W4C\",\n \"email\": null,\n \"billing_address_id\": null,\n \"billing_address\": null,\n \"shipping_address_id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"shipping_address\": {\n \"id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": null,\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": \"us\",\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.766Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"items\": [],\n \"region_id\": \"region\",\n \"region\": {\n \"id\": \"region\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"countries\": [\n {\n \"id\": 236,\n \"iso_2\": \"us\",\n \"iso_3\": \"usa\",\n \"num_code\": 840,\n \"name\": \"UNITED STATES\",\n \"display_name\": \"United States\",\n \"region_id\": \"region\"\n }\n ],\n \"payment_providers\": [],\n \"fulfillment_providers\": [],\n \"created_at\": \"2021-03-16T21:24:03.743Z\",\n \"updated_at\": \"2021-03-16T21:24:03.743Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"discounts\": [],\n \"gift_cards\": [],\n \"customer_id\": null,\n \"payment_sessions\": [],\n \"payment_id\": null,\n \"payment\": null,\n \"shipping_methods\": [],\n \"type\": \"default\",\n \"completed_at\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.857Z\",\n \"deleted_at\": null,\n \"metadata\": null,\n \"idempotency_key\": null,\n \"context\": {\n \"ip\": \"::ffff:127.0.0.1\",\n \"user_agent\": \"axios/0.21.1\"\n },\n \"shipping_total\": 0,\n \"discount_total\": 0,\n \"tax_total\": 0,\n \"gift_card_total\": 0,\n \"subtotal\": 0,\n \"total\": 0\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"The id of the Cart.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"The id of the Payment Provider used to create the Payment Session to be deleted.","in":"path","name":"provider_id","required":true,"schema":{"type":"string"}}]},{"tags":["Cart"],"summary":"Update a Payment Session","description":"Updates a Payment Session with additional data.","method":"post","operationId":"PostCartsCartPaymentSessionUpdate","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/cart","property":"cart","description":null,"json":"{\n \"cart\": {\n \"id\": \"cart_01F0YES82DA12W88KQ90EY6W4C\",\n \"email\": null,\n \"billing_address_id\": null,\n \"billing_address\": null,\n \"shipping_address_id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"shipping_address\": {\n \"id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": null,\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": \"us\",\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.766Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"items\": [],\n \"region_id\": \"region\",\n \"region\": {\n \"id\": \"region\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"countries\": [\n {\n \"id\": 236,\n \"iso_2\": \"us\",\n \"iso_3\": \"usa\",\n \"num_code\": 840,\n \"name\": \"UNITED STATES\",\n \"display_name\": \"United States\",\n \"region_id\": \"region\"\n }\n ],\n \"payment_providers\": [],\n \"fulfillment_providers\": [],\n \"created_at\": \"2021-03-16T21:24:03.743Z\",\n \"updated_at\": \"2021-03-16T21:24:03.743Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"discounts\": [],\n \"gift_cards\": [],\n \"customer_id\": null,\n \"payment_sessions\": [],\n \"payment_id\": null,\n \"payment\": null,\n \"shipping_methods\": [],\n \"type\": \"default\",\n \"completed_at\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.857Z\",\n \"deleted_at\": null,\n \"metadata\": null,\n \"idempotency_key\": null,\n \"context\": {\n \"ip\": \"::ffff:127.0.0.1\",\n \"user_agent\": \"axios/0.21.1\"\n },\n \"shipping_total\": 0,\n \"discount_total\": 0,\n \"tax_total\": 0,\n \"gift_card_total\": 0,\n \"subtotal\": 0,\n \"total\": 0\n }\n}","items":null}]}],"requestBody":{"type":"object","required":["data"],"properties":[{"description":"The data to update the payment session with.","property":"data","type":"object","nestedModel":null}]},"parameters":[{"description":"The id of the Cart.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"The id of the payment provider.","in":"path","name":"provider_id","required":true,"schema":{"type":"string"}}]}]},{"name":"/carts/{id}","methods":[{"tags":["Cart"],"summary":"Retrieve a Cart","description":"Retrieves a Cart.","method":"get","operationId":"GetCartsCart","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/cart","property":"cart","description":null,"json":"{\n \"cart\": {\n \"id\": \"cart_01F0YES82DA12W88KQ90EY6W4C\",\n \"email\": null,\n \"billing_address_id\": null,\n \"billing_address\": null,\n \"shipping_address_id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"shipping_address\": {\n \"id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": null,\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": \"us\",\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.766Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"items\": [],\n \"region_id\": \"region\",\n \"region\": {\n \"id\": \"region\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"countries\": [\n {\n \"id\": 236,\n \"iso_2\": \"us\",\n \"iso_3\": \"usa\",\n \"num_code\": 840,\n \"name\": \"UNITED STATES\",\n \"display_name\": \"United States\",\n \"region_id\": \"region\"\n }\n ],\n \"payment_providers\": [],\n \"fulfillment_providers\": [],\n \"created_at\": \"2021-03-16T21:24:03.743Z\",\n \"updated_at\": \"2021-03-16T21:24:03.743Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"discounts\": [],\n \"gift_cards\": [],\n \"customer_id\": null,\n \"payment_sessions\": [],\n \"payment_id\": null,\n \"payment\": null,\n \"shipping_methods\": [],\n \"type\": \"default\",\n \"completed_at\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.857Z\",\n \"deleted_at\": null,\n \"metadata\": null,\n \"idempotency_key\": null,\n \"context\": {\n \"ip\": \"::ffff:127.0.0.1\",\n \"user_agent\": \"axios/0.21.1\"\n },\n \"shipping_total\": 0,\n \"discount_total\": 0,\n \"tax_total\": 0,\n \"gift_card_total\": 0,\n \"subtotal\": 0,\n \"total\": 0\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"The id of the Cart.","in":"path","name":"id","required":true,"schema":{"type":"string"}}]}]},{"name":"/carts/{id}/payment-sessions/{provider_id}/refresh","methods":[{"tags":["Cart"],"summary":"Refresh a Payment Session","description":"Refreshes a Payment Session to ensure that it is in sync with the Cart - this is usually not necessary.","method":"post","operationId":"PostCartsCartPaymentSessionsSession","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/cart","property":"cart","description":null,"json":"{\n \"cart\": {\n \"id\": \"cart_01F0YES82DA12W88KQ90EY6W4C\",\n \"email\": null,\n \"billing_address_id\": null,\n \"billing_address\": null,\n \"shipping_address_id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"shipping_address\": {\n \"id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": null,\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": \"us\",\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.766Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"items\": [],\n \"region_id\": \"region\",\n \"region\": {\n \"id\": \"region\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"countries\": [\n {\n \"id\": 236,\n \"iso_2\": \"us\",\n \"iso_3\": \"usa\",\n \"num_code\": 840,\n \"name\": \"UNITED STATES\",\n \"display_name\": \"United States\",\n \"region_id\": \"region\"\n }\n ],\n \"payment_providers\": [],\n \"fulfillment_providers\": [],\n \"created_at\": \"2021-03-16T21:24:03.743Z\",\n \"updated_at\": \"2021-03-16T21:24:03.743Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"discounts\": [],\n \"gift_cards\": [],\n \"customer_id\": null,\n \"payment_sessions\": [],\n \"payment_id\": null,\n \"payment\": null,\n \"shipping_methods\": [],\n \"type\": \"default\",\n \"completed_at\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.857Z\",\n \"deleted_at\": null,\n \"metadata\": null,\n \"idempotency_key\": null,\n \"context\": {\n \"ip\": \"::ffff:127.0.0.1\",\n \"user_agent\": \"axios/0.21.1\"\n },\n \"shipping_total\": 0,\n \"discount_total\": 0,\n \"tax_total\": 0,\n \"gift_card_total\": 0,\n \"subtotal\": 0,\n \"total\": 0\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"The id of the Cart.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"The id of the Payment Provider that created the Payment Session to be refreshed.","in":"path","name":"provider_id","required":true,"schema":{"type":"string"}}]}]},{"name":"/carts/{id}/payment-session","methods":[{"tags":["Cart"],"summary":"Select a Payment Session","description":"Selects a Payment Session as the session intended to be used towards the completion of the Cart.","method":"post","operationId":"PostCartsCartPaymentSession","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/cart","property":"cart","description":null,"json":"{\n \"cart\": {\n \"id\": \"cart_01F0YES82DA12W88KQ90EY6W4C\",\n \"email\": null,\n \"billing_address_id\": null,\n \"billing_address\": null,\n \"shipping_address_id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"shipping_address\": {\n \"id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": null,\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": \"us\",\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.766Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"items\": [],\n \"region_id\": \"region\",\n \"region\": {\n \"id\": \"region\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"countries\": [\n {\n \"id\": 236,\n \"iso_2\": \"us\",\n \"iso_3\": \"usa\",\n \"num_code\": 840,\n \"name\": \"UNITED STATES\",\n \"display_name\": \"United States\",\n \"region_id\": \"region\"\n }\n ],\n \"payment_providers\": [],\n \"fulfillment_providers\": [],\n \"created_at\": \"2021-03-16T21:24:03.743Z\",\n \"updated_at\": \"2021-03-16T21:24:03.743Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"discounts\": [],\n \"gift_cards\": [],\n \"customer_id\": null,\n \"payment_sessions\": [],\n \"payment_id\": null,\n \"payment\": null,\n \"shipping_methods\": [],\n \"type\": \"default\",\n \"completed_at\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.857Z\",\n \"deleted_at\": null,\n \"metadata\": null,\n \"idempotency_key\": null,\n \"context\": {\n \"ip\": \"::ffff:127.0.0.1\",\n \"user_agent\": \"axios/0.21.1\"\n },\n \"shipping_total\": 0,\n \"discount_total\": 0,\n \"tax_total\": 0,\n \"gift_card_total\": 0,\n \"subtotal\": 0,\n \"total\": 0\n }\n}","items":null}]}],"requestBody":{"type":"object","required":["provider_id"],"properties":[{"description":"The id of the Payment Provider.","property":"provider_id","type":"string","nestedModel":null}]},"parameters":[{"description":"The id of the Cart.","in":"path","name":"id","required":true,"schema":{"type":"string"}}]}]},{"name":"/store/carts/{id}","methods":[{"tags":["Cart"],"summary":"Update a Cart\"","description":"Updates a Cart.","method":"post","operationId":"PostCartsCartPaymentMethodUpdate","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/cart","property":"cart","description":null,"json":"{\n \"cart\": {\n \"id\": \"cart_01F0YES82DA12W88KQ90EY6W4C\",\n \"email\": null,\n \"billing_address_id\": null,\n \"billing_address\": null,\n \"shipping_address_id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"shipping_address\": {\n \"id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": null,\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": \"us\",\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.766Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"items\": [],\n \"region_id\": \"region\",\n \"region\": {\n \"id\": \"region\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"countries\": [\n {\n \"id\": 236,\n \"iso_2\": \"us\",\n \"iso_3\": \"usa\",\n \"num_code\": 840,\n \"name\": \"UNITED STATES\",\n \"display_name\": \"United States\",\n \"region_id\": \"region\"\n }\n ],\n \"payment_providers\": [],\n \"fulfillment_providers\": [],\n \"created_at\": \"2021-03-16T21:24:03.743Z\",\n \"updated_at\": \"2021-03-16T21:24:03.743Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"discounts\": [],\n \"gift_cards\": [],\n \"customer_id\": null,\n \"payment_sessions\": [],\n \"payment_id\": null,\n \"payment\": null,\n \"shipping_methods\": [],\n \"type\": \"default\",\n \"completed_at\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.857Z\",\n \"deleted_at\": null,\n \"metadata\": null,\n \"idempotency_key\": null,\n \"context\": {\n \"ip\": \"::ffff:127.0.0.1\",\n \"user_agent\": \"axios/0.21.1\"\n },\n \"shipping_total\": 0,\n \"discount_total\": 0,\n \"tax_total\": 0,\n \"gift_card_total\": 0,\n \"subtotal\": 0,\n \"total\": 0\n }\n}","items":null}]}],"requestBody":{"type":null,"required":["provider_id"],"properties":[{"description":"The id of the Payment Provider.","property":"provider_id","type":"string","nestedModel":null},{"description":"","property":"data","type":"object","nestedModel":null}]},"parameters":[{"description":"The id of the Cart.","in":"path","name":"id","required":true,"schema":{"type":"string"}}]}]}],"schema":{"object":"{\n \"id\": \"cart_01F0YES82DA12W88KQ90EY6W4C\",\n \"email\": null,\n \"billing_address_id\": null,\n \"billing_address\": null,\n \"shipping_address_id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"shipping_address\": {\n \"id\": \"addr_01F0YES82D4Y16JKGF0NFSSS3P\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": null,\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": \"us\",\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.766Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"items\": [],\n \"region_id\": \"region\",\n \"region\": {\n \"id\": \"region\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"countries\": [\n {\n \"id\": 236,\n \"iso_2\": \"us\",\n \"iso_3\": \"usa\",\n \"num_code\": 840,\n \"name\": \"UNITED STATES\",\n \"display_name\": \"United States\",\n \"region_id\": \"region\"\n }\n ],\n \"payment_providers\": [],\n \"fulfillment_providers\": [],\n \"created_at\": \"2021-03-16T21:24:03.743Z\",\n \"updated_at\": \"2021-03-16T21:24:03.743Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"discounts\": [],\n \"gift_cards\": [],\n \"customer_id\": null,\n \"payment_sessions\": [],\n \"payment_id\": null,\n \"payment\": null,\n \"shipping_methods\": [],\n \"type\": \"default\",\n \"completed_at\": null,\n \"created_at\": \"2021-03-16T21:24:03.766Z\",\n \"updated_at\": \"2021-03-16T21:24:03.857Z\",\n \"deleted_at\": null,\n \"metadata\": null,\n \"idempotency_key\": null,\n \"context\": {\n \"ip\": \"::ffff:127.0.0.1\",\n \"user_agent\": \"axios/0.21.1\"\n },\n \"shipping_total\": 0,\n \"discount_total\": 0,\n \"tax_total\": 0,\n \"gift_card_total\": 0,\n \"subtotal\": 0,\n \"total\": 0\n}","description":"Represents a user cart","properties":[{"property":"id","type":"string","description":null,"format":null,"nestedModel":null},{"property":"email","type":"string","description":null,"format":null,"nestedModel":null},{"property":"billing_address_id","type":"string","description":null,"format":null,"nestedModel":null},{"property":"billing_address","type":null,"description":null,"format":null,"nestedModel":null},{"property":"shipping_address_id","type":"string","description":null,"format":null,"nestedModel":null},{"property":"shipping_address","type":null,"description":null,"format":null,"nestedModel":null},{"property":"items","type":"array","description":null,"format":null,"nestedModel":{"title":"Line Item","properties":[{"property":"id","type":"string"},{"property":"cart_id","type":"string"},{"property":"order_id","type":"string"},{"property":"swap_id","type":"string"},{"property":"claim_order_id","type":"string"},{"property":"title","type":"string"},{"property":"description","type":"string"},{"property":"thumbnail","type":"string"},{"property":"is_giftcard","type":"boolean"},{"property":"should_merge","type":"boolean"},{"property":"allow_discounts","type":"boolean"},{"property":"unit_price","type":"boolean"},{"property":"variant_id","type":"string"},{"property":"variant","type":null},{"property":"quantity","type":"integer"},{"property":"fulfilled_quantity","type":"integer"},{"property":"returned_quantity","type":"integer"},{"property":"shipped_quantity","type":"integer"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"metadata","type":"object"},{"property":"refundable","type":"integer"}]}},{"property":"region_id","type":"string","description":null,"format":null,"nestedModel":null},{"property":"region","type":null,"description":null,"format":null,"nestedModel":null},{"property":"discounts","type":"array","description":null,"format":null,"nestedModel":{"title":"Region","properties":[{"property":"id","type":"string"},{"property":"name","type":"string"},{"property":"currency_code","type":"string"},{"property":"tax_rate","type":"number"},{"property":"tax_code","type":"string"},{"property":"countries","type":"array"},{"property":"payment_providers","type":"array"},{"property":"fulfillment_providers","type":"array"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"deleted_at","type":"string"},{"property":"metadata","type":"object"}]}},{"property":"gift_cards","type":"array","description":null,"format":null,"nestedModel":{"title":"Gift Card","properties":[{"property":"id","type":"string"},{"property":"code","type":"string"},{"property":"value","type":"integer"},{"property":"balance","type":"integer"},{"property":"region_id","type":"string"},{"property":"region","type":null},{"property":"order_id","type":"string"},{"property":"is_disabled","type":"boolean"},{"property":"ends_at","type":"string"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"deleted_at","type":"string"},{"property":"metadata","type":"object"}]}},{"property":"customer_id","type":"string","description":null,"format":null,"nestedModel":null},{"property":"customer","type":null,"description":null,"format":null,"nestedModel":null},{"property":"payment_session","type":null,"description":null,"format":null,"nestedModel":null},{"property":"payment_sessions","type":"array","description":null,"format":null,"nestedModel":{"title":"Payment Session","properties":[{"property":"id","type":"string"},{"property":"cart_id","type":"string"},{"property":"provider_id","type":"string"},{"property":"is_selected","type":"boolean"},{"property":"status","type":"string"},{"property":"data","type":"object"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"}]}},{"property":"payment","type":null,"description":null,"format":null,"nestedModel":null},{"property":"shipping_methods","type":"array","description":null,"format":null,"nestedModel":{"title":"Shipping Method","properties":[{"property":"id","type":"string"},{"property":"shipping_option_id","type":"string"},{"property":"shipping_option","type":null},{"property":"order_id","type":"string"},{"property":"return_id","type":"string"},{"property":"swap_id","type":"string"},{"property":"cart_id","type":"string"},{"property":"claim_order_id","type":"string"},{"property":"price","type":"integer"},{"property":"data","type":"object"}]}},{"property":"type","type":"string","description":null,"format":null,"nestedModel":null},{"property":"completed_at","type":"string","description":null,"format":"date-time","nestedModel":null},{"property":"created_at","type":"string","description":null,"format":"date-time","nestedModel":null},{"property":"updated_at","type":"string","description":null,"format":"date-time","nestedModel":null},{"property":"deleted_at","type":"string","description":null,"format":"date-time","nestedModel":null},{"property":"metadata","type":"object","description":null,"format":null,"nestedModel":null},{"property":"shipping_total","type":"integer","description":null,"format":null,"nestedModel":null},{"property":"discount_total","type":"integer","description":null,"format":null,"nestedModel":null},{"property":"tax_total","type":"integer","description":null,"format":null,"nestedModel":null},{"property":"subtotal","type":"integer","description":null,"format":null,"nestedModel":null},{"property":"refundable_amount","type":"integer","description":null,"format":null,"nestedModel":null},{"property":"gift_card_total","type":"integer","description":null,"format":null,"nestedModel":null}]}}},{"section":{"section_name":"Order","paths":[{"name":"/orders/cart/{cart_id}","methods":[{"tags":["Order"],"summary":"Retrieves Order by Cart id","description":"Retrieves an Order by the id of the Cart that was used to create the Order.","method":"get","operationId":"GetOrdersOrderCartId","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/order","property":"order","description":null,"json":"{\n \"order\": {\n \"id\": \"order_01F0YET7CZ741ECWG1J3N34RXF\",\n \"status\": \"pending\",\n \"fulfillment_status\": \"not_fulfilled\",\n \"payment_status\": \"not_paid\",\n \"display_id\": 1,\n \"cart_id\": null,\n \"customer_id\": \"cus_01F0YET7C3H3D5M8QPNPP5CDAX\",\n \"customer\": {\n \"id\": \"cus_01F0YET7C3H3D5M8QPNPP5CDAX\",\n \"email\": \"test@email.com\",\n \"first_name\": null,\n \"last_name\": null,\n \"billing_address_id\": null,\n \"password_hash\": null,\n \"phone\": null,\n \"has_account\": false,\n \"created_at\": \"2021-03-16T21:24:35.843Z\",\n \"updated_at\": \"2021-03-16T21:24:35.843Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"email\": \"test@email.com\",\n \"billing_address\": {\n \"id\": \"addr_01F0YET7CZZX0842X5AHQYAZ80\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": \"lebron\",\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": null,\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"shipping_address\": {\n \"id\": \"addr_01F0YET7CZDHXHXYJ3JTXPH4T7\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": \"lebron\",\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": \"us\",\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"region_id\": \"reg_01F0YET7BZTARY9MKN1SJ7AAXF\",\n \"region\": {\n \"id\": \"reg_01F0YET7BZTARY9MKN1SJ7AAXF\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"payment_providers\": [],\n \"fulfillment_providers\": [],\n \"created_at\": \"2021-03-16T21:24:35.839Z\",\n \"updated_at\": \"2021-03-16T21:24:35.839Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"currency_code\": \"usd\",\n \"tax_rate\": 0,\n \"discounts\": [\n {\n \"id\": \"test-discount\",\n \"code\": \"TEST134\",\n \"is_dynamic\": false,\n \"rule_id\": \"dru_01F0YET7CZQDGWTFQYY8T4KYRZ\",\n \"rule\": {\n \"id\": \"dru_01F0YET7CZQDGWTFQYY8T4KYRZ\",\n \"description\": \"Test Discount\",\n \"type\": \"percentage\",\n \"value\": 10,\n \"allocation\": \"total\",\n \"usage_limit\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"is_disabled\": false,\n \"parent_discount_id\": null,\n \"starts_at\": \"2021-03-16T21:24:35.871Z\",\n \"ends_at\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ],\n \"gift_cards\": [],\n \"shipping_methods\": [\n {\n \"id\": \"sm_01F0YET7DR2E7CYVSDHM593QG2\",\n \"shipping_option_id\": \"so_01F0YET7C758MMXF1WNVCPGKZJ\",\n \"order_id\": \"order_01F0YET7CZ741ECWG1J3N34RXF\",\n \"claim_order_id\": null,\n \"cart_id\": null,\n \"swap_id\": null,\n \"return_id\": null,\n \"shipping_option\": {\n \"id\": \"so_01F0YET7C758MMXF1WNVCPGKZJ\",\n \"name\": \"test-option\",\n \"region_id\": \"reg_01F0YET7BZTARY9MKN1SJ7AAXF\",\n \"profile_id\": \"sp_01F0YET7AF62TCC9CMWK5TXXAQ\",\n \"provider_id\": \"test-ful\",\n \"price_type\": \"flat_rate\",\n \"amount\": 1000,\n \"is_return\": false,\n \"data\": {},\n \"created_at\": \"2021-03-16T21:24:35.846Z\",\n \"updated_at\": \"2021-03-16T21:24:35.846Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"price\": 1000,\n \"data\": {}\n }\n ],\n \"payments\": [\n {\n \"id\": \"test-payment\",\n \"swap_id\": null,\n \"cart_id\": null,\n \"order_id\": \"order_01F0YET7CZ741ECWG1J3N34RXF\",\n \"amount\": 10000,\n \"currency_code\": \"usd\",\n \"amount_refunded\": 0,\n \"provider_id\": \"test\",\n \"data\": {},\n \"captured_at\": null,\n \"canceled_at\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"metadata\": null,\n \"idempotency_key\": null\n }\n ],\n \"fulfillments\": [],\n \"returns\": [],\n \"claims\": [],\n \"refunds\": [],\n \"swaps\": [],\n \"items\": [\n {\n \"id\": \"test-item\",\n \"cart_id\": null,\n \"order_id\": \"order_01F0YET7CZ741ECWG1J3N34RXF\",\n \"swap_id\": null,\n \"claim_order_id\": null,\n \"title\": \"Line Item\",\n \"description\": \"Line Item Desc\",\n \"thumbnail\": \"https://test.js/1234\",\n \"is_giftcard\": false,\n \"should_merge\": true,\n \"allow_discounts\": true,\n \"has_shipping\": null,\n \"unit_price\": 8000,\n \"variant_id\": \"variant_01F0YET7BMD9FGWA5NTPBWT2SS\",\n \"variant\": {\n \"id\": \"variant_01F0YET7BMD9FGWA5NTPBWT2SS\",\n \"title\": \"test variant\",\n \"product_id\": \"prod_01F0YET7BA4AQ8WEK687BNWP3N\",\n \"product\": {\n \"id\": \"prod_01F0YET7BA4AQ8WEK687BNWP3N\",\n \"title\": \"test product\",\n \"subtitle\": null,\n \"description\": null,\n \"handle\": \"test-product\",\n \"is_giftcard\": false,\n \"thumbnail\": null,\n \"profile_id\": \"sp_01F0YET7AF62TCC9CMWK5TXXAQ\",\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"collection_id\": null,\n \"type_id\": null,\n \"created_at\": \"2021-03-16T21:24:35.818Z\",\n \"updated_at\": \"2021-03-16T21:24:35.818Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"sku\": null,\n \"barcode\": null,\n \"ean\": null,\n \"upc\": null,\n \"inventory_quantity\": 1,\n \"allow_backorder\": false,\n \"manage_inventory\": true,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"created_at\": \"2021-03-16T21:24:35.828Z\",\n \"updated_at\": \"2021-03-16T21:24:35.828Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"quantity\": 1,\n \"fulfilled_quantity\": 1,\n \"returned_quantity\": null,\n \"shipped_quantity\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"metadata\": null,\n \"refundable\": 7200\n }\n ],\n \"gift_card_transactions\": [],\n \"canceled_at\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"metadata\": null,\n \"shipping_total\": 1000,\n \"gift_card_total\": 0,\n \"discount_total\": 800,\n \"tax_total\": 0,\n \"subtotal\": 8000,\n \"total\": 8200,\n \"refunded_total\": 0,\n \"refundable_amount\": 8200\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"The id of Cart.","in":"path","name":"cart_id","required":true,"schema":{"type":"string"}}]}]},{"name":"/orders/{id}","methods":[{"tags":["Order"],"summary":"Retrieves an Order","description":"Retrieves an Order","method":"get","operationId":"GetOrdersOrder","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/customer","property":"customer","description":null,"json":"{\n \"customer\": {\n \"id\": \"cus_01F0YESQXFZ5WKMHTXJ4JDPBDZ\",\n \"email\": \"test1@email.com\",\n \"first_name\": null,\n \"last_name\": null,\n \"billing_address_id\": null,\n \"password_hash\": null,\n \"phone\": null,\n \"has_account\": false,\n \"orders\": [],\n \"created_at\": \"2021-03-16T21:24:20.015Z\",\n \"updated_at\": \"2021-03-16T21:24:20.015Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"The id of the Order.","in":"path","name":"id","required":true,"schema":{"type":"string"}}]}]},{"name":"/orders","methods":[{"tags":["Order"],"summary":"Look Up an Order","description":"Looks for an Order with a given `display_id`, `email` pair. The `display_id`, `email` pair must match in order for the Order to be returned.","method":"get","operationId":"GetOrders","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/order","property":"order","description":null,"json":"{\n \"order\": {\n \"id\": \"order_01F0YET7CZ741ECWG1J3N34RXF\",\n \"status\": \"pending\",\n \"fulfillment_status\": \"not_fulfilled\",\n \"payment_status\": \"not_paid\",\n \"display_id\": 1,\n \"cart_id\": null,\n \"customer_id\": \"cus_01F0YET7C3H3D5M8QPNPP5CDAX\",\n \"customer\": {\n \"id\": \"cus_01F0YET7C3H3D5M8QPNPP5CDAX\",\n \"email\": \"test@email.com\",\n \"first_name\": null,\n \"last_name\": null,\n \"billing_address_id\": null,\n \"password_hash\": null,\n \"phone\": null,\n \"has_account\": false,\n \"created_at\": \"2021-03-16T21:24:35.843Z\",\n \"updated_at\": \"2021-03-16T21:24:35.843Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"email\": \"test@email.com\",\n \"billing_address\": {\n \"id\": \"addr_01F0YET7CZZX0842X5AHQYAZ80\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": \"lebron\",\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": null,\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"shipping_address\": {\n \"id\": \"addr_01F0YET7CZDHXHXYJ3JTXPH4T7\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": \"lebron\",\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": \"us\",\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"region_id\": \"reg_01F0YET7BZTARY9MKN1SJ7AAXF\",\n \"region\": {\n \"id\": \"reg_01F0YET7BZTARY9MKN1SJ7AAXF\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"payment_providers\": [],\n \"fulfillment_providers\": [],\n \"created_at\": \"2021-03-16T21:24:35.839Z\",\n \"updated_at\": \"2021-03-16T21:24:35.839Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"currency_code\": \"usd\",\n \"tax_rate\": 0,\n \"discounts\": [\n {\n \"id\": \"test-discount\",\n \"code\": \"TEST134\",\n \"is_dynamic\": false,\n \"rule_id\": \"dru_01F0YET7CZQDGWTFQYY8T4KYRZ\",\n \"rule\": {\n \"id\": \"dru_01F0YET7CZQDGWTFQYY8T4KYRZ\",\n \"description\": \"Test Discount\",\n \"type\": \"percentage\",\n \"value\": 10,\n \"allocation\": \"total\",\n \"usage_limit\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"is_disabled\": false,\n \"parent_discount_id\": null,\n \"starts_at\": \"2021-03-16T21:24:35.871Z\",\n \"ends_at\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ],\n \"gift_cards\": [],\n \"shipping_methods\": [\n {\n \"id\": \"sm_01F0YET7DR2E7CYVSDHM593QG2\",\n \"shipping_option_id\": \"so_01F0YET7C758MMXF1WNVCPGKZJ\",\n \"order_id\": \"order_01F0YET7CZ741ECWG1J3N34RXF\",\n \"claim_order_id\": null,\n \"cart_id\": null,\n \"swap_id\": null,\n \"return_id\": null,\n \"shipping_option\": {\n \"id\": \"so_01F0YET7C758MMXF1WNVCPGKZJ\",\n \"name\": \"test-option\",\n \"region_id\": \"reg_01F0YET7BZTARY9MKN1SJ7AAXF\",\n \"profile_id\": \"sp_01F0YET7AF62TCC9CMWK5TXXAQ\",\n \"provider_id\": \"test-ful\",\n \"price_type\": \"flat_rate\",\n \"amount\": 1000,\n \"is_return\": false,\n \"data\": {},\n \"created_at\": \"2021-03-16T21:24:35.846Z\",\n \"updated_at\": \"2021-03-16T21:24:35.846Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"price\": 1000,\n \"data\": {}\n }\n ],\n \"payments\": [\n {\n \"id\": \"test-payment\",\n \"swap_id\": null,\n \"cart_id\": null,\n \"order_id\": \"order_01F0YET7CZ741ECWG1J3N34RXF\",\n \"amount\": 10000,\n \"currency_code\": \"usd\",\n \"amount_refunded\": 0,\n \"provider_id\": \"test\",\n \"data\": {},\n \"captured_at\": null,\n \"canceled_at\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"metadata\": null,\n \"idempotency_key\": null\n }\n ],\n \"fulfillments\": [],\n \"returns\": [],\n \"claims\": [],\n \"refunds\": [],\n \"swaps\": [],\n \"items\": [\n {\n \"id\": \"test-item\",\n \"cart_id\": null,\n \"order_id\": \"order_01F0YET7CZ741ECWG1J3N34RXF\",\n \"swap_id\": null,\n \"claim_order_id\": null,\n \"title\": \"Line Item\",\n \"description\": \"Line Item Desc\",\n \"thumbnail\": \"https://test.js/1234\",\n \"is_giftcard\": false,\n \"should_merge\": true,\n \"allow_discounts\": true,\n \"has_shipping\": null,\n \"unit_price\": 8000,\n \"variant_id\": \"variant_01F0YET7BMD9FGWA5NTPBWT2SS\",\n \"variant\": {\n \"id\": \"variant_01F0YET7BMD9FGWA5NTPBWT2SS\",\n \"title\": \"test variant\",\n \"product_id\": \"prod_01F0YET7BA4AQ8WEK687BNWP3N\",\n \"product\": {\n \"id\": \"prod_01F0YET7BA4AQ8WEK687BNWP3N\",\n \"title\": \"test product\",\n \"subtitle\": null,\n \"description\": null,\n \"handle\": \"test-product\",\n \"is_giftcard\": false,\n \"thumbnail\": null,\n \"profile_id\": \"sp_01F0YET7AF62TCC9CMWK5TXXAQ\",\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"collection_id\": null,\n \"type_id\": null,\n \"created_at\": \"2021-03-16T21:24:35.818Z\",\n \"updated_at\": \"2021-03-16T21:24:35.818Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"sku\": null,\n \"barcode\": null,\n \"ean\": null,\n \"upc\": null,\n \"inventory_quantity\": 1,\n \"allow_backorder\": false,\n \"manage_inventory\": true,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"created_at\": \"2021-03-16T21:24:35.828Z\",\n \"updated_at\": \"2021-03-16T21:24:35.828Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"quantity\": 1,\n \"fulfilled_quantity\": 1,\n \"returned_quantity\": null,\n \"shipped_quantity\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"metadata\": null,\n \"refundable\": 7200\n }\n ],\n \"gift_card_transactions\": [],\n \"canceled_at\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"metadata\": null,\n \"shipping_total\": 1000,\n \"gift_card_total\": 0,\n \"discount_total\": 800,\n \"tax_total\": 0,\n \"subtotal\": 8000,\n \"total\": 8200,\n \"refunded_total\": 0,\n \"refundable_amount\": 8200\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"The display id given to the Order.","in":"query","name":"display_id","required":true,"schema":{"type":"number"}},{"description":"The email of the Order with the given display_id.","in":"query","name":"email","required":true,"schema":{"type":"string"}}]}]}],"schema":{"object":"{\n \"id\": \"order_01F0YET7CZ741ECWG1J3N34RXF\",\n \"status\": \"pending\",\n \"fulfillment_status\": \"not_fulfilled\",\n \"payment_status\": \"not_paid\",\n \"display_id\": 1,\n \"cart_id\": null,\n \"customer_id\": \"cus_01F0YET7C3H3D5M8QPNPP5CDAX\",\n \"customer\": {\n \"id\": \"cus_01F0YET7C3H3D5M8QPNPP5CDAX\",\n \"email\": \"test@email.com\",\n \"first_name\": null,\n \"last_name\": null,\n \"billing_address_id\": null,\n \"password_hash\": null,\n \"phone\": null,\n \"has_account\": false,\n \"created_at\": \"2021-03-16T21:24:35.843Z\",\n \"updated_at\": \"2021-03-16T21:24:35.843Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"email\": \"test@email.com\",\n \"billing_address\": {\n \"id\": \"addr_01F0YET7CZZX0842X5AHQYAZ80\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": \"lebron\",\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": null,\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"shipping_address\": {\n \"id\": \"addr_01F0YET7CZDHXHXYJ3JTXPH4T7\",\n \"customer_id\": null,\n \"company\": null,\n \"first_name\": \"lebron\",\n \"last_name\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"city\": null,\n \"country_code\": \"us\",\n \"province\": null,\n \"postal_code\": null,\n \"phone\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"region_id\": \"reg_01F0YET7BZTARY9MKN1SJ7AAXF\",\n \"region\": {\n \"id\": \"reg_01F0YET7BZTARY9MKN1SJ7AAXF\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"payment_providers\": [],\n \"fulfillment_providers\": [],\n \"created_at\": \"2021-03-16T21:24:35.839Z\",\n \"updated_at\": \"2021-03-16T21:24:35.839Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"currency_code\": \"usd\",\n \"tax_rate\": 0,\n \"discounts\": [\n {\n \"id\": \"test-discount\",\n \"code\": \"TEST134\",\n \"is_dynamic\": false,\n \"rule_id\": \"dru_01F0YET7CZQDGWTFQYY8T4KYRZ\",\n \"rule\": {\n \"id\": \"dru_01F0YET7CZQDGWTFQYY8T4KYRZ\",\n \"description\": \"Test Discount\",\n \"type\": \"percentage\",\n \"value\": 10,\n \"allocation\": \"total\",\n \"usage_limit\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"is_disabled\": false,\n \"parent_discount_id\": null,\n \"starts_at\": \"2021-03-16T21:24:35.871Z\",\n \"ends_at\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ],\n \"gift_cards\": [],\n \"shipping_methods\": [\n {\n \"id\": \"sm_01F0YET7DR2E7CYVSDHM593QG2\",\n \"shipping_option_id\": \"so_01F0YET7C758MMXF1WNVCPGKZJ\",\n \"order_id\": \"order_01F0YET7CZ741ECWG1J3N34RXF\",\n \"claim_order_id\": null,\n \"cart_id\": null,\n \"swap_id\": null,\n \"return_id\": null,\n \"shipping_option\": {\n \"id\": \"so_01F0YET7C758MMXF1WNVCPGKZJ\",\n \"name\": \"test-option\",\n \"region_id\": \"reg_01F0YET7BZTARY9MKN1SJ7AAXF\",\n \"profile_id\": \"sp_01F0YET7AF62TCC9CMWK5TXXAQ\",\n \"provider_id\": \"test-ful\",\n \"price_type\": \"flat_rate\",\n \"amount\": 1000,\n \"is_return\": false,\n \"data\": {},\n \"created_at\": \"2021-03-16T21:24:35.846Z\",\n \"updated_at\": \"2021-03-16T21:24:35.846Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"price\": 1000,\n \"data\": {}\n }\n ],\n \"payments\": [\n {\n \"id\": \"test-payment\",\n \"swap_id\": null,\n \"cart_id\": null,\n \"order_id\": \"order_01F0YET7CZ741ECWG1J3N34RXF\",\n \"amount\": 10000,\n \"currency_code\": \"usd\",\n \"amount_refunded\": 0,\n \"provider_id\": \"test\",\n \"data\": {},\n \"captured_at\": null,\n \"canceled_at\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"metadata\": null,\n \"idempotency_key\": null\n }\n ],\n \"fulfillments\": [],\n \"returns\": [],\n \"claims\": [],\n \"refunds\": [],\n \"swaps\": [],\n \"items\": [\n {\n \"id\": \"test-item\",\n \"cart_id\": null,\n \"order_id\": \"order_01F0YET7CZ741ECWG1J3N34RXF\",\n \"swap_id\": null,\n \"claim_order_id\": null,\n \"title\": \"Line Item\",\n \"description\": \"Line Item Desc\",\n \"thumbnail\": \"https://test.js/1234\",\n \"is_giftcard\": false,\n \"should_merge\": true,\n \"allow_discounts\": true,\n \"has_shipping\": null,\n \"unit_price\": 8000,\n \"variant_id\": \"variant_01F0YET7BMD9FGWA5NTPBWT2SS\",\n \"variant\": {\n \"id\": \"variant_01F0YET7BMD9FGWA5NTPBWT2SS\",\n \"title\": \"test variant\",\n \"product_id\": \"prod_01F0YET7BA4AQ8WEK687BNWP3N\",\n \"product\": {\n \"id\": \"prod_01F0YET7BA4AQ8WEK687BNWP3N\",\n \"title\": \"test product\",\n \"subtitle\": null,\n \"description\": null,\n \"handle\": \"test-product\",\n \"is_giftcard\": false,\n \"thumbnail\": null,\n \"profile_id\": \"sp_01F0YET7AF62TCC9CMWK5TXXAQ\",\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"collection_id\": null,\n \"type_id\": null,\n \"created_at\": \"2021-03-16T21:24:35.818Z\",\n \"updated_at\": \"2021-03-16T21:24:35.818Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"sku\": null,\n \"barcode\": null,\n \"ean\": null,\n \"upc\": null,\n \"inventory_quantity\": 1,\n \"allow_backorder\": false,\n \"manage_inventory\": true,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"created_at\": \"2021-03-16T21:24:35.828Z\",\n \"updated_at\": \"2021-03-16T21:24:35.828Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"quantity\": 1,\n \"fulfilled_quantity\": 1,\n \"returned_quantity\": null,\n \"shipped_quantity\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"metadata\": null,\n \"refundable\": 7200\n }\n ],\n \"gift_card_transactions\": [],\n \"canceled_at\": null,\n \"created_at\": \"2021-03-16T21:24:35.871Z\",\n \"updated_at\": \"2021-03-16T21:24:35.871Z\",\n \"metadata\": null,\n \"shipping_total\": 1000,\n \"gift_card_total\": 0,\n \"discount_total\": 800,\n \"tax_total\": 0,\n \"subtotal\": 8000,\n \"total\": 8200,\n \"refunded_total\": 0,\n \"refundable_amount\": 8200\n}","description":"Represents an order","properties":[{"property":"id","type":"string","description":null,"format":null,"nestedModel":null},{"property":"status","type":"string","description":null,"format":null,"nestedModel":null},{"property":"fulfillment_status","type":"string","description":null,"format":null,"nestedModel":null},{"property":"payment_status","type":"string","description":null,"format":null,"nestedModel":null},{"property":"display_id","type":"integer","description":null,"format":null,"nestedModel":null},{"property":"cart_id","type":"string","description":null,"format":null,"nestedModel":null},{"property":"currency_code","type":"string","description":null,"format":null,"nestedModel":null},{"property":"tax_rate","type":"number","description":null,"format":null,"nestedModel":null},{"property":"discounts","type":"array","description":null,"format":null,"nestedModel":{"title":"Discount","properties":[{"property":"id","type":"string"},{"property":"code","type":"string"},{"property":"is_dynamic","type":"boolean"},{"property":"rule","type":null},{"property":"is_disabled","type":"boolean"},{"property":"parent_discount_id","type":"string"},{"property":"starts_at","type":"string"},{"property":"ends_at","type":"string"},{"property":"regions","type":"array"},{"property":"usage_limit","type":"integer"},{"property":"usage_count","type":"integer"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"deleted_at","type":"string"},{"property":"metadata","type":"object"}]}},{"property":"email","type":"string","description":null,"format":null,"nestedModel":null},{"property":"billing_address_id","type":"string","description":null,"format":null,"nestedModel":null},{"property":"billing_address","type":null,"description":null,"format":null,"nestedModel":{"title":"Address","properties":[{"property":"id","type":"string"},{"property":"customer_id","type":"string"},{"property":"company","type":"string"},{"property":"first_name","type":"string"},{"property":"last_name","type":"string"},{"property":"address_1","type":"string"},{"property":"address_2","type":"string"},{"property":"city","type":"string"},{"property":"country_code","type":"string"},{"property":"country","type":null}]}},{"property":"shipping_address_id","type":"string","description":null,"format":null,"nestedModel":null},{"property":"shipping_address","type":null,"description":null,"format":null,"nestedModel":{"title":"Address","properties":[{"property":"id","type":"string"},{"property":"customer_id","type":"string"},{"property":"company","type":"string"},{"property":"first_name","type":"string"},{"property":"last_name","type":"string"},{"property":"address_1","type":"string"},{"property":"address_2","type":"string"},{"property":"city","type":"string"},{"property":"country_code","type":"string"},{"property":"country","type":null}]}},{"property":"items","type":"array","description":null,"format":null,"nestedModel":{"title":"Line Item","properties":[{"property":"id","type":"string"},{"property":"cart_id","type":"string"},{"property":"order_id","type":"string"},{"property":"swap_id","type":"string"},{"property":"claim_order_id","type":"string"},{"property":"title","type":"string"},{"property":"description","type":"string"},{"property":"thumbnail","type":"string"},{"property":"is_giftcard","type":"boolean"},{"property":"should_merge","type":"boolean"},{"property":"allow_discounts","type":"boolean"},{"property":"unit_price","type":"boolean"},{"property":"variant_id","type":"string"},{"property":"variant","type":null},{"property":"quantity","type":"integer"},{"property":"fulfilled_quantity","type":"integer"},{"property":"returned_quantity","type":"integer"},{"property":"shipped_quantity","type":"integer"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"metadata","type":"object"},{"property":"refundable","type":"integer"}]}},{"property":"region_id","type":"string","description":null,"format":null,"nestedModel":null},{"property":"region","type":null,"description":null,"format":null,"nestedModel":{"title":"Region","properties":[{"property":"id","type":"string"},{"property":"name","type":"string"},{"property":"currency_code","type":"string"},{"property":"tax_rate","type":"number"},{"property":"tax_code","type":"string"},{"property":"countries","type":"array"},{"property":"payment_providers","type":"array"},{"property":"fulfillment_providers","type":"array"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"deleted_at","type":"string"},{"property":"metadata","type":"object"}]}},{"property":"gift_cards","type":"array","description":null,"format":null,"nestedModel":{"title":"Gift Card","properties":[{"property":"id","type":"string"},{"property":"code","type":"string"},{"property":"value","type":"integer"},{"property":"balance","type":"integer"},{"property":"region_id","type":"string"},{"property":"region","type":null},{"property":"order_id","type":"string"},{"property":"is_disabled","type":"boolean"},{"property":"ends_at","type":"string"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"deleted_at","type":"string"},{"property":"metadata","type":"object"}]}},{"property":"customer_id","type":"string","description":null,"format":null,"nestedModel":null},{"property":"customer","type":null,"description":null,"format":null,"nestedModel":{"title":"Customer","properties":[{"property":"id","type":"string"},{"property":"email","type":"string"},{"property":"billing_address_id","type":"string"},{"property":"billing_address","type":null},{"property":"shipping_addresses","type":"array"},{"property":"first_name","type":"string"},{"property":"last_name","type":"string"},{"property":"phone","type":"string"},{"property":"has_account","type":"boolean"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"deleted_at","type":"string"},{"property":"metadata","type":"object"}]}},{"property":"payment_session","type":null,"description":null,"format":null,"nestedModel":{"title":"Payment Session","properties":[{"property":"id","type":"string"},{"property":"cart_id","type":"string"},{"property":"provider_id","type":"string"},{"property":"is_selected","type":"boolean"},{"property":"status","type":"string"},{"property":"data","type":"object"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"}]}},{"property":"payment_sessions","type":"array","description":null,"format":null,"nestedModel":{"title":"Payment Session","properties":[{"property":"id","type":"string"},{"property":"cart_id","type":"string"},{"property":"provider_id","type":"string"},{"property":"is_selected","type":"boolean"},{"property":"status","type":"string"},{"property":"data","type":"object"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"}]}},{"property":"payments","type":"array","description":null,"format":null,"nestedModel":{"title":"Payment","properties":[{"property":"id","type":"string"},{"property":"swap_id","type":"string"},{"property":"order_id","type":"string"},{"property":"cart_id","type":"string"},{"property":"amount","type":"integer"},{"property":"currency_code","type":"string"},{"property":"amount_refunded","type":"integer"},{"property":"provider_id","type":"string"},{"property":"data","type":"object"},{"property":"captured_at","type":"string"},{"property":"canceled_at","type":"string"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"metadata","type":"object"}]}},{"property":"shipping_methods","type":"array","description":null,"format":null,"nestedModel":{"title":"Shipping Method","properties":[{"property":"id","type":"string"},{"property":"shipping_option_id","type":"string"},{"property":"shipping_option","type":null},{"property":"order_id","type":"string"},{"property":"return_id","type":"string"},{"property":"swap_id","type":"string"},{"property":"cart_id","type":"string"},{"property":"claim_order_id","type":"string"},{"property":"price","type":"integer"},{"property":"data","type":"object"}]}},{"property":"fulfillments","type":"array","description":null,"format":null,"nestedModel":{"title":"Fulfillment","properties":[{"property":"id","type":"string"},{"property":"claim_order_id","type":"string"},{"property":"swap_id","type":"string"},{"property":"order_id","type":"string"},{"property":"provider_id","type":"string"},{"property":"items","type":"array"},{"property":"tracking_links","type":"array"},{"property":"tracking_numbers","type":"array"},{"property":"shipped_at","type":"string"},{"property":"no_notification","type":"boolean"},{"property":"canceled_at","type":"string"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"metadata","type":"object"}]}},{"property":"returns","type":"array","description":null,"format":null,"nestedModel":{"title":"Return","properties":[{"property":"id","type":"string"},{"property":"status","type":"string"},{"property":"items","type":null},{"property":"swap_id","type":"string"},{"property":"order_id","type":"string"},{"property":"claim_order_id","type":"string"},{"property":"shipping_method","type":null},{"property":"shipping_data","type":"object"},{"property":"refund_amount","type":"integer"},{"property":"received_at","type":"string"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"no_notification","type":"boolean"},{"property":"metadata","type":"object"}]}},{"property":"claims","type":"array","description":null,"format":null,"nestedModel":{"title":"Claim Order","properties":[{"property":"id","type":"string"},{"property":"type","type":"string"},{"property":"payment_status","type":"string"},{"property":"fulfillment_status","type":"string"},{"property":"claim_items","type":"array"},{"property":"additional_items","type":"array"},{"property":"order_id","type":"string"},{"property":"return_order","type":null},{"property":"shipping_address_id","type":"string"},{"property":"shipping_address","type":null},{"property":"shipping_methods","type":"array"},{"property":"fulfillments","type":"array"},{"property":"refund_amount","type":"integer"},{"property":"canceled_at","type":"string"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"deleted_at","type":"string"},{"property":"no_notification","type":"boolean"},{"property":"metadata","type":"object"}]}},{"property":"refunds","type":"array","description":null,"format":null,"nestedModel":{"title":"Refund","properties":[{"property":"id","type":"string"},{"property":"order_id","type":"string"},{"property":"amount","type":"integer"},{"property":"note","type":"string"},{"property":"reason","type":"string"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"metadata","type":"object"}]}},{"property":"swaps","type":"array","description":null,"format":null,"nestedModel":{"title":"Refund","properties":[{"property":"id","type":"string"},{"property":"order_id","type":"string"},{"property":"amount","type":"integer"},{"property":"note","type":"string"},{"property":"reason","type":"string"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"metadata","type":"object"}]}},{"property":"gift_card_transactions","type":"array","description":null,"format":null,"nestedModel":{"title":"Gift Card Transaction","properties":[{"property":"id","type":"string"},{"property":"gift_card_id","type":"string"},{"property":"gift_card","type":null},{"property":"order_id","type":"string"},{"property":"amount","type":"integer"},{"property":"created_at","type":"string"}]}},{"property":"canceled_at","type":"string","description":null,"format":"date-time","nestedModel":null},{"property":"created_at","type":"string","description":null,"format":"date-time","nestedModel":null},{"property":"update_at","type":"string","description":null,"format":"date-time","nestedModel":null},{"property":"deleted_at","type":"string","description":null,"format":"date-time","nestedModel":null},{"property":"metadata","type":"object","description":null,"format":null,"nestedModel":null},{"property":"shipping_total","type":"integer","description":null,"format":null,"nestedModel":null},{"property":"discount_total","type":"integer","description":null,"format":null,"nestedModel":null},{"property":"tax_total","type":"integer","description":null,"format":null,"nestedModel":null},{"property":"subtotal","type":"integer","description":null,"format":null,"nestedModel":null},{"property":"refundable_amount","type":"integer","description":null,"format":null,"nestedModel":null},{"property":"gift_card_total","type":"integer","description":null,"format":null,"nestedModel":null},{"property":"paid_total","type":"integer","description":null,"format":null,"nestedModel":null},{"property":"no_notification","type":"boolean","description":"Flag for describing whether or not notifications related to this should be send.","format":null,"nestedModel":null}]}}},{"section":{"section_name":"Region","paths":[{"name":"/regions/{id}","methods":[{"tags":["Region"],"summary":"Retrieves a Region","description":"Retrieves a Region.","method":"get","operationId":"GetRegionsRegion","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/region","property":"region","description":null,"json":"{\n \"region\": {\n \"id\": \"reg_01F0YES4R67TXXC1QBQ8P54A8Y\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"payment_providers\": [],\n \"fulfillment_providers\": [\n {\n \"id\": \"test-ful\",\n \"is_installed\": true\n }\n ],\n \"created_at\": \"2021-03-16T21:24:00.389Z\",\n \"updated_at\": \"2021-03-16T21:24:00.389Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"The id of the Region.","in":"path","name":"id","required":true,"schema":{"type":"string"}}]}]},{"name":"/regions","methods":[{"tags":["Region"],"summary":"List Regions","description":"Retrieves a list of Regions.","method":"get","operationId":"GetRegions","responses":[{"status":"200","description":"OK","content":[{"_ref":null,"property":"count","description":"The total number of regions.","json":null,"items":null},{"_ref":null,"property":"offset","description":"The offset for pagination.","json":null,"items":null},{"_ref":null,"property":"limit","description":"The maxmimum number of regions to return,","json":null,"items":null},{"_ref":null,"property":"regions","description":null,"json":"{\n \"regions\": [\n {\n \"id\": \"reg_01F0YES4R67TXXC1QBQ8P54A8Y\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"payment_providers\": [],\n \"fulfillment_providers\": [\n {\n \"id\": \"test-ful\",\n \"is_installed\": true\n }\n ],\n \"created_at\": \"2021-03-16T21:24:00.389Z\",\n \"updated_at\": \"2021-03-16T21:24:00.389Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ]\n}","items":{"_ref":"#/components/schemas/region"}}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":null}]}],"schema":{"object":"{\n \"id\": \"reg_01F0YES4R67TXXC1QBQ8P54A8Y\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"payment_providers\": [],\n \"fulfillment_providers\": [\n {\n \"id\": \"test-ful\",\n \"is_installed\": true\n }\n ],\n \"created_at\": \"2021-03-16T21:24:00.389Z\",\n \"updated_at\": \"2021-03-16T21:24:00.389Z\",\n \"deleted_at\": null,\n \"metadata\": null\n}","description":"Regions hold settings for how Customers in a given geographical location shop. The is, for example, where currencies and tax rates are defined. A Region can consist of multiple countries to accomodate common shopping settings across countries.","properties":[{"property":"id","type":"string","description":"The id of the Region. This value will be prefixed with `reg_`.","format":null,"nestedModel":null},{"property":"name","type":"string","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","format":null,"nestedModel":null},{"property":"currency_code","type":"string","description":"The 3 character ISO currency code that Customers will shop in in the Region.","format":null,"nestedModel":null},{"property":"tax_rate","type":"number","description":"The tax rate that should be charged on purchases in the Region.","format":null,"nestedModel":null},{"property":"tax_code","type":"string","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","format":null,"nestedModel":null},{"property":"countries","type":"array","description":"The countries that are included in the Region.","format":null,"nestedModel":{"title":"Country","properties":[{"property":"id","type":"integer"},{"property":"iso_2","type":"string"},{"property":"iso_3","type":"string"},{"property":"num_code","type":"string"},{"property":"name","type":"string"},{"property":"display_name","type":"string"}]}},{"property":"payment_providers","type":"array","description":"The Payment Providers that can be used to process Payments in the Region.","format":null,"nestedModel":{"title":"Payment Provider","properties":[{"property":"id","type":"string"},{"property":"is_installed","type":"boolean"}]}},{"property":"fulfillment_providers","type":"array","description":"The Fulfillment Providers that can be used to fulfill orders in the Region.","format":null,"nestedModel":{"title":"Fulfillment Provider","properties":[{"property":"id","type":"string"},{"property":"is_installed","type":"boolean"}]}},{"property":"created_at","type":"string","description":"The date with timezone at which the resource was created.","format":"date-time","nestedModel":null},{"property":"updated_at","type":"string","description":"The date with timezone at which the resource was last updated.","format":"date-time","nestedModel":null},{"property":"deleted_at","type":"string","description":"The date with timezone at which the resource was deleted.","format":"date-time","nestedModel":null},{"property":"metadata","type":"object","description":"An optional key-value map with additional information.","format":null,"nestedModel":null}]}}},{"section":{"section_name":"Product","paths":[{"name":"/products/{id}","methods":[{"tags":["Product"],"summary":"Retrieves a Product","description":"Retrieves a Product.","method":"get","operationId":"GetProductsProduct","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/product","property":"product","description":null,"json":"{\n \"product\": {\n \"id\": \"prod_01F0YESHQ27Y31CAMD0NV6W9YP\",\n \"title\": \"Test product\",\n \"subtitle\": null,\n \"description\": \"test-product-description\",\n \"handle\": \"test-product\",\n \"is_giftcard\": false,\n \"images\": [],\n \"thumbnail\": null,\n \"options\": [\n {\n \"id\": \"opt_01F0YESHQBZVKCEXJ24BS6PCX3\",\n \"title\": \"size\",\n \"product_id\": \"prod_01F0YESHQ27Y31CAMD0NV6W9YP\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n {\n \"id\": \"opt_01F0YESHQBV8MMNN4V7WSDMH6G\",\n \"title\": \"color\",\n \"product_id\": \"prod_01F0YESHQ27Y31CAMD0NV6W9YP\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ],\n \"variants\": [\n {\n \"id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"title\": \"Test variant\",\n \"product_id\": \"prod_01F0YESHQ27Y31CAMD0NV6W9YP\",\n \"product\": {\n \"id\": \"prod_01F0YESHQ27Y31CAMD0NV6W9YP\",\n \"title\": \"Test product\",\n \"subtitle\": null,\n \"description\": \"test-product-description\",\n \"handle\": \"test-product\",\n \"is_giftcard\": false,\n \"thumbnail\": null,\n \"profile_id\": \"sp_01F0YESHMKRB4V3B7F6MVQHGNN\",\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"collection_id\": \"test-collection\",\n \"type_id\": \"test-type\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"prices\": [\n {\n \"id\": \"ma_01F0YESHRFQNH5S8Q0PK84YYZN\",\n \"currency_code\": \"usd\",\n \"amount\": 100,\n \"sale_amount\": null,\n \"variant_id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"region_id\": null,\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null\n }\n ],\n \"sku\": null,\n \"barcode\": null,\n \"ean\": null,\n \"upc\": null,\n \"inventory_quantity\": 10,\n \"allow_backorder\": false,\n \"manage_inventory\": true,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"options\": [\n {\n \"id\": \"optval_01F0YESHR7S6ECD03RF6W12DSJ\",\n \"value\": \"large\",\n \"option_id\": \"opt_01F0YESHQBZVKCEXJ24BS6PCX3\",\n \"variant_id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n {\n \"id\": \"optval_01F0YESHR7N2GHM1RN3GKYPN6P\",\n \"value\": \"green\",\n \"option_id\": \"opt_01F0YESHQBV8MMNN4V7WSDMH6G\",\n \"variant_id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ],\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ],\n \"profile_id\": \"sp_01F0YESHMKRB4V3B7F6MVQHGNN\",\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"collection_id\": \"test-collection\",\n \"collection\": {\n \"id\": \"test-collection\",\n \"title\": \"Test collection\",\n \"handle\": null,\n \"created_at\": \"2021-03-16T21:24:13.603Z\",\n \"updated_at\": \"2021-03-16T21:24:13.603Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"type_id\": \"test-type\",\n \"type\": {\n \"id\": \"test-type\",\n \"value\": \"test-type\",\n \"created_at\": \"2021-03-16T21:24:13.613Z\",\n \"updated_at\": \"2021-03-16T21:24:13.613Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"tags\": [\n {\n \"id\": \"tag1\",\n \"value\": \"123\",\n \"created_at\": \"2021-03-16T21:24:13.609Z\",\n \"updated_at\": \"2021-03-16T21:24:13.609Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n {\n \"id\": \"ptag_01F0YESHPZYY3H4SJ3A5918SBN\",\n \"value\": \"456\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ],\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"metadata\": null\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"The id of the Product.","in":"path","name":"id","required":true,"schema":{"type":"string"}}]}]},{"name":"/products","methods":[{"tags":["Product"],"summary":"List Products","description":"Retrieves a list of Products.","method":"get","operationId":"GetProducts","responses":[{"status":"200","description":"OK","content":[{"_ref":null,"property":"count","description":"The total number of Products.","json":null,"items":null},{"_ref":null,"property":"offset","description":"The offset for pagination.","json":null,"items":null},{"_ref":null,"property":"limit","description":"The maxmimum number of Products to return,","json":null,"items":null},{"_ref":null,"property":"products","description":null,"json":"{\n \"products\": [\n {\n \"id\": \"prod_01F0YESHQ27Y31CAMD0NV6W9YP\",\n \"title\": \"Test product\",\n \"subtitle\": null,\n \"description\": \"test-product-description\",\n \"handle\": \"test-product\",\n \"is_giftcard\": false,\n \"images\": [],\n \"thumbnail\": null,\n \"options\": [\n {\n \"id\": \"opt_01F0YESHQBZVKCEXJ24BS6PCX3\",\n \"title\": \"size\",\n \"product_id\": \"prod_01F0YESHQ27Y31CAMD0NV6W9YP\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n {\n \"id\": \"opt_01F0YESHQBV8MMNN4V7WSDMH6G\",\n \"title\": \"color\",\n \"product_id\": \"prod_01F0YESHQ27Y31CAMD0NV6W9YP\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ],\n \"variants\": [\n {\n \"id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"title\": \"Test variant\",\n \"product_id\": \"prod_01F0YESHQ27Y31CAMD0NV6W9YP\",\n \"product\": {\n \"id\": \"prod_01F0YESHQ27Y31CAMD0NV6W9YP\",\n \"title\": \"Test product\",\n \"subtitle\": null,\n \"description\": \"test-product-description\",\n \"handle\": \"test-product\",\n \"is_giftcard\": false,\n \"thumbnail\": null,\n \"profile_id\": \"sp_01F0YESHMKRB4V3B7F6MVQHGNN\",\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"collection_id\": \"test-collection\",\n \"type_id\": \"test-type\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"prices\": [\n {\n \"id\": \"ma_01F0YESHRFQNH5S8Q0PK84YYZN\",\n \"currency_code\": \"usd\",\n \"amount\": 100,\n \"sale_amount\": null,\n \"variant_id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"region_id\": null,\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null\n }\n ],\n \"sku\": null,\n \"barcode\": null,\n \"ean\": null,\n \"upc\": null,\n \"inventory_quantity\": 10,\n \"allow_backorder\": false,\n \"manage_inventory\": true,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"options\": [\n {\n \"id\": \"optval_01F0YESHR7S6ECD03RF6W12DSJ\",\n \"value\": \"large\",\n \"option_id\": \"opt_01F0YESHQBZVKCEXJ24BS6PCX3\",\n \"variant_id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n {\n \"id\": \"optval_01F0YESHR7N2GHM1RN3GKYPN6P\",\n \"value\": \"green\",\n \"option_id\": \"opt_01F0YESHQBV8MMNN4V7WSDMH6G\",\n \"variant_id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ],\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ],\n \"profile_id\": \"sp_01F0YESHMKRB4V3B7F6MVQHGNN\",\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"collection_id\": \"test-collection\",\n \"collection\": {\n \"id\": \"test-collection\",\n \"title\": \"Test collection\",\n \"handle\": null,\n \"created_at\": \"2021-03-16T21:24:13.603Z\",\n \"updated_at\": \"2021-03-16T21:24:13.603Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"type_id\": \"test-type\",\n \"type\": {\n \"id\": \"test-type\",\n \"value\": \"test-type\",\n \"created_at\": \"2021-03-16T21:24:13.613Z\",\n \"updated_at\": \"2021-03-16T21:24:13.613Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"tags\": [\n {\n \"id\": \"tag1\",\n \"value\": \"123\",\n \"created_at\": \"2021-03-16T21:24:13.609Z\",\n \"updated_at\": \"2021-03-16T21:24:13.609Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n {\n \"id\": \"ptag_01F0YESHPZYY3H4SJ3A5918SBN\",\n \"value\": \"456\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ],\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"metadata\": null\n }\n ]\n}","items":{"_ref":"#/components/schemas/product"}}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":null}]}],"schema":{"object":"{\n \"id\": \"prod_01F0YESHQ27Y31CAMD0NV6W9YP\",\n \"title\": \"Test product\",\n \"subtitle\": null,\n \"description\": \"test-product-description\",\n \"handle\": \"test-product\",\n \"is_giftcard\": false,\n \"images\": [],\n \"thumbnail\": null,\n \"options\": [\n {\n \"id\": \"opt_01F0YESHQBZVKCEXJ24BS6PCX3\",\n \"title\": \"size\",\n \"product_id\": \"prod_01F0YESHQ27Y31CAMD0NV6W9YP\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n {\n \"id\": \"opt_01F0YESHQBV8MMNN4V7WSDMH6G\",\n \"title\": \"color\",\n \"product_id\": \"prod_01F0YESHQ27Y31CAMD0NV6W9YP\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ],\n \"variants\": [\n {\n \"id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"title\": \"Test variant\",\n \"product_id\": \"prod_01F0YESHQ27Y31CAMD0NV6W9YP\",\n \"product\": {\n \"id\": \"prod_01F0YESHQ27Y31CAMD0NV6W9YP\",\n \"title\": \"Test product\",\n \"subtitle\": null,\n \"description\": \"test-product-description\",\n \"handle\": \"test-product\",\n \"is_giftcard\": false,\n \"thumbnail\": null,\n \"profile_id\": \"sp_01F0YESHMKRB4V3B7F6MVQHGNN\",\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"collection_id\": \"test-collection\",\n \"type_id\": \"test-type\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"prices\": [\n {\n \"id\": \"ma_01F0YESHRFQNH5S8Q0PK84YYZN\",\n \"currency_code\": \"usd\",\n \"amount\": 100,\n \"sale_amount\": null,\n \"variant_id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"region_id\": null,\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null\n }\n ],\n \"sku\": null,\n \"barcode\": null,\n \"ean\": null,\n \"upc\": null,\n \"inventory_quantity\": 10,\n \"allow_backorder\": false,\n \"manage_inventory\": true,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"options\": [\n {\n \"id\": \"optval_01F0YESHR7S6ECD03RF6W12DSJ\",\n \"value\": \"large\",\n \"option_id\": \"opt_01F0YESHQBZVKCEXJ24BS6PCX3\",\n \"variant_id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n {\n \"id\": \"optval_01F0YESHR7N2GHM1RN3GKYPN6P\",\n \"value\": \"green\",\n \"option_id\": \"opt_01F0YESHQBV8MMNN4V7WSDMH6G\",\n \"variant_id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ],\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ],\n \"profile_id\": \"sp_01F0YESHMKRB4V3B7F6MVQHGNN\",\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"collection_id\": \"test-collection\",\n \"collection\": {\n \"id\": \"test-collection\",\n \"title\": \"Test collection\",\n \"handle\": null,\n \"created_at\": \"2021-03-16T21:24:13.603Z\",\n \"updated_at\": \"2021-03-16T21:24:13.603Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"type_id\": \"test-type\",\n \"type\": {\n \"id\": \"test-type\",\n \"value\": \"test-type\",\n \"created_at\": \"2021-03-16T21:24:13.613Z\",\n \"updated_at\": \"2021-03-16T21:24:13.613Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"tags\": [\n {\n \"id\": \"tag1\",\n \"value\": \"123\",\n \"created_at\": \"2021-03-16T21:24:13.609Z\",\n \"updated_at\": \"2021-03-16T21:24:13.609Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n {\n \"id\": \"ptag_01F0YESHPZYY3H4SJ3A5918SBN\",\n \"value\": \"456\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ],\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"metadata\": null\n}","description":"Products are a grouping of Product Variants that have common properties such as images and descriptions. Products can have multiple options which define the properties that Product Variants differ by.","properties":[{"property":"id","type":"string","description":"The id of the Product. This value will be prefixed with `prod_`.","format":null,"nestedModel":null},{"property":"title","type":"string","description":"A title that can be displayed for easy identification of the Product.","format":null,"nestedModel":null},{"property":"subtitle","type":"string","description":"An optional subtitle that can be used to further specify the Product.","format":null,"nestedModel":null},{"property":"description","type":"string","description":"A short description of the Product.","format":null,"nestedModel":null},{"property":"handle","type":"string","description":"A unique identifier for the Product (e.g. for slug structure).","format":null,"nestedModel":null},{"property":"is_giftcard","type":"boolean","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","format":null,"nestedModel":null},{"property":"discountable","type":"boolean","description":"Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.","format":null,"nestedModel":null},{"property":"images","type":"array","description":"Images of the Product","format":null,"nestedModel":{"title":"Image","properties":[{"property":"id","type":"string"},{"property":"url","type":"string"},{"property":"created_at","type":"string"},{"property":"update_at","type":"string"},{"property":"deleted_at","type":"string"},{"property":"metadata","type":"object"}]}},{"property":"thumbnail","type":"string","description":"A URL to an image file that can be used to identify the Product.","format":null,"nestedModel":null},{"property":"options","type":"array","description":"The Product Options that are defined for the Product. Product Variants of the Product will have a unique combination of Product Option Values.","format":null,"nestedModel":{"title":"Product Option","properties":[{"property":"id","type":"string"},{"property":"title","type":"string"},{"property":"values","type":"array"},{"property":"product_id","type":"string"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"deleted_at","type":"string"},{"property":"metadata","type":"object"}]}},{"property":"variants","type":"array","description":"The Product Variants that belong to the Product. Each will have a unique combination of Product Option Values.","format":null,"nestedModel":{"title":"Product Variant","properties":[{"property":"id","type":"string"},{"property":"title","type":"string"},{"property":"product_id","type":"string"},{"property":"prices","type":"array"},{"property":"sku","type":"string"},{"property":"barcode","type":"string"},{"property":"ean","type":"string"},{"property":"upc","type":"string"},{"property":"inventory_quantity","type":"integer"},{"property":"allow_backorder","type":"boolean"},{"property":"manage_inventory","type":"boolean"},{"property":"hs_code","type":"string"},{"property":"origin_country","type":"string"},{"property":"mid_code","type":"string"},{"property":"material","type":"string"},{"property":"weight","type":"string"},{"property":"height","type":"string"},{"property":"width","type":"string"},{"property":"length","type":"string"},{"property":"options","type":"array"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"deleted_at","type":"string"},{"property":"metadata","type":"object"}]}},{"property":"profile_id","type":"string","description":"The id of the Shipping Profile that the Product belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products.","format":null,"nestedModel":null},{"property":"hs_code","type":"string","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","format":null,"nestedModel":null},{"property":"origin_country","type":"string","description":"The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","format":null,"nestedModel":null},{"property":"mid_code","type":"string","description":"The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","format":null,"nestedModel":null},{"property":"material","type":"string","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","format":null,"nestedModel":null},{"property":"weight","type":"string","description":"The weight of the Product Variant. May be used in shipping rate calculations.","format":null,"nestedModel":null},{"property":"height","type":"string","description":"The height of the Product Variant. May be used in shipping rate calculations.","format":null,"nestedModel":null},{"property":"width","type":"string","description":"The width of the Product Variant. May be used in shipping rate calculations.","format":null,"nestedModel":null},{"property":"length","type":"string","description":"The length of the Product Variant. May be used in shipping rate calculations.","format":null,"nestedModel":null},{"property":"type","type":null,"description":"The Product Type of the Product (e.g. \"Clothing\")","format":null,"nestedModel":{"title":"Product Type","properties":[{"property":"id","type":"string"},{"property":"value","type":"string"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"deleted_at","type":"string"},{"property":"metadata","type":"object"}]}},{"property":"collection","type":null,"description":"The Product Collection that the Product belongs to (e.g. \"SS20\")","format":null,"nestedModel":{"title":"Product Collection","properties":[{"property":"id","type":"string"},{"property":"title","type":"string"},{"property":"handle","type":"string"},{"property":"products","type":"array"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"deleted_at","type":"string"},{"property":"metadata","type":"object"}]}},{"property":"tags","type":"array","description":"The Product Tags assigned to the Product.","format":null,"nestedModel":{"title":"Product Tag","properties":[{"property":"id","type":"string"},{"property":"value","type":"string"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"deleted_at","type":"string"},{"property":"metadata","type":"object"}]}},{"property":"created_at","type":"string","description":"The date with timezone at which the resource was created.","format":"date-time","nestedModel":null},{"property":"updated_at","type":"string","description":"The date with timezone at which the resource was last updated.","format":"date-time","nestedModel":null},{"property":"deleted_at","type":"string","description":"The date with timezone at which the resource was deleted.","format":"date-time","nestedModel":null},{"property":"metadata","type":"object","description":"An optional key-value map with additional information.","format":null,"nestedModel":null}]}}},{"section":{"section_name":"Return Reason","paths":[{"name":"/return-reasons/{id}","methods":[{"tags":["Return Reason"],"summary":"Retrieve a Return Reason","description":"Retrieves a Return Reason.","method":"get","operationId":"GetReturnReasonsReason","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/return_reason","property":"return_reason","description":null,"json":"{}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"The id of the Return Reason.","in":"path","name":"id","required":true,"schema":{"type":"string"}}]}]},{"name":"/return-reasons","methods":[{"tags":["Return Reason"],"summary":"List Return Reasons","description":"Retrieves a list of Return Reasons.","method":"get","operationId":"GetReturnReasons","responses":[{"status":"200","description":"OK","content":[{"_ref":null,"property":"return_reasons","description":null,"json":null,"items":{"_ref":"#/components/schemas/return_reason"}}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":null}]}],"schema":null}},{"section":{"section_name":"Return","paths":[{"name":"/returns","methods":[{"tags":["Return"],"summary":"Create Return","description":"Creates a Return for an Order.","method":"post","operationId":"PostReturns","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/return","property":"return","description":null,"json":"{\n \"return\": {\n \"id\": \"ret_01F0YET7XPCMF8RZ0Y151NZV2V\",\n \"status\": \"requested\",\n \"items\": [\n {\n \"return_id\": \"ret_01F0YET7XPCMF8RZ0Y151NZV2V\",\n \"item_id\": \"test-item\",\n \"quantity\": 1,\n \"is_requested\": true,\n \"requested_quantity\": 1,\n \"received_quantity\": null,\n \"reason_id\": null,\n \"reason\": null,\n \"note\": null,\n \"metadata\": null\n }\n ],\n \"swap_id\": null,\n \"claim_order_id\": null,\n \"order_id\": \"order_01F0YET7RD6NWQTEM0ZN5DRRVD\",\n \"shipping_method\": null,\n \"shipping_data\": null,\n \"refund_amount\": 7200,\n \"received_at\": null,\n \"created_at\": \"2021-03-16T21:24:36.381Z\",\n \"updated_at\": \"2021-03-16T21:24:36.381Z\",\n \"metadata\": null,\n \"idempotency_key\": \"f3dee891-7a24-4e34-9071-62606035563d\"\n }\n}","items":null}]}],"requestBody":{"type":null,"required":["order_id","items"],"properties":[{"description":"The id of the Order to create the Return from.","property":"order_id","type":"string","nestedModel":null},{"description":"The items to include in the Return.","property":"items","type":"array","nestedModel":null},{"description":"If the Return is to be handled by the store operator the Customer can choose a Return Shipping Method. Alternatvely the Customer can handle the Return themselves.","property":"return_shipping","type":"object","nestedModel":null}]},"parameters":null}]}],"schema":{"object":"{\n \"id\": \"ret_01F0YET7XPCMF8RZ0Y151NZV2V\",\n \"status\": \"requested\",\n \"items\": [\n {\n \"return_id\": \"ret_01F0YET7XPCMF8RZ0Y151NZV2V\",\n \"item_id\": \"test-item\",\n \"quantity\": 1,\n \"is_requested\": true,\n \"requested_quantity\": 1,\n \"received_quantity\": null,\n \"reason_id\": null,\n \"reason\": null,\n \"note\": null,\n \"metadata\": null\n }\n ],\n \"swap_id\": null,\n \"claim_order_id\": null,\n \"order_id\": \"order_01F0YET7RD6NWQTEM0ZN5DRRVD\",\n \"shipping_method\": null,\n \"shipping_data\": null,\n \"refund_amount\": 7200,\n \"received_at\": null,\n \"created_at\": \"2021-03-16T21:24:36.381Z\",\n \"updated_at\": \"2021-03-16T21:24:36.381Z\",\n \"metadata\": null,\n \"idempotency_key\": \"f3dee891-7a24-4e34-9071-62606035563d\"\n}","description":"Return orders hold information about Line Items that a Customer wishes to send back, along with how the items will be returned. Returns can be used as part of a Swap.","properties":[{"property":"id","type":"string","description":"The id of the Return. This value will be prefixed with `ret_`.","format":null,"nestedModel":null},{"property":"status","type":"string","description":"Status of the Return.","format":null,"nestedModel":null},{"property":"items","type":null,"description":"The Return Items that will be shipped back to the warehouse. type: array items: $ref: ","format":null,"nestedModel":null},{"property":"swap_id","type":"string","description":"The id of the Swap that the Return is a part of.","format":null,"nestedModel":null},{"property":"order_id","type":"string","description":"The id of the Order that the Return is made from.","format":null,"nestedModel":null},{"property":"claim_order_id","type":"string","description":"The id of the Claim that the Return is a part of.","format":null,"nestedModel":null},{"property":"shipping_method","type":null,"description":"The Shipping Method that will be used to send the Return back. Can be null if the Customer facilitates the return shipment themselves.","format":null,"nestedModel":{"title":"Shipping Method","properties":[{"property":"id","type":"string"},{"property":"shipping_option_id","type":"string"},{"property":"shipping_option","type":null},{"property":"order_id","type":"string"},{"property":"return_id","type":"string"},{"property":"swap_id","type":"string"},{"property":"cart_id","type":"string"},{"property":"claim_order_id","type":"string"},{"property":"price","type":"integer"},{"property":"data","type":"object"}]}},{"property":"shipping_data","type":"object","description":"Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.","format":null,"nestedModel":null},{"property":"refund_amount","type":"integer","description":"The amount that should be refunded as a result of the return.","format":null,"nestedModel":null},{"property":"received_at","type":"string","description":"The date with timezone at which the return was received.","format":"date-time","nestedModel":null},{"property":"created_at","type":"string","description":"The date with timezone at which the resource was created.","format":"date-time","nestedModel":null},{"property":"updated_at","type":"string","description":"The date with timezone at which the resource was last updated.","format":"date-time","nestedModel":null},{"property":"no_notification","type":"boolean","description":"When set to true, no notification will be sent related to this return.","format":null,"nestedModel":null},{"property":"metadata","type":"object","description":"An optional key-value map with additional information.","format":null,"nestedModel":null}]}}},{"section":{"section_name":"Shipping Option","paths":[{"name":"/shipping-options","methods":[{"tags":["Shipping Option"],"summary":"Retrieve Shipping Options","description":"Retrieves a list of Shipping Options.","method":"get","operationId":"GetShippingOptions","responses":[{"status":"200","description":"OK","content":[{"_ref":null,"property":"shipping_options","description":null,"json":"{\n \"shipping_options\": [\n {\n \"id\": \"so_01F0YES4T6ZHH52Z4KZEDT1312\",\n \"name\": \"Free Shipping\",\n \"region_id\": \"reg_01F0YES4R67TXXC1QBQ8P54A8Y\",\n \"region\": {\n \"id\": \"reg_01F0YES4R67TXXC1QBQ8P54A8Y\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"payment_providers\": [],\n \"fulfillment_providers\": [\n {\n \"id\": \"test-ful\",\n \"is_installed\": true\n }\n ],\n \"created_at\": \"2021-03-16T21:24:00.389Z\",\n \"updated_at\": \"2021-03-16T21:24:00.389Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"profile_id\": \"sp_01F0YES4Q77FGG18GPFWW5BZP9\",\n \"profile\": {\n \"id\": \"sp_01F0YES4Q77FGG18GPFWW5BZP9\",\n \"name\": \"Default Shipping Profile\",\n \"type\": \"default\",\n \"created_at\": \"2021-03-16T21:24:00.307Z\",\n \"updated_at\": \"2021-03-16T21:24:00.307Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"provider_id\": \"test-ful\",\n \"price_type\": \"flat_rate\",\n \"amount\": 100,\n \"is_return\": false,\n \"requirements\": [],\n \"data\": {},\n \"created_at\": \"2021-03-16T21:24:00.439Z\",\n \"updated_at\": \"2021-03-16T21:24:00.439Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ]\n}","items":{"_ref":"#/components/schemas/shipping_option"}}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"Whether return Shipping Options should be included. By default all Shipping Options are returned.","in":"query","name":"is_return","required":null,"schema":{"type":"boolean"}},{"description":"A comma separated list of Product ids to filter Shipping Options by.","in":"query","name":"product_ids","required":null,"schema":{"type":"string"}},{"description":"the Region to retrieve Shipping Options from.","in":"query","name":"region_id","required":null,"schema":{"type":"string"}}]}]},{"name":"/shipping-options/{cart_id}","methods":[{"tags":["Shipping Option"],"summary":"Retrieve Shipping Options for Cart","description":"Retrieves a list of Shipping Options available to a cart.","method":"get","operationId":"GetShippingOptionsCartId","responses":[{"status":"200","description":"OK","content":[{"_ref":null,"property":"shipping_options","description":null,"json":"{\n \"shipping_options\": [\n {\n \"id\": \"so_01F0YES4T6ZHH52Z4KZEDT1312\",\n \"name\": \"Free Shipping\",\n \"region_id\": \"reg_01F0YES4R67TXXC1QBQ8P54A8Y\",\n \"region\": {\n \"id\": \"reg_01F0YES4R67TXXC1QBQ8P54A8Y\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"payment_providers\": [],\n \"fulfillment_providers\": [\n {\n \"id\": \"test-ful\",\n \"is_installed\": true\n }\n ],\n \"created_at\": \"2021-03-16T21:24:00.389Z\",\n \"updated_at\": \"2021-03-16T21:24:00.389Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"profile_id\": \"sp_01F0YES4Q77FGG18GPFWW5BZP9\",\n \"profile\": {\n \"id\": \"sp_01F0YES4Q77FGG18GPFWW5BZP9\",\n \"name\": \"Default Shipping Profile\",\n \"type\": \"default\",\n \"created_at\": \"2021-03-16T21:24:00.307Z\",\n \"updated_at\": \"2021-03-16T21:24:00.307Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"provider_id\": \"test-ful\",\n \"price_type\": \"flat_rate\",\n \"amount\": 100,\n \"is_return\": false,\n \"requirements\": [],\n \"data\": {},\n \"created_at\": \"2021-03-16T21:24:00.439Z\",\n \"updated_at\": \"2021-03-16T21:24:00.439Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ]\n}","items":{"_ref":"#/components/schemas/shipping_option"}}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"The id of the Cart.","in":"path","name":"cart_id","required":true,"schema":{"type":"string"}}]}]}],"schema":{"object":"{\n \"id\": \"so_01F0YES4T6ZHH52Z4KZEDT1312\",\n \"name\": \"Free Shipping\",\n \"region_id\": \"reg_01F0YES4R67TXXC1QBQ8P54A8Y\",\n \"region\": {\n \"id\": \"reg_01F0YES4R67TXXC1QBQ8P54A8Y\",\n \"name\": \"Test Region\",\n \"currency_code\": \"usd\",\n \"tax_rate\": \"0\",\n \"tax_code\": null,\n \"payment_providers\": [],\n \"fulfillment_providers\": [\n {\n \"id\": \"test-ful\",\n \"is_installed\": true\n }\n ],\n \"created_at\": \"2021-03-16T21:24:00.389Z\",\n \"updated_at\": \"2021-03-16T21:24:00.389Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"profile_id\": \"sp_01F0YES4Q77FGG18GPFWW5BZP9\",\n \"profile\": {\n \"id\": \"sp_01F0YES4Q77FGG18GPFWW5BZP9\",\n \"name\": \"Default Shipping Profile\",\n \"type\": \"default\",\n \"created_at\": \"2021-03-16T21:24:00.307Z\",\n \"updated_at\": \"2021-03-16T21:24:00.307Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"provider_id\": \"test-ful\",\n \"price_type\": \"flat_rate\",\n \"amount\": 100,\n \"is_return\": false,\n \"requirements\": [],\n \"data\": {},\n \"created_at\": \"2021-03-16T21:24:00.439Z\",\n \"updated_at\": \"2021-03-16T21:24:00.439Z\",\n \"deleted_at\": null,\n \"metadata\": null\n}","description":"Shipping Options represent a way in which an Order or Return can be shipped. Shipping Options have an associated Fulfillment Provider that will be used when the fulfillment of an Order is initiated. Shipping Options themselves cannot be added to Carts, but serve as a template for Shipping Methods. This distinction makes it possible to customize individual Shipping Methods with additional information.","properties":[{"property":"id","type":"string","description":"The id of the Shipping Option. This value will be prefixed with `so_`.","format":null,"nestedModel":null},{"property":"name","type":"string","description":"The name given to the Shipping Option - this may be displayed to the Customer.","format":null,"nestedModel":null},{"property":"region_id","type":"string","description":"The id of the Region that the Shipping Option belongs to.","format":null,"nestedModel":null},{"property":"region","type":null,"description":"The id of the Region that the Shipping Option belongs to.","format":null,"nestedModel":{"title":"Region","properties":[{"property":"id","type":"string"},{"property":"name","type":"string"},{"property":"currency_code","type":"string"},{"property":"tax_rate","type":"number"},{"property":"tax_code","type":"string"},{"property":"countries","type":"array"},{"property":"payment_providers","type":"array"},{"property":"fulfillment_providers","type":"array"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"deleted_at","type":"string"},{"property":"metadata","type":"object"}]}},{"property":"profile_id","type":"string","description":"The id of the Shipping Profile that the Shipping Option belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products.","format":null,"nestedModel":null},{"property":"provider_id","type":"string","description":"The id of the Fulfillment Provider, that will be used to process Fulfillments from the Shipping Option.","format":null,"nestedModel":null},{"property":"price_type","type":"string","description":"The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.","format":null,"nestedModel":null},{"property":"amount","type":"integer","description":"The amount to charge for shipping when the Shipping Option price type is `flat_rate`.","format":null,"nestedModel":null},{"property":"is_return","type":"boolean","description":"Flag to indicate if the Shipping Option can be used for Return shipments.","format":null,"nestedModel":null},{"property":"requirements","type":"array","description":"The requirements that must be satisfied for the Shipping Option to be available for a Cart.","format":null,"nestedModel":{"title":"Shipping Option Requirement","properties":[{"property":"id","type":"string"},{"property":"shipping_option_id","type":"string"},{"property":"type","type":"string"},{"property":"amount","type":"integer"}]}},{"property":"data","type":"object","description":"The data needed for the Fulfillment Provider to identify the Shipping Option.","format":null,"nestedModel":null},{"property":"created_at","type":"string","description":"The date with timezone at which the resource was created.","format":"date-time","nestedModel":null},{"property":"updated_at","type":"string","description":"The date with timezone at which the resource was last updated.","format":"date-time","nestedModel":null},{"property":"deleted_at","type":"string","description":"The date with timezone at which the resource was deleted.","format":"date-time","nestedModel":null},{"property":"metadata","type":"object","description":"An optional key-value map with additional information.","format":null,"nestedModel":null}]}}},{"section":{"section_name":"Swap","paths":[{"name":"/swaps","methods":[{"tags":["Swap"],"summary":"Create a Swap","description":"Creates a Swap on an Order by providing some items to return along with some items to send back","method":"post","operationId":"PostSwaps","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/swap","property":"swap","description":null,"json":"{\n \"swap\": {\n \"id\": \"swap_01F0YET86Y9G92D3YDR9Y6V676\",\n \"fulfillment_status\": \"not_fulfilled\",\n \"payment_status\": \"not_paid\",\n \"order_id\": \"order_01F0YET82SR6NB8K61TNRN36FW\",\n \"additional_items\": [\n {\n \"id\": \"item_01F0YET86YR1J3GX155E9R81A3\",\n \"cart_id\": \"cart_01F0YET896KVZ17Y2QDVT28QFE\",\n \"order_id\": null,\n \"swap_id\": \"swap_01F0YET86Y9G92D3YDR9Y6V676\",\n \"claim_order_id\": null,\n \"title\": \"test product\",\n \"description\": \"test variant\",\n \"thumbnail\": null,\n \"is_giftcard\": false,\n \"should_merge\": true,\n \"allow_discounts\": true,\n \"has_shipping\": null,\n \"unit_price\": 8000,\n \"variant_id\": \"variant_01F0YET825M92TKN1ZGAVBPX1B\",\n \"variant\": {\n \"id\": \"variant_01F0YET825M92TKN1ZGAVBPX1B\",\n \"title\": \"test variant\",\n \"product_id\": \"prod_01F0YET8213X0J501ZZHZ56Y7Y\",\n \"product\": {\n \"id\": \"prod_01F0YET8213X0J501ZZHZ56Y7Y\",\n \"title\": \"test product\",\n \"subtitle\": null,\n \"description\": null,\n \"handle\": \"test-product\",\n \"is_giftcard\": false,\n \"thumbnail\": null,\n \"profile_id\": \"sp_01F0YET7AF62TCC9CMWK5TXXAQ\",\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"collection_id\": null,\n \"type_id\": null,\n \"created_at\": \"2021-03-16T21:24:36.545Z\",\n \"updated_at\": \"2021-03-16T21:24:36.545Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"sku\": null,\n \"barcode\": null,\n \"ean\": null,\n \"upc\": null,\n \"inventory_quantity\": 1,\n \"allow_backorder\": false,\n \"manage_inventory\": true,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"created_at\": \"2021-03-16T21:24:36.549Z\",\n \"updated_at\": \"2021-03-16T21:24:36.549Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"quantity\": 2,\n \"fulfilled_quantity\": null,\n \"returned_quantity\": null,\n \"shipped_quantity\": null,\n \"created_at\": \"2021-03-16T21:24:36.659Z\",\n \"updated_at\": \"2021-03-16T21:24:36.659Z\",\n \"metadata\": {}\n }\n ],\n \"return_order\": {\n \"id\": \"ret_01F0YET873ZAXQ7PYVKVFMT9FP\",\n \"status\": \"requested\",\n \"items\": [\n {\n \"return_id\": \"ret_01F0YET873ZAXQ7PYVKVFMT9FP\",\n \"item_id\": \"test-item\",\n \"quantity\": 1,\n \"is_requested\": true,\n \"requested_quantity\": 1,\n \"received_quantity\": null,\n \"reason_id\": null,\n \"reason\": null,\n \"note\": null,\n \"metadata\": null\n }\n ],\n \"swap_id\": \"swap_01F0YET86Y9G92D3YDR9Y6V676\",\n \"claim_order_id\": null,\n \"order_id\": null,\n \"shipping_method\": null,\n \"shipping_data\": null,\n \"refund_amount\": 7200,\n \"received_at\": null,\n \"created_at\": \"2021-03-16T21:24:36.659Z\",\n \"updated_at\": \"2021-03-16T21:24:36.659Z\",\n \"metadata\": null,\n \"idempotency_key\": null\n },\n \"fulfillments\": [],\n \"payment\": null,\n \"difference_due\": null,\n \"shipping_address_id\": null,\n \"shipping_address\": null,\n \"shipping_methods\": [],\n \"cart_id\": \"cart_01F0YET896KVZ17Y2QDVT28QFE\",\n \"confirmed_at\": null,\n \"created_at\": \"2021-03-16T21:24:36.659Z\",\n \"updated_at\": \"2021-03-16T21:24:36.659Z\",\n \"deleted_at\": null,\n \"metadata\": null,\n \"idempotency_key\": \"10804103-2f4f-41ef-b44e-7049459f157d\"\n }\n}","items":null}]}],"requestBody":{"type":null,"required":["order_id","return_items","additional_items"],"properties":[{"description":"The id of the Order to create the Swap for.","property":"order_id","type":"string","nestedModel":null},{"description":"The items to include in the Return.","property":"return_items","type":"array","nestedModel":null},{"description":"The id of the Shipping Option to create the Shipping Method from.","property":"return_shipping_option","type":"string","nestedModel":null},{"description":"The items to exchange the returned items to.","property":"additional_items","type":"array","nestedModel":null}]},"parameters":null}]},{"name":"/swaps/{cart_id}","methods":[{"tags":["Swap"],"summary":"Retrieve Swap by Cart id","description":"Retrieves a Swap by the id of the Cart used to confirm the Swap.","method":"get","operationId":"GetSwapsSwapCartId","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/swap","property":"swap","description":null,"json":"{\n \"swap\": {\n \"id\": \"swap_01F0YET86Y9G92D3YDR9Y6V676\",\n \"fulfillment_status\": \"not_fulfilled\",\n \"payment_status\": \"not_paid\",\n \"order_id\": \"order_01F0YET82SR6NB8K61TNRN36FW\",\n \"additional_items\": [\n {\n \"id\": \"item_01F0YET86YR1J3GX155E9R81A3\",\n \"cart_id\": \"cart_01F0YET896KVZ17Y2QDVT28QFE\",\n \"order_id\": null,\n \"swap_id\": \"swap_01F0YET86Y9G92D3YDR9Y6V676\",\n \"claim_order_id\": null,\n \"title\": \"test product\",\n \"description\": \"test variant\",\n \"thumbnail\": null,\n \"is_giftcard\": false,\n \"should_merge\": true,\n \"allow_discounts\": true,\n \"has_shipping\": null,\n \"unit_price\": 8000,\n \"variant_id\": \"variant_01F0YET825M92TKN1ZGAVBPX1B\",\n \"variant\": {\n \"id\": \"variant_01F0YET825M92TKN1ZGAVBPX1B\",\n \"title\": \"test variant\",\n \"product_id\": \"prod_01F0YET8213X0J501ZZHZ56Y7Y\",\n \"product\": {\n \"id\": \"prod_01F0YET8213X0J501ZZHZ56Y7Y\",\n \"title\": \"test product\",\n \"subtitle\": null,\n \"description\": null,\n \"handle\": \"test-product\",\n \"is_giftcard\": false,\n \"thumbnail\": null,\n \"profile_id\": \"sp_01F0YET7AF62TCC9CMWK5TXXAQ\",\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"collection_id\": null,\n \"type_id\": null,\n \"created_at\": \"2021-03-16T21:24:36.545Z\",\n \"updated_at\": \"2021-03-16T21:24:36.545Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"sku\": null,\n \"barcode\": null,\n \"ean\": null,\n \"upc\": null,\n \"inventory_quantity\": 1,\n \"allow_backorder\": false,\n \"manage_inventory\": true,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"created_at\": \"2021-03-16T21:24:36.549Z\",\n \"updated_at\": \"2021-03-16T21:24:36.549Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"quantity\": 2,\n \"fulfilled_quantity\": null,\n \"returned_quantity\": null,\n \"shipped_quantity\": null,\n \"created_at\": \"2021-03-16T21:24:36.659Z\",\n \"updated_at\": \"2021-03-16T21:24:36.659Z\",\n \"metadata\": {}\n }\n ],\n \"return_order\": {\n \"id\": \"ret_01F0YET873ZAXQ7PYVKVFMT9FP\",\n \"status\": \"requested\",\n \"items\": [\n {\n \"return_id\": \"ret_01F0YET873ZAXQ7PYVKVFMT9FP\",\n \"item_id\": \"test-item\",\n \"quantity\": 1,\n \"is_requested\": true,\n \"requested_quantity\": 1,\n \"received_quantity\": null,\n \"reason_id\": null,\n \"reason\": null,\n \"note\": null,\n \"metadata\": null\n }\n ],\n \"swap_id\": \"swap_01F0YET86Y9G92D3YDR9Y6V676\",\n \"claim_order_id\": null,\n \"order_id\": null,\n \"shipping_method\": null,\n \"shipping_data\": null,\n \"refund_amount\": 7200,\n \"received_at\": null,\n \"created_at\": \"2021-03-16T21:24:36.659Z\",\n \"updated_at\": \"2021-03-16T21:24:36.659Z\",\n \"metadata\": null,\n \"idempotency_key\": null\n },\n \"fulfillments\": [],\n \"payment\": null,\n \"difference_due\": null,\n \"shipping_address_id\": null,\n \"shipping_address\": null,\n \"shipping_methods\": [],\n \"cart_id\": \"cart_01F0YET896KVZ17Y2QDVT28QFE\",\n \"confirmed_at\": null,\n \"created_at\": \"2021-03-16T21:24:36.659Z\",\n \"updated_at\": \"2021-03-16T21:24:36.659Z\",\n \"deleted_at\": null,\n \"metadata\": null,\n \"idempotency_key\": \"10804103-2f4f-41ef-b44e-7049459f157d\"\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"The id of the Cart","in":"path","name":"cart_id","required":true,"schema":{"type":"string"}}]}]}],"schema":{"object":"{\n \"id\": \"swap_01F0YET86Y9G92D3YDR9Y6V676\",\n \"fulfillment_status\": \"not_fulfilled\",\n \"payment_status\": \"not_paid\",\n \"order_id\": \"order_01F0YET82SR6NB8K61TNRN36FW\",\n \"additional_items\": [\n {\n \"id\": \"item_01F0YET86YR1J3GX155E9R81A3\",\n \"cart_id\": \"cart_01F0YET896KVZ17Y2QDVT28QFE\",\n \"order_id\": null,\n \"swap_id\": \"swap_01F0YET86Y9G92D3YDR9Y6V676\",\n \"claim_order_id\": null,\n \"title\": \"test product\",\n \"description\": \"test variant\",\n \"thumbnail\": null,\n \"is_giftcard\": false,\n \"should_merge\": true,\n \"allow_discounts\": true,\n \"has_shipping\": null,\n \"unit_price\": 8000,\n \"variant_id\": \"variant_01F0YET825M92TKN1ZGAVBPX1B\",\n \"variant\": {\n \"id\": \"variant_01F0YET825M92TKN1ZGAVBPX1B\",\n \"title\": \"test variant\",\n \"product_id\": \"prod_01F0YET8213X0J501ZZHZ56Y7Y\",\n \"product\": {\n \"id\": \"prod_01F0YET8213X0J501ZZHZ56Y7Y\",\n \"title\": \"test product\",\n \"subtitle\": null,\n \"description\": null,\n \"handle\": \"test-product\",\n \"is_giftcard\": false,\n \"thumbnail\": null,\n \"profile_id\": \"sp_01F0YET7AF62TCC9CMWK5TXXAQ\",\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"collection_id\": null,\n \"type_id\": null,\n \"created_at\": \"2021-03-16T21:24:36.545Z\",\n \"updated_at\": \"2021-03-16T21:24:36.545Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"sku\": null,\n \"barcode\": null,\n \"ean\": null,\n \"upc\": null,\n \"inventory_quantity\": 1,\n \"allow_backorder\": false,\n \"manage_inventory\": true,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"created_at\": \"2021-03-16T21:24:36.549Z\",\n \"updated_at\": \"2021-03-16T21:24:36.549Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"quantity\": 2,\n \"fulfilled_quantity\": null,\n \"returned_quantity\": null,\n \"shipped_quantity\": null,\n \"created_at\": \"2021-03-16T21:24:36.659Z\",\n \"updated_at\": \"2021-03-16T21:24:36.659Z\",\n \"metadata\": {}\n }\n ],\n \"return_order\": {\n \"id\": \"ret_01F0YET873ZAXQ7PYVKVFMT9FP\",\n \"status\": \"requested\",\n \"items\": [\n {\n \"return_id\": \"ret_01F0YET873ZAXQ7PYVKVFMT9FP\",\n \"item_id\": \"test-item\",\n \"quantity\": 1,\n \"is_requested\": true,\n \"requested_quantity\": 1,\n \"received_quantity\": null,\n \"reason_id\": null,\n \"reason\": null,\n \"note\": null,\n \"metadata\": null\n }\n ],\n \"swap_id\": \"swap_01F0YET86Y9G92D3YDR9Y6V676\",\n \"claim_order_id\": null,\n \"order_id\": null,\n \"shipping_method\": null,\n \"shipping_data\": null,\n \"refund_amount\": 7200,\n \"received_at\": null,\n \"created_at\": \"2021-03-16T21:24:36.659Z\",\n \"updated_at\": \"2021-03-16T21:24:36.659Z\",\n \"metadata\": null,\n \"idempotency_key\": null\n },\n \"fulfillments\": [],\n \"payment\": null,\n \"difference_due\": null,\n \"shipping_address_id\": null,\n \"shipping_address\": null,\n \"shipping_methods\": [],\n \"cart_id\": \"cart_01F0YET896KVZ17Y2QDVT28QFE\",\n \"confirmed_at\": null,\n \"created_at\": \"2021-03-16T21:24:36.659Z\",\n \"updated_at\": \"2021-03-16T21:24:36.659Z\",\n \"deleted_at\": null,\n \"metadata\": null,\n \"idempotency_key\": \"10804103-2f4f-41ef-b44e-7049459f157d\"\n}","description":"Swaps can be created when a Customer wishes to exchange Products that they have purchased to different Products. Swaps consist of a Return of previously purchased Products and a Fulfillment of new Products, the amount paid for the Products being returned will be used towards payment for the new Products. In the case where the amount paid for the the Products being returned exceed the amount to be paid for the new Products, a Refund will be issued for the difference.","properties":[{"property":"id","type":"string","description":"The id of the Swap. This value will be prefixed with `swap_`.","format":null,"nestedModel":null},{"property":"fulfillment_status","type":"string","description":"The status of the Fulfillment of the Swap.","format":null,"nestedModel":null},{"property":"payment_status","type":"string","description":"The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.","format":null,"nestedModel":null},{"property":"order_id","type":"string","description":"The id of the Order where the Line Items to be returned where purchased.","format":null,"nestedModel":null},{"property":"additional_items","type":"array","description":"The new Line Items to ship to the Customer.","format":null,"nestedModel":{"title":"Line Item","properties":[{"property":"id","type":"string"},{"property":"cart_id","type":"string"},{"property":"order_id","type":"string"},{"property":"swap_id","type":"string"},{"property":"claim_order_id","type":"string"},{"property":"title","type":"string"},{"property":"description","type":"string"},{"property":"thumbnail","type":"string"},{"property":"is_giftcard","type":"boolean"},{"property":"should_merge","type":"boolean"},{"property":"allow_discounts","type":"boolean"},{"property":"unit_price","type":"boolean"},{"property":"variant_id","type":"string"},{"property":"variant","type":null},{"property":"quantity","type":"integer"},{"property":"fulfilled_quantity","type":"integer"},{"property":"returned_quantity","type":"integer"},{"property":"shipped_quantity","type":"integer"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"metadata","type":"object"},{"property":"refundable","type":"integer"}]}},{"property":"return_order","type":null,"description":"The Return that is issued for the return part of the Swap.","format":null,"nestedModel":{"title":"Return","properties":[{"property":"id","type":"string"},{"property":"status","type":"string"},{"property":"items","type":null},{"property":"swap_id","type":"string"},{"property":"order_id","type":"string"},{"property":"claim_order_id","type":"string"},{"property":"shipping_method","type":null},{"property":"shipping_data","type":"object"},{"property":"refund_amount","type":"integer"},{"property":"received_at","type":"string"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"no_notification","type":"boolean"},{"property":"metadata","type":"object"}]}},{"property":"fulfillments","type":"array","description":"The Fulfillments used to send the new Line Items.","format":null,"nestedModel":{"title":"Fulfillment","properties":[{"property":"id","type":"string"},{"property":"claim_order_id","type":"string"},{"property":"swap_id","type":"string"},{"property":"order_id","type":"string"},{"property":"provider_id","type":"string"},{"property":"items","type":"array"},{"property":"tracking_links","type":"array"},{"property":"tracking_numbers","type":"array"},{"property":"shipped_at","type":"string"},{"property":"no_notification","type":"boolean"},{"property":"canceled_at","type":"string"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"metadata","type":"object"}]}},{"property":"payment","type":null,"description":"The Payment authorized when the Swap requires an additional amount to be charged from the Customer.","format":null,"nestedModel":{"title":"Payment","properties":[{"property":"id","type":"string"},{"property":"swap_id","type":"string"},{"property":"order_id","type":"string"},{"property":"cart_id","type":"string"},{"property":"amount","type":"integer"},{"property":"currency_code","type":"string"},{"property":"amount_refunded","type":"integer"},{"property":"provider_id","type":"string"},{"property":"data","type":"object"},{"property":"captured_at","type":"string"},{"property":"canceled_at","type":"string"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"metadata","type":"object"}]}},{"property":"difference_due","type":"integer","description":"The difference that is paid or refunded as a result of the Swap. May be negative when the amount paid for the returned items exceed the total of the new Products.","format":null,"nestedModel":null},{"property":"shipping_address","type":null,"description":"The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.","format":null,"nestedModel":{"title":"Address","properties":[{"property":"id","type":"string"},{"property":"customer_id","type":"string"},{"property":"company","type":"string"},{"property":"first_name","type":"string"},{"property":"last_name","type":"string"},{"property":"address_1","type":"string"},{"property":"address_2","type":"string"},{"property":"city","type":"string"},{"property":"country_code","type":"string"},{"property":"country","type":null}]}},{"property":"shipping_methods","type":"array","description":"The Shipping Methods used to fulfill the addtional items purchased.","format":null,"nestedModel":{"title":"Shipping Method","properties":[{"property":"id","type":"string"},{"property":"shipping_option_id","type":"string"},{"property":"shipping_option","type":null},{"property":"order_id","type":"string"},{"property":"return_id","type":"string"},{"property":"swap_id","type":"string"},{"property":"cart_id","type":"string"},{"property":"claim_order_id","type":"string"},{"property":"price","type":"integer"},{"property":"data","type":"object"}]}},{"property":"cart_id","type":"string","description":"The id of the Cart that the Customer will use to confirm the Swap.","format":null,"nestedModel":null},{"property":"allow_backorder","type":"boolean","description":"If true, swaps can be completed with items out of stock","format":null,"nestedModel":null},{"property":"confirmed_at","type":"string","description":"The date with timezone at which the Swap was confirmed by the Customer.","format":"date-time","nestedModel":null},{"property":"created_at","type":"string","description":"The date with timezone at which the resource was created.","format":"date-time","nestedModel":null},{"property":"updated_at","type":"string","description":"The date with timezone at which the resource was last updated.","format":"date-time","nestedModel":null},{"property":"canceled_at","type":"string","description":"The date with timezone at which the Swap was canceled.","format":"date-time","nestedModel":null},{"property":"no_notification","type":"boolean","description":"If set to true, no notification will be sent related to this swap","format":null,"nestedModel":null},{"property":"metadata","type":"object","description":"An optional key-value map with additional information.","format":null,"nestedModel":null}]}}},{"section":{"section_name":"Product Variant","paths":[{"name":"/variants/{variant_id}","methods":[{"tags":["Product Variant"],"summary":"Retrieve a Product Variant","description":"Retrieves a Product Variant by id","method":"get","operationId":"GetVariantsVariant","responses":[{"status":"200","description":"OK","content":[{"_ref":"#/components/schemas/product_variant","property":"variant","description":null,"json":"{\n \"variant\": {\n \"id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"title\": \"Test variant\",\n \"product_id\": \"prod_01F0YESHQ27Y31CAMD0NV6W9YP\",\n \"product\": {\n \"id\": \"prod_01F0YESHQ27Y31CAMD0NV6W9YP\",\n \"title\": \"Test product\",\n \"subtitle\": null,\n \"description\": \"test-product-description\",\n \"handle\": \"test-product\",\n \"is_giftcard\": false,\n \"thumbnail\": null,\n \"profile_id\": \"sp_01F0YESHMKRB4V3B7F6MVQHGNN\",\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"collection_id\": \"test-collection\",\n \"type_id\": \"test-type\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"prices\": [\n {\n \"id\": \"ma_01F0YESHRFQNH5S8Q0PK84YYZN\",\n \"currency_code\": \"usd\",\n \"amount\": 100,\n \"sale_amount\": null,\n \"variant_id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"region_id\": null,\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null\n }\n ],\n \"sku\": null,\n \"barcode\": null,\n \"ean\": null,\n \"upc\": null,\n \"inventory_quantity\": 10,\n \"allow_backorder\": false,\n \"manage_inventory\": true,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"options\": [\n {\n \"id\": \"optval_01F0YESHR7S6ECD03RF6W12DSJ\",\n \"value\": \"large\",\n \"option_id\": \"opt_01F0YESHQBZVKCEXJ24BS6PCX3\",\n \"variant_id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n {\n \"id\": \"optval_01F0YESHR7N2GHM1RN3GKYPN6P\",\n \"value\": \"green\",\n \"option_id\": \"opt_01F0YESHQBV8MMNN4V7WSDMH6G\",\n \"variant_id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ],\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n}","items":null}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"The id of the Product Variant.","in":"path","name":"variant_id","required":true,"schema":{"type":"string"}}]}]},{"name":"/variants","methods":[{"tags":["Product Variant"],"summary":"Retrieve Product Variants","description":"Retrieves a list of Product Variants","method":"get","operationId":"GetVariants","responses":[{"status":"200","description":"OK","content":[{"_ref":null,"property":"variants","description":null,"json":"{\n \"variants\": [\n {\n \"id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"title\": \"Test variant\",\n \"product_id\": \"prod_01F0YESHQ27Y31CAMD0NV6W9YP\",\n \"product\": {\n \"id\": \"prod_01F0YESHQ27Y31CAMD0NV6W9YP\",\n \"title\": \"Test product\",\n \"subtitle\": null,\n \"description\": \"test-product-description\",\n \"handle\": \"test-product\",\n \"is_giftcard\": false,\n \"thumbnail\": null,\n \"profile_id\": \"sp_01F0YESHMKRB4V3B7F6MVQHGNN\",\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"collection_id\": \"test-collection\",\n \"type_id\": \"test-type\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"prices\": [\n {\n \"id\": \"ma_01F0YESHRFQNH5S8Q0PK84YYZN\",\n \"currency_code\": \"usd\",\n \"amount\": 100,\n \"sale_amount\": null,\n \"variant_id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"region_id\": null,\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null\n }\n ],\n \"sku\": null,\n \"barcode\": null,\n \"ean\": null,\n \"upc\": null,\n \"inventory_quantity\": 10,\n \"allow_backorder\": false,\n \"manage_inventory\": true,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"options\": [\n {\n \"id\": \"optval_01F0YESHR7S6ECD03RF6W12DSJ\",\n \"value\": \"large\",\n \"option_id\": \"opt_01F0YESHQBZVKCEXJ24BS6PCX3\",\n \"variant_id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n {\n \"id\": \"optval_01F0YESHR7N2GHM1RN3GKYPN6P\",\n \"value\": \"green\",\n \"option_id\": \"opt_01F0YESHQBV8MMNN4V7WSDMH6G\",\n \"variant_id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ],\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ]\n}","items":{"_ref":"#/components/schemas/product_variant"}}]}],"requestBody":{"type":null,"required":null,"properties":[]},"parameters":[{"description":"A comma separated list of Product Variant ids to filter by.","in":"query","name":"ids","required":null,"schema":{"type":"string"}},{"description":"A comma separated list of Product Variant relations to load.","in":"query","name":"expand","required":null,"schema":{"type":"string"}},{"description":null,"in":"query","name":"offset","required":null,"schema":{"type":"number"}},{"description":"Maximum number of Product Variants to return.","in":"query","name":"limit","required":null,"schema":{"type":"number"}}]}]}],"schema":{"object":"{\n \"id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"title\": \"Test variant\",\n \"product_id\": \"prod_01F0YESHQ27Y31CAMD0NV6W9YP\",\n \"product\": {\n \"id\": \"prod_01F0YESHQ27Y31CAMD0NV6W9YP\",\n \"title\": \"Test product\",\n \"subtitle\": null,\n \"description\": \"test-product-description\",\n \"handle\": \"test-product\",\n \"is_giftcard\": false,\n \"thumbnail\": null,\n \"profile_id\": \"sp_01F0YESHMKRB4V3B7F6MVQHGNN\",\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"collection_id\": \"test-collection\",\n \"type_id\": \"test-type\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n \"prices\": [\n {\n \"id\": \"ma_01F0YESHRFQNH5S8Q0PK84YYZN\",\n \"currency_code\": \"usd\",\n \"amount\": 100,\n \"sale_amount\": null,\n \"variant_id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"region_id\": null,\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null\n }\n ],\n \"sku\": null,\n \"barcode\": null,\n \"ean\": null,\n \"upc\": null,\n \"inventory_quantity\": 10,\n \"allow_backorder\": false,\n \"manage_inventory\": true,\n \"hs_code\": null,\n \"origin_country\": null,\n \"mid_code\": null,\n \"material\": null,\n \"weight\": null,\n \"length\": null,\n \"height\": null,\n \"width\": null,\n \"options\": [\n {\n \"id\": \"optval_01F0YESHR7S6ECD03RF6W12DSJ\",\n \"value\": \"large\",\n \"option_id\": \"opt_01F0YESHQBZVKCEXJ24BS6PCX3\",\n \"variant_id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n },\n {\n \"id\": \"optval_01F0YESHR7N2GHM1RN3GKYPN6P\",\n \"value\": \"green\",\n \"option_id\": \"opt_01F0YESHQBV8MMNN4V7WSDMH6G\",\n \"variant_id\": \"variant_01F0YESHR7P2YAYBDBY5B6X3PK\",\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n }\n ],\n \"created_at\": \"2021-03-16T21:24:13.657Z\",\n \"updated_at\": \"2021-03-16T21:24:13.657Z\",\n \"deleted_at\": null,\n \"metadata\": null\n}","description":"Product Variants represent a Product with a specific set of Product Option configurations. The maximum number of Product Variants that a Product can have is given by the number of available Product Option combinations.","properties":[{"property":"id","type":"string","description":"The id of the Product Variant. This value will be prefixed with `variant_`.","format":null,"nestedModel":null},{"property":"title","type":"string","description":"A title that can be displayed for easy identification of the Product Variant.","format":null,"nestedModel":null},{"property":"product_id","type":"string","description":"The id of the Product that the Product Variant belongs to.","format":null,"nestedModel":null},{"property":"prices","type":"array","description":"The Money Amounts defined for the Product Variant. Each Money Amount represents a price in a given currency or a price in a specific Region.","format":null,"nestedModel":{"title":"Money Amount","properties":[{"property":"id","type":"string"},{"property":"currency_code","type":"string"},{"property":"amount","type":"integer"},{"property":"sale_amount","type":"integer"},{"property":"variant_id","type":"string"},{"property":"region_id","type":"string"},{"property":"region","type":null},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"deleted_at","type":"string"}]}},{"property":"sku","type":"string","description":"The unique stock keeping unit used to identify the Product Variant. This will usually be a unqiue identifer for the item that is to be shipped, and can be referenced across multiple systems.","format":null,"nestedModel":null},{"property":"barcode","type":"string","description":"A generic field for a GTIN number that can be used to identify the Product Variant.","format":null,"nestedModel":null},{"property":"ean","type":"string","description":"An EAN barcode number that can be used to identify the Product Variant.","format":null,"nestedModel":null},{"property":"upc","type":"string","description":"A UPC barcode number that can be used to identify the Product Variant.","format":null,"nestedModel":null},{"property":"inventory_quantity","type":"integer","description":"The current quantity of the item that is stocked.","format":null,"nestedModel":null},{"property":"allow_backorder","type":"boolean","description":"Whether the Product Variant should be purchasable when `inventory_quantity` is 0.","format":null,"nestedModel":null},{"property":"manage_inventory","type":"boolean","description":"Whether Medusa should manage inventory for the Product Variant.","format":null,"nestedModel":null},{"property":"hs_code","type":"string","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","format":null,"nestedModel":null},{"property":"origin_country","type":"string","description":"The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","format":null,"nestedModel":null},{"property":"mid_code","type":"string","description":"The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","format":null,"nestedModel":null},{"property":"material","type":"string","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","format":null,"nestedModel":null},{"property":"weight","type":"string","description":"The weight of the Product Variant. May be used in shipping rate calculations.","format":null,"nestedModel":null},{"property":"height","type":"string","description":"The height of the Product Variant. May be used in shipping rate calculations.","format":null,"nestedModel":null},{"property":"width","type":"string","description":"The width of the Product Variant. May be used in shipping rate calculations.","format":null,"nestedModel":null},{"property":"length","type":"string","description":"The length of the Product Variant. May be used in shipping rate calculations.","format":null,"nestedModel":null},{"property":"options","type":"array","description":"The Product Option Values specified for the Product Variant.","format":null,"nestedModel":{"title":"Product Option Value","properties":[{"property":"id","type":"string"},{"property":"value","type":"string"},{"property":"option_id","type":"string"},{"property":"variant_id","type":"string"},{"property":"created_at","type":"string"},{"property":"updated_at","type":"string"},{"property":"deleted_at","type":"string"},{"property":"metadata","type":"object"}]}},{"property":"created_at","type":"string","description":"The date with timezone at which the resource was created.","format":"date-time","nestedModel":null},{"property":"updated_at","type":"string","description":"The date with timezone at which the resource was last updated.","format":"date-time","nestedModel":null},{"property":"deleted_at","type":"string","description":"The date with timezone at which the resource was deleted.","format":"date-time","nestedModel":null},{"property":"metadata","type":"object","description":"An optional key-value map with additional information.","format":null,"nestedModel":null}]}}}]},"api":"store","title":"Store","description":"Storefront API"}},
|
|
"staticQueryHashes": ["2744905544"]} |