{"openapi":"3.0.3","info":{"title":"Authentified REST API","description":"\n  Documentation for the Authentified REST API.\n\n  ## Getting Started\n  \n  The Authentified REST API is primarily a one-way sync API designed to import order, customer, and product information from your e-commerce platform into Authentified.\n\n  ## Authentication\n\n  All Authentified REST endpoints require an `X-Authentified-API-Key` header to be present. Your Authentified account manager will generate and supply an API key for you.\n\n  ## Versions\n\n  The Authentified REST API is versioned to ensure backward compatibility. Each version of the API is independent and can be used without affecting other versions.\n\n  We currently only have an unstable version of the API available. We recommend using it for testing purposes only. \n\n  In future all versions will have a base prefix of `{version}/` in the URL, e.g. `https://api.authentified.co/v1/order`\n \n  ## Rate Limits\n\n  We currently do not have rate limits in place.\n\n  ## Syncing Guide\n\n  The Authentified REST API is designed to be used for one-way syncs from your e-commerce platform to Authentified. We recommend using a combination of event-based and scheduled syncs to keep your data up-to-date and avoid drift.\n\n  #### Event-based\n\n  If your e-commerce platform supports events, such as Magento's `catalog_product_save_after` event, you can use this to trigger a sync to Authentified whenever a product is created or updated.\n\n  > [!TIP]\n  > We recommend implementing retry logic with exponential backoff in case of request failures.\n\n  #### Daily Sync\n\n  We recommend running a daily re-sync of all products, product variants, customers, orders, and order line items that have been created or modified in the day to ensure that your data is up-to-date and to avoid drift.\n  \n  > [!TIP]\n  > We recommend getting records from the past 25 hours to ensure there is sufficient overlap from the last daily sync.\n\n  #### Initial Sync\n\n  When you first set up the Authentified REST API, we recommend running an initial sync of all products, product variants, customers, orders, and order line items. This operation can take some time, depending on the number of records you have in your e-commerce platform so we recommend storing the current state of operations so that you can resume the sync from the last succcessful operation if it fails.\n\n  #### Order of Operations\n\n  Relationships between resources are not enforced by our API, so you can create or update resources in any order.\n","version":"unstable","contact":{"name":"Authentified","url":"https://authentified.co"}},"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"X-Authentified-API-Key","in":"header"}},"schemas":{"Analysis":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"The UUID of the product analysis","example":"550e8400-e29b-41d4-a716-446655440000"},"status":{"type":"string","enum":["started","failed","finalising","complete"],"description":"The current status of the analysis","example":"complete"},"images":{"type":"array","description":"Images to analyse","items":{"type":"object","properties":{"id":{"type":"string","description":"The image identifier"},"url":{"type":"string","format":"uri","description":"The image URL"}},"required":["id","url"]},"example":[{"id":"img_001","url":"https://example.com/photo1.jpg"}]},"result":{"type":"object","nullable":true,"description":"The analysis result containing predicted facets","properties":{"usage":{"type":"object","properties":{"duration":{"type":"number"},"totalTokens":{"type":"number"}}},"output":{"type":"object","properties":{"model":{"type":"string"},"version":{"type":"string"},"provider":{"type":"string"},"prediction":{"type":"object","properties":{"size":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"brand":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"title":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"colour":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"weight":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"category":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"condition":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"description":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"minimumPrice":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"imperfections":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"startingPrice":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"usedCondition":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"imageBestSortOrder":{"type":"array","items":{"type":"number"}},"hasTagsAndPackaging":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}}}},"schemaVersion":{"type":"string"}}}}}},"additionalProperties":false,"required":["images"]},"Customer":{"type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the order in your system","example":"940198"},"customerId":{"type":"string","description":"The Unique Identifier of the customer who placed the order","example":"897835"},"paidStatus":{"type":"string","enum":["PENDING","PARTIALLY_PAID","PARTIALLY_REFUNDED","PAID","REFUNDED","VOIDED"],"description":"The financial status of the order","example":"PAID"},"total":{"type":"number","description":"The total amount of the order","example":149.99},"currencyCode":{"type":"string","description":"The currency code of the order total","example":"USD"},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the order was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the order was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","customerId","paidStatus"]},"Order":{"type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the order in your system","example":"940198"},"customerId":{"type":"string","description":"The Unique Identifier of the customer who placed the order","example":"897835"},"paidStatus":{"type":"string","enum":["PENDING","PARTIALLY_PAID","PARTIALLY_REFUNDED","PAID","REFUNDED","VOIDED"],"description":"The financial status of the order","example":"PAID"},"total":{"type":"number","description":"The total amount of the order","example":149.99},"currencyCode":{"type":"string","description":"The currency code of the order total","example":"USD"},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the order was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the order was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","customerId","paidStatus"]},"OrderLineItem":{"type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the order in your system","example":"599062"},"orderId":{"type":"string","description":"The Unique Identifier of the order this line item belongs to","example":"192382"},"productId":{"type":"string","description":"The Unique Identifier of the product this line item refers to","example":"458291"},"variantId":{"type":"string","description":"The Unique Identifier of the product variant this line item refers to","example":"6426781"},"price":{"type":"number","description":"The price of the line item","example":29.99},"quantity":{"type":"number","description":"The quantity of the product in this line item","example":2},"subTotal":{"type":"number","description":"The subtotal for this line item","example":59.98},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the order line item was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the order line item was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","orderId","productId","variantId","price","quantity","subTotal"]},"Product":{"type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the product in your system","example":"458291"},"title":{"type":"string","description":"Title of the product","example":"Silk Wrap Dress"},"handle":{"type":"string","description":"A slug identifying the product in kebab-case format","pattern":"^[a-z0-9]+(-[a-z0-9]+)*$","example":"silk-wrap-dress"},"status":{"type":"string","enum":["ACTIVE","DRAFT","ARCHIVED"],"description":"The status of the product","example":"ACTIVE"},"category":{"type":"string","description":"Category of the product","example":"Dresses"},"description":{"type":"string","description":"Description of the product","example":"A beautiful silk wrap dress perfect for summer."},"vendor":{"type":"string","description":"The vendor of the product","example":"Sportsgirl"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags associated with the product","example":["summer","dress","onsale","nodiscount"]},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the product was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the product was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","title","handle","status"]},"ProductMedia":{"type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the image or video in your system","example":"765325"},"productId":{"type":"string","description":"The Unique Identifier of the product this media belongs to","example":"458291"},"src":{"type":"string","format":"uri","description":"The URL of the image or video","example":"https://mydomain.com/images/product-765325.jpg"},"type":{"type":"string","enum":["IMAGE","VIDEO"],"description":"The type of media","example":"IMAGE"},"alt":{"type":"string","description":"Alternative text for the image or video, used for accessibility and SEO","example":"A beautiful red dress on a model"},"width":{"type":"number","description":"Width of the image or video in pixels","example":800},"height":{"type":"number","description":"Height of the image or video in pixels","example":600},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the product image/video was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the product image/video was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","productId","src","type"]},"ProductMetafield":{"type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the metafield in your system","example":"158291"},"productId":{"type":"string","description":"The Unique Identifier of the product this metafield belongs to","example":"458291"},"namespace":{"type":"string","description":"The namespace of the metafield","example":"custom"},"key":{"type":"string","description":"The key of the metafield","example":"careInstructions"},"value":{"type":"string","description":"The value of the metafield","example":"* Wash in cold water only"},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the product metafield was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the product metafield was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","productId","key","value"]},"ProductVariant":{"type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the product variant in your system","example":"6426781"},"productId":{"type":"string","description":"The Unique Identifier of the product this variant belongs to","example":"458291"},"colour":{"type":"string","description":"Colour of the product","example":"Red"},"size":{"type":"string","description":"Category of the product","example":"S"},"weight":{"type":"number","description":"Category of the product","example":0.35},"weightUnit":{"type":"string","enum":["GRAMS","KILOGRAMS","OUNCES","POUNDS"],"description":"The status of the product","example":"KILOGRAMS"},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the product variant was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the product variant was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","productId"]}}},"paths":{"/unstable/analysis":{"get":{"summary":"Get a product analysis","tags":["Analysis"],"description":"Get a product analysis by UUID","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"uuid","required":true,"description":"The UUID of the product analysis"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Product analysis retrieved successfully","content":{"application/json":{"schema":{"description":"Product analysis retrieved successfully","type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"The UUID of the product analysis","example":"550e8400-e29b-41d4-a716-446655440000"},"status":{"type":"string","enum":["started","failed","finalising","complete"],"description":"The current status of the analysis","example":"complete"},"images":{"type":"array","description":"Images to analyse","items":{"type":"object","properties":{"id":{"type":"string","description":"The image identifier"},"url":{"type":"string","format":"uri","description":"The image URL"}},"required":["id","url"]},"example":[{"id":"img_001","url":"https://example.com/photo1.jpg"}]},"result":{"type":"object","nullable":true,"description":"The analysis result containing predicted facets","properties":{"usage":{"type":"object","properties":{"duration":{"type":"number"},"totalTokens":{"type":"number"}}},"output":{"type":"object","properties":{"model":{"type":"string"},"version":{"type":"string"},"provider":{"type":"string"},"prediction":{"type":"object","properties":{"size":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"brand":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"title":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"colour":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"weight":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"category":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"condition":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"description":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"minimumPrice":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"imperfections":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"startingPrice":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"usedCondition":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"imageBestSortOrder":{"type":"array","items":{"type":"number"}},"hasTagsAndPackaging":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}}}},"schemaVersion":{"type":"string"}}}}}},"additionalProperties":false}}}},"400":{"description":"Bad Request - Invalid parameters","content":{"application/json":{"schema":{"description":"Bad Request - Invalid parameters","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}},"401":{"description":"Unauthorized - Invalid or missing API key","content":{"application/json":{"schema":{"description":"Unauthorized - Invalid or missing API key","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}},"403":{"description":"Forbidden - API key does not have access to this resource","content":{"application/json":{"schema":{"description":"Forbidden - API key does not have access to this resource","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}},"404":{"description":"Product analysis not found","content":{"application/json":{"schema":{"description":"Product analysis not found","type":"object","properties":{"error":{"type":"string"}}}}}}}},"post":{"summary":"Create a product analysis","tags":["Analysis"],"description":"Create a product analysis","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"images":{"type":"array","description":"Images to analyse","items":{"type":"object","properties":{"id":{"type":"string","description":"The image identifier"},"url":{"type":"string","format":"uri","description":"The image URL"}},"required":["id","url"]},"example":[{"id":"img_001","url":"https://example.com/photo1.jpg"}]},"async":{"type":"boolean","description":"Whether to process the analysis asynchronously","default":false},"callbackUrl":{"type":"string","format":"uri","description":"The URL to send the analysis result to when processing asynchronously"}},"additionalProperties":false,"required":["images"]}}},"required":true},"security":[{"apiKey":[]}],"responses":{"201":{"description":"Product analysis created successfully","content":{"application/json":{"schema":{"description":"Product analysis created successfully","type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"The UUID of the product analysis","example":"550e8400-e29b-41d4-a716-446655440000"},"status":{"type":"string","enum":["started","failed","finalising","complete"],"description":"The current status of the analysis","example":"complete"},"images":{"type":"array","description":"Images to analyse","items":{"type":"object","properties":{"id":{"type":"string","description":"The image identifier"},"url":{"type":"string","format":"uri","description":"The image URL"}},"required":["id","url"]},"example":[{"id":"img_001","url":"https://example.com/photo1.jpg"}]},"result":{"type":"object","nullable":true,"description":"The analysis result containing predicted facets","properties":{"usage":{"type":"object","properties":{"duration":{"type":"number"},"totalTokens":{"type":"number"}}},"output":{"type":"object","properties":{"model":{"type":"string"},"version":{"type":"string"},"provider":{"type":"string"},"prediction":{"type":"object","properties":{"size":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"brand":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"title":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"colour":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"weight":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"category":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"condition":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"description":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"minimumPrice":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"imperfections":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"startingPrice":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"usedCondition":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}},"imageBestSortOrder":{"type":"array","items":{"type":"number"}},"hasTagsAndPackaging":{"type":"object","properties":{"value":{"type":["null","string","number","boolean"]},"confidence":{"type":"number"}}}}},"schemaVersion":{"type":"string"}}}}}},"additionalProperties":false}}}},"400":{"description":"Bad Request - Invalid parameters","content":{"application/json":{"schema":{"description":"Bad Request - Invalid parameters","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}},"401":{"description":"Unauthorized - Invalid or missing API key","content":{"application/json":{"schema":{"description":"Unauthorized - Invalid or missing API key","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}},"403":{"description":"Forbidden - API key does not have access to this resource","content":{"application/json":{"schema":{"description":"Forbidden - API key does not have access to this resource","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}}}}},"/unstable/customer":{"put":{"summary":"Upsert a customer","tags":["Customer"],"description":"Upsert a customer","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the customer in your system","example":"897835"},"firstName":{"type":"string","description":"First name of the customer","example":"John"},"lastName":{"type":"string","description":"Last name of the customer","example":"Doe"},"email":{"type":"string","format":"email","description":"Email address of the customer","example":"john@doe.com"},"phoneNumber":{"type":"string","description":"Phone number of the customer","example":"+614123465"},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the customer was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the customer was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id"]}}},"required":true},"security":[{"apiKey":[]}],"responses":{"200":{"description":"Customer updated successfully","content":{"application/json":{"schema":{"description":"Customer updated successfully","type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the customer in your system","example":"897835"},"firstName":{"type":"string","description":"First name of the customer","example":"John"},"lastName":{"type":"string","description":"Last name of the customer","example":"Doe"},"email":{"type":"string","format":"email","description":"Email address of the customer","example":"john@doe.com"},"phoneNumber":{"type":"string","description":"Phone number of the customer","example":"+614123465"},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the customer was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the customer was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id"]}}}},"201":{"description":"Customer created successfully","content":{"application/json":{"schema":{"description":"Customer created successfully","type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the customer in your system","example":"897835"},"firstName":{"type":"string","description":"First name of the customer","example":"John"},"lastName":{"type":"string","description":"Last name of the customer","example":"Doe"},"email":{"type":"string","format":"email","description":"Email address of the customer","example":"john@doe.com"},"phoneNumber":{"type":"string","description":"Phone number of the customer","example":"+614123465"},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the customer was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the customer was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id"]}}}},"400":{"description":"Bad Request - Invalid parameters","content":{"application/json":{"schema":{"description":"Bad Request - Invalid parameters","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}},"401":{"description":"Unauthorized - Invalid or missing API key","content":{"application/json":{"schema":{"description":"Unauthorized - Invalid or missing API key","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}},"403":{"description":"Forbidden - API key does not have access to this resource","content":{"application/json":{"schema":{"description":"Forbidden - API key does not have access to this resource","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}}}}},"/unstable/order":{"put":{"summary":"Upsert an order","tags":["Order"],"description":"Upsert an order","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the order in your system","example":"940198"},"customerId":{"type":"string","description":"The Unique Identifier of the customer who placed the order","example":"897835"},"paidStatus":{"type":"string","enum":["PENDING","PARTIALLY_PAID","PARTIALLY_REFUNDED","PAID","REFUNDED","VOIDED"],"description":"The financial status of the order","example":"PAID"},"total":{"type":"number","description":"The total amount of the order","example":149.99},"currencyCode":{"type":"string","description":"The currency code of the order total","example":"USD"},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the order was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the order was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","customerId","paidStatus"]}}},"required":true},"security":[{"apiKey":[]}],"responses":{"200":{"description":"Order updated successfully","content":{"application/json":{"schema":{"description":"Order updated successfully","type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the order in your system","example":"940198"},"customerId":{"type":"string","description":"The Unique Identifier of the customer who placed the order","example":"897835"},"paidStatus":{"type":"string","enum":["PENDING","PARTIALLY_PAID","PARTIALLY_REFUNDED","PAID","REFUNDED","VOIDED"],"description":"The financial status of the order","example":"PAID"},"total":{"type":"number","description":"The total amount of the order","example":149.99},"currencyCode":{"type":"string","description":"The currency code of the order total","example":"USD"},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the order was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the order was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","customerId","paidStatus"]}}}},"201":{"description":"Order created successfully","content":{"application/json":{"schema":{"description":"Order created successfully","type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the order in your system","example":"940198"},"customerId":{"type":"string","description":"The Unique Identifier of the customer who placed the order","example":"897835"},"paidStatus":{"type":"string","enum":["PENDING","PARTIALLY_PAID","PARTIALLY_REFUNDED","PAID","REFUNDED","VOIDED"],"description":"The financial status of the order","example":"PAID"},"total":{"type":"number","description":"The total amount of the order","example":149.99},"currencyCode":{"type":"string","description":"The currency code of the order total","example":"USD"},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the order was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the order was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","customerId","paidStatus"]}}}},"400":{"description":"Bad Request - Invalid parameters","content":{"application/json":{"schema":{"description":"Bad Request - Invalid parameters","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}},"401":{"description":"Unauthorized - Invalid or missing API key","content":{"application/json":{"schema":{"description":"Unauthorized - Invalid or missing API key","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}},"403":{"description":"Forbidden - API key does not have access to this resource","content":{"application/json":{"schema":{"description":"Forbidden - API key does not have access to this resource","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}}}}},"/unstable/order-line-item":{"put":{"summary":"Upsert an order line item","tags":["Order Line Item"],"description":"Upsert an order line item","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the order in your system","example":"599062"},"orderId":{"type":"string","description":"The Unique Identifier of the order this line item belongs to","example":"192382"},"productId":{"type":"string","description":"The Unique Identifier of the product this line item refers to","example":"458291"},"variantId":{"type":"string","description":"The Unique Identifier of the product variant this line item refers to","example":"6426781"},"price":{"type":"number","description":"The price of the line item","example":29.99},"quantity":{"type":"number","description":"The quantity of the product in this line item","example":2},"subTotal":{"type":"number","description":"The subtotal for this line item","example":59.98},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the order line item was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the order line item was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","orderId","productId","variantId","price","quantity","subTotal"]}}},"required":true},"security":[{"apiKey":[]}],"responses":{"200":{"description":"Order updated successfully","content":{"application/json":{"schema":{"description":"Order updated successfully","type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the order in your system","example":"599062"},"orderId":{"type":"string","description":"The Unique Identifier of the order this line item belongs to","example":"192382"},"productId":{"type":"string","description":"The Unique Identifier of the product this line item refers to","example":"458291"},"variantId":{"type":"string","description":"The Unique Identifier of the product variant this line item refers to","example":"6426781"},"price":{"type":"number","description":"The price of the line item","example":29.99},"quantity":{"type":"number","description":"The quantity of the product in this line item","example":2},"subTotal":{"type":"number","description":"The subtotal for this line item","example":59.98},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the order line item was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the order line item was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","orderId","productId","variantId","price","quantity","subTotal"]}}}},"201":{"description":"Order created successfully","content":{"application/json":{"schema":{"description":"Order created successfully","type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the order in your system","example":"599062"},"orderId":{"type":"string","description":"The Unique Identifier of the order this line item belongs to","example":"192382"},"productId":{"type":"string","description":"The Unique Identifier of the product this line item refers to","example":"458291"},"variantId":{"type":"string","description":"The Unique Identifier of the product variant this line item refers to","example":"6426781"},"price":{"type":"number","description":"The price of the line item","example":29.99},"quantity":{"type":"number","description":"The quantity of the product in this line item","example":2},"subTotal":{"type":"number","description":"The subtotal for this line item","example":59.98},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the order line item was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the order line item was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","orderId","productId","variantId","price","quantity","subTotal"]}}}},"400":{"description":"Bad Request - Invalid parameters","content":{"application/json":{"schema":{"description":"Bad Request - Invalid parameters","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}},"401":{"description":"Unauthorized - Invalid or missing API key","content":{"application/json":{"schema":{"description":"Unauthorized - Invalid or missing API key","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}},"403":{"description":"Forbidden - API key does not have access to this resource","content":{"application/json":{"schema":{"description":"Forbidden - API key does not have access to this resource","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}}}}},"/unstable/product":{"put":{"summary":"Upsert a product","tags":["Product"],"description":"Upsert a product","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the product in your system","example":"458291"},"title":{"type":"string","description":"Title of the product","example":"Silk Wrap Dress"},"handle":{"type":"string","description":"A slug identifying the product in kebab-case format","pattern":"^[a-z0-9]+(-[a-z0-9]+)*$","example":"silk-wrap-dress"},"status":{"type":"string","enum":["ACTIVE","DRAFT","ARCHIVED"],"description":"The status of the product","example":"ACTIVE"},"category":{"type":"string","description":"Category of the product","example":"Dresses"},"description":{"type":"string","description":"Description of the product","example":"A beautiful silk wrap dress perfect for summer."},"vendor":{"type":"string","description":"The vendor of the product","example":"Sportsgirl"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags associated with the product","example":["summer","dress","onsale","nodiscount"]},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the product was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the product was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","title","handle","status"]}}},"required":true},"security":[{"apiKey":[]}],"responses":{"200":{"description":"Product updated successfully","content":{"application/json":{"schema":{"description":"Product updated successfully","type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the product in your system","example":"458291"},"title":{"type":"string","description":"Title of the product","example":"Silk Wrap Dress"},"handle":{"type":"string","description":"A slug identifying the product in kebab-case format","pattern":"^[a-z0-9]+(-[a-z0-9]+)*$","example":"silk-wrap-dress"},"status":{"type":"string","enum":["ACTIVE","DRAFT","ARCHIVED"],"description":"The status of the product","example":"ACTIVE"},"category":{"type":"string","description":"Category of the product","example":"Dresses"},"description":{"type":"string","description":"Description of the product","example":"A beautiful silk wrap dress perfect for summer."},"vendor":{"type":"string","description":"The vendor of the product","example":"Sportsgirl"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags associated with the product","example":["summer","dress","onsale","nodiscount"]},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the product was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the product was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","title","handle","status"]}}}},"201":{"description":"Product created successfully","content":{"application/json":{"schema":{"description":"Product created successfully","type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the product in your system","example":"458291"},"title":{"type":"string","description":"Title of the product","example":"Silk Wrap Dress"},"handle":{"type":"string","description":"A slug identifying the product in kebab-case format","pattern":"^[a-z0-9]+(-[a-z0-9]+)*$","example":"silk-wrap-dress"},"status":{"type":"string","enum":["ACTIVE","DRAFT","ARCHIVED"],"description":"The status of the product","example":"ACTIVE"},"category":{"type":"string","description":"Category of the product","example":"Dresses"},"description":{"type":"string","description":"Description of the product","example":"A beautiful silk wrap dress perfect for summer."},"vendor":{"type":"string","description":"The vendor of the product","example":"Sportsgirl"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags associated with the product","example":["summer","dress","onsale","nodiscount"]},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the product was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the product was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","title","handle","status"]}}}},"400":{"description":"Bad Request - Invalid parameters","content":{"application/json":{"schema":{"description":"Bad Request - Invalid parameters","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}},"401":{"description":"Unauthorized - Invalid or missing API key","content":{"application/json":{"schema":{"description":"Unauthorized - Invalid or missing API key","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}},"403":{"description":"Forbidden - API key does not have access to this resource","content":{"application/json":{"schema":{"description":"Forbidden - API key does not have access to this resource","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}}}}},"/unstable/product-media":{"put":{"summary":"Upsert a product image or video","tags":["Product Media"],"description":"Upsert a product image or video","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the image or video in your system","example":"765325"},"productId":{"type":"string","description":"The Unique Identifier of the product this media belongs to","example":"458291"},"src":{"type":"string","format":"uri","description":"The URL of the image or video","example":"https://mydomain.com/images/product-765325.jpg"},"type":{"type":"string","enum":["IMAGE","VIDEO"],"description":"The type of media","example":"IMAGE"},"alt":{"type":"string","description":"Alternative text for the image or video, used for accessibility and SEO","example":"A beautiful red dress on a model"},"width":{"type":"number","description":"Width of the image or video in pixels","example":800},"height":{"type":"number","description":"Height of the image or video in pixels","example":600},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the product image/video was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the product image/video was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","productId","src","type"]}}},"required":true},"security":[{"apiKey":[]}],"responses":{"200":{"description":"Product media updated successfully","content":{"application/json":{"schema":{"description":"Product media updated successfully","type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the image or video in your system","example":"765325"},"productId":{"type":"string","description":"The Unique Identifier of the product this media belongs to","example":"458291"},"src":{"type":"string","format":"uri","description":"The URL of the image or video","example":"https://mydomain.com/images/product-765325.jpg"},"type":{"type":"string","enum":["IMAGE","VIDEO"],"description":"The type of media","example":"IMAGE"},"alt":{"type":"string","description":"Alternative text for the image or video, used for accessibility and SEO","example":"A beautiful red dress on a model"},"width":{"type":"number","description":"Width of the image or video in pixels","example":800},"height":{"type":"number","description":"Height of the image or video in pixels","example":600},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the product image/video was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the product image/video was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","productId","src","type"]}}}},"201":{"description":"Product media created successfully","content":{"application/json":{"schema":{"description":"Product media created successfully","type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the image or video in your system","example":"765325"},"productId":{"type":"string","description":"The Unique Identifier of the product this media belongs to","example":"458291"},"src":{"type":"string","format":"uri","description":"The URL of the image or video","example":"https://mydomain.com/images/product-765325.jpg"},"type":{"type":"string","enum":["IMAGE","VIDEO"],"description":"The type of media","example":"IMAGE"},"alt":{"type":"string","description":"Alternative text for the image or video, used for accessibility and SEO","example":"A beautiful red dress on a model"},"width":{"type":"number","description":"Width of the image or video in pixels","example":800},"height":{"type":"number","description":"Height of the image or video in pixels","example":600},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the product image/video was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the product image/video was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","productId","src","type"]}}}},"400":{"description":"Bad Request - Invalid parameters","content":{"application/json":{"schema":{"description":"Bad Request - Invalid parameters","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}},"401":{"description":"Unauthorized - Invalid or missing API key","content":{"application/json":{"schema":{"description":"Unauthorized - Invalid or missing API key","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}},"403":{"description":"Forbidden - API key does not have access to this resource","content":{"application/json":{"schema":{"description":"Forbidden - API key does not have access to this resource","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}}}}},"/unstable/product-metafield":{"put":{"summary":"Upsert a product metafield","tags":["Product Metafield"],"description":"Upsert a product metafield","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the metafield in your system","example":"158291"},"productId":{"type":"string","description":"The Unique Identifier of the product this metafield belongs to","example":"458291"},"namespace":{"type":"string","description":"The namespace of the metafield","example":"custom"},"key":{"type":"string","description":"The key of the metafield","example":"careInstructions"},"value":{"type":"string","description":"The value of the metafield","example":"* Wash in cold water only"},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the product metafield was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the product metafield was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","productId","key","value"]}}},"required":true},"security":[{"apiKey":[]}],"responses":{"200":{"description":"Product metafield updated successfully","content":{"application/json":{"schema":{"description":"Product metafield updated successfully","type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the metafield in your system","example":"158291"},"productId":{"type":"string","description":"The Unique Identifier of the product this metafield belongs to","example":"458291"},"namespace":{"type":"string","description":"The namespace of the metafield","example":"custom"},"key":{"type":"string","description":"The key of the metafield","example":"careInstructions"},"value":{"type":"string","description":"The value of the metafield","example":"* Wash in cold water only"},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the product metafield was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the product metafield was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","productId","key","value"]}}}},"201":{"description":"Product metafield created successfully","content":{"application/json":{"schema":{"description":"Product metafield created successfully","type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the metafield in your system","example":"158291"},"productId":{"type":"string","description":"The Unique Identifier of the product this metafield belongs to","example":"458291"},"namespace":{"type":"string","description":"The namespace of the metafield","example":"custom"},"key":{"type":"string","description":"The key of the metafield","example":"careInstructions"},"value":{"type":"string","description":"The value of the metafield","example":"* Wash in cold water only"},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the product metafield was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the product metafield was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","productId","key","value"]}}}},"400":{"description":"Bad Request - Invalid parameters","content":{"application/json":{"schema":{"description":"Bad Request - Invalid parameters","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}},"401":{"description":"Unauthorized - Invalid or missing API key","content":{"application/json":{"schema":{"description":"Unauthorized - Invalid or missing API key","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}},"403":{"description":"Forbidden - API key does not have access to this resource","content":{"application/json":{"schema":{"description":"Forbidden - API key does not have access to this resource","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}}}}},"/unstable/product-variant":{"put":{"summary":"Upsert a product variant","tags":["Product Variant"],"description":"Upsert a product variant","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the product variant in your system","example":"6426781"},"productId":{"type":"string","description":"The Unique Identifier of the product this variant belongs to","example":"458291"},"colour":{"type":"string","description":"Colour of the product","example":"Red"},"size":{"type":"string","description":"Category of the product","example":"S"},"weight":{"type":"number","description":"Category of the product","example":0.35},"weightUnit":{"type":"string","enum":["GRAMS","KILOGRAMS","OUNCES","POUNDS"],"description":"The status of the product","example":"KILOGRAMS"},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the product variant was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the product variant was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","productId"]}}},"required":true},"security":[{"apiKey":[]}],"responses":{"200":{"description":"Product variant updated successfully","content":{"application/json":{"schema":{"description":"Product variant updated successfully","type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the product variant in your system","example":"6426781"},"productId":{"type":"string","description":"The Unique Identifier of the product this variant belongs to","example":"458291"},"colour":{"type":"string","description":"Colour of the product","example":"Red"},"size":{"type":"string","description":"Category of the product","example":"S"},"weight":{"type":"number","description":"Category of the product","example":0.35},"weightUnit":{"type":"string","enum":["GRAMS","KILOGRAMS","OUNCES","POUNDS"],"description":"The status of the product","example":"KILOGRAMS"},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the product variant was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the product variant was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","productId"]}}}},"201":{"description":"Product variant created successfully","content":{"application/json":{"schema":{"description":"Product variant created successfully","type":"object","properties":{"id":{"type":"string","description":"The Unique Identifier of the product variant in your system","example":"6426781"},"productId":{"type":"string","description":"The Unique Identifier of the product this variant belongs to","example":"458291"},"colour":{"type":"string","description":"Colour of the product","example":"Red"},"size":{"type":"string","description":"Category of the product","example":"S"},"weight":{"type":"number","description":"Category of the product","example":0.35},"weightUnit":{"type":"string","enum":["GRAMS","KILOGRAMS","OUNCES","POUNDS"],"description":"The status of the product","example":"KILOGRAMS"},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the product variant was created in your system","example":"2023-10-01T12:12:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the product variant was updated in your system","example":"2023-10-01T18:38:00Z"}},"additionalProperties":false,"required":["id","productId"]}}}},"400":{"description":"Bad Request - Invalid parameters","content":{"application/json":{"schema":{"description":"Bad Request - Invalid parameters","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}},"401":{"description":"Unauthorized - Invalid or missing API key","content":{"application/json":{"schema":{"description":"Unauthorized - Invalid or missing API key","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}},"403":{"description":"Forbidden - API key does not have access to this resource","content":{"application/json":{"schema":{"description":"Forbidden - API key does not have access to this resource","type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}}}}}},"servers":[{"url":"https://api.authentified.co","description":"Production"},{"url":"https://authentified--development.gadget.app/rest-api","description":"Development"}],"tags":[{"name":"Analysis","description":"The Analysis resource lets you create and retrieve product analyses."},{"name":"Customer","description":"The Customer resource lets you update and create customers."},{"name":"Order","description":"The Order resource lets you update and create orders."},{"name":"Order Line Item","description":"The Order Line Item resource lets you update and create order line items."},{"name":"Product","description":"The Product resource lets you update and create products."},{"name":"Product Variant","description":"The Product Variant resource lets you update and create product variants, for example different sizes or colours of the same product."},{"name":"Product Media","description":"The Product Media resource lets you update and create product images or videos."},{"name":"Product Metafield","description":"The Product Metafield resource lets you update and create product metadata, such as sizing information, care instructions or other custom fields."}],"x-tagGroups":[{"name":"Analysis","tags":["Analysis"]},{"name":"Customers","tags":["Customer"]},{"name":"Orders","tags":["Order","Order Line Item"]},{"name":"Products","tags":["Product","Product Media","Product Metafield","Product Variant"]}]}