{"openapi":"3.1.0","info":{"title":"Webflow Data API","version":"1.0.0"},"paths":{"/user":{"get":{"operationId":"meta_get-authorized-user","summary":"Authorized User","description":"Basic information about the authorized user.","tags":["meta"],"parameters":[{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizedUser"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"OAuth2":[]}]}},"/info":{"get":{"operationId":"meta_get-authorized-info","summary":"Authorized Info","description":"Basic information about the authorization being used.","tags":["meta"],"parameters":[{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Authorization"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"OAuth2":[]}]}},"/sites":{"get":{"operationId":"sites_list-sites","summary":"List Sites","description":"List of all sites the provided access token is able to access.","tags":["sites"],"parameters":[{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Site"}}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"OAuth2":[]}]}},"/sites/{site_id}":{"get":{"operationId":"sites_get-site","summary":"Get Site","description":"Get a site by site id","tags":["sites"],"parameters":[{"name":"site_id","in":"path","description":"Unique identifier for a Site","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"OAuth2":[]}]}},"/sites/{site_id}/publish":{"post":{"operationId":"sites_publish-site","summary":"Publish Site","description":"Publish a site","tags":["sites"],"parameters":[{"name":"site_id","in":"path","description":"Unique identifier for a Site","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishedSite"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"The domains to publish","content":{"application/json":{"schema":{"type":"object","properties":{"domains":{"type":"array","items":{"type":"string"},"description":"An array of domains that should be published"}},"required":["domains"]}}}},"security":[{"OAuth2":[]}]}},"/sites/{site_id}/domains":{"get":{"operationId":"sites_list-domains","summary":"List Domains","description":"List of all custom domains added to a given site","tags":["sites"],"parameters":[{"name":"site_id","in":"path","description":"Unique identifier for a Site","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Domain"}}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"OAuth2":[]}]}},"/sites/{site_id}/webhooks":{"get":{"operationId":"webhooks_list-webhooks","summary":"List Webhooks","description":"List of all webhooks in a given site","tags":["webhooks"],"parameters":[{"name":"site_id","in":"path","description":"Unique identifier for a Site","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"}}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"OAuth2":[]}]},"post":{"operationId":"webhooks_create-webhook","summary":"Create Webhook","description":"Create a new webhook","tags":["webhooks"],"parameters":[{"name":"site_id","in":"path","description":"Unique identifier for a Site","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"The webhook item to create","content":{"application/json":{"schema":{"type":"object","properties":{"triggerType":{"$ref":"#/components/schemas/TriggerType"},"url":{"type":"string","format":"uri","description":"The https URL on your server the webhook will send a request to when the webhook is triggered\n"},"filter":{"$ref":"#/components/schemas/SitesSiteIdWebhooksPostRequestBodyContentApplicationJsonSchemaFilter","description":"filter for selecting which events you want webhooks to be triggered for.\n** Only available for `form_submission` trigger types.\n"}},"required":["triggerType","url"]}}}},"security":[{"OAuth2":[]}]}},"/sites/{site_id}/webhooks/{webhook_id}":{"get":{"operationId":"webhooks_get-webhook","summary":"Get Webhook","description":"Get a site webhook","tags":["webhooks"],"parameters":[{"name":"site_id","in":"path","description":"Unique identifier for a Site","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"webhook_id","in":"path","description":"Unique identifier for a Webhook","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"OAuth2":[]}]},"delete":{"operationId":"webhooks_removeWebhook","summary":"Remove Webhook","description":"Remove a webhook","tags":["webhooks"],"parameters":[{"name":"site_id","in":"path","description":"Unique identifier for a Site","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"webhook_id","in":"path","description":"Unique identifier for a Webhook","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteResult"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"OAuth2":[]}]}},"/sites/{site_id}/collections":{"get":{"operationId":"collections_list-collections","summary":"List Collections","description":"List of all collections in a given site","tags":["collections"],"parameters":[{"name":"site_id","in":"path","description":"Unique identifier for a Site","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Collection"}}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"OAuth2":[]}]}},"/collections/{collection_id}":{"get":{"operationId":"collections_get-collection","summary":"Get Collection","description":"Get a collection by collection id","tags":["collections"],"parameters":[{"name":"collection_id","in":"path","description":"Unique identifier for a Collection","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collection"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"OAuth2":[]}]}},"/collections/{collection_id}/items":{"get":{"operationId":"items_list-items","summary":"List Collection Items","description":"Get all items for a collection","tags":["items"],"parameters":[{"name":"collection_id","in":"path","description":"Unique identifier for a Collection","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"offset","in":"query","description":"Offset used for pagination if the results have more than limit records","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Maximum number of records to be returned (max limit: 100)","required":false,"schema":{"type":"integer"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionItemList"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"OAuth2":[]}]},"post":{"operationId":"items_create-item","summary":"Create Collection Item","description":"Create a new collection item. </br></br> To upload a new image to an attachment field, set the field value to the image URL. To reuse an existing image from a collection, set the field value to the fileId property.\n","tags":["items"],"parameters":[{"name":"collection_id","in":"path","description":"Unique identifier for a Collection","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"live","in":"query","description":"Boolean indicating if the item(s) should be published/unpublished to/from the live site","required":false,"schema":{"type":"boolean"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionItem"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"The collection item to create","content":{"application/json":{"schema":{"type":"object","properties":{"fields":{"$ref":"#/components/schemas/Field","description":"The fields for the new item"}}}}}},"security":[{"OAuth2":[]}]},"delete":{"operationId":"items_remove-items","summary":"Remove Collection Items","description":"Remove or unpublish items in a collection.\n<aside class=\"notice\"><b>Remove Item</b><br/> The default behavior of the endpoint will delete the item from collection. You cannot retrieve a deleted item. <br/><br/>\n<aside class=\"notice\"><b>Unpublish Item</b><br/> It is possible to only remove the item from the published site, while maintaining it in your collection. Unpublishing an item will set the item status to Draft. <br/><br/> Append <code>?live=true</code> to the querystring to unpublish an item</aside>\n","tags":["items"],"parameters":[{"name":"collection_id","in":"path","description":"Unique identifier for a Collection","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"live","in":"query","description":"Boolean indicating if the item(s) should be published/unpublished to/from the live site","required":false,"schema":{"type":"boolean"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemovedItems"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"The collection item ids to delete or unpublish","content":{"application/json":{"schema":{"type":"object","properties":{"itemIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Array of item ids to delete or unpublish"}}}}}},"security":[{"OAuth2":[]}]}},"/collections/{collection_id}/items/publish":{"put":{"operationId":"items_publish-items","summary":"Publish Collection Items","description":"Publish items in a Collection.\n","tags":["items"],"parameters":[{"name":"collection_id","in":"path","description":"Unique identifier for a Collection","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishedItems"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"The collection item ids to publish","content":{"application/json":{"schema":{"type":"object","properties":{"itemIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Array of item ids to publish"}}}}}},"security":[{"OAuth2":[]}]}},"/collections/{collection_id}/items/{item_id}":{"get":{"operationId":"items_get-item","summary":"Get Collection Item","description":"Get an item in a collection","tags":["items"],"parameters":[{"name":"collection_id","in":"path","description":"Unique identifier for a Collection","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"item_id","in":"path","description":"Unique identifier for and Item","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionItemList"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"OAuth2":[]}]},"put":{"operationId":"items_update-item","summary":"Update Collection Item","description":"Update an existing collection item. To upload a new image set the image URL to the corresponding item's field. Collection items that reuse images previously uploaded can just reference their fileId property.\n","tags":["items"],"parameters":[{"name":"collection_id","in":"path","description":"Unique identifier for a Collection","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"item_id","in":"path","description":"Unique identifier for and Item","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"live","in":"query","description":"Boolean indicating if the item(s) should be published/unpublished to/from the live site","required":false,"schema":{"type":"boolean"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionItem"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"The item to update","content":{"application/json":{"schema":{"type":"object","properties":{"fields":{"$ref":"#/components/schemas/Field"}},"required":["fields"]}}}},"security":[{"OAuth2":[]}]},"delete":{"operationId":"items_remove-item","summary":"Remove Collection Item","description":"Remove or unpublish an item in a collection.\n<aside class=\"notice\"><b>Remove Item</b><br/> The default behavior of the endpoint will delete the item from collection. You cannot retrieve a deleted item. <br/><br/>\n<aside class=\"notice\"><b>Unpublish Item</b><br/> It is possible to only remove the item from the published site, while maintaining it in your collection. Unpublishing an item will set the item status to Draft. <br/><br/> Append <code>?live=true</code> to the querystring to unpublish an item</aside>\n","tags":["items"],"parameters":[{"name":"collection_id","in":"path","description":"Unique identifier for a Collection","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"item_id","in":"path","description":"Unique identifier for and Item","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"live","in":"query","description":"Boolean indicating if the item(s) should be published/unpublished to/from the live site","required":false,"schema":{"type":"boolean"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteResult"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"OAuth2":[]}]},"patch":{"operationId":"items_patch-item","summary":"Patch Collection Item","description":"Update only fields that need to be changed. To upload a new image set the image URL to the corresponding item's field. Collection items that reuse images previously uploaded can just reference their fileId property.\n","tags":["items"],"parameters":[{"name":"collection_id","in":"path","description":"Unique identifier for a Collection","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"item_id","in":"path","description":"Unique identifier for and Item","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"live","in":"query","description":"Boolean indicating if the item(s) should be published/unpublished to/from the live site","required":false,"schema":{"type":"boolean"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionItem"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"The item to update","content":{"application/json":{"schema":{"type":"object","properties":{"fields":{"$ref":"#/components/schemas/Field"}}}}}},"security":[{"OAuth2":[]}]}},"/sites/{site_id}/products":{"get":{"operationId":"productsSkUs_list-products","summary":"List Products & SKUs","description":"Retrieve all products for a site. Use `limit` and `offset` to page through all products with subsequent requests. All SKUs for each product will also be fetched and returned. The `count`, `limit` and `offset` and `total` values represent Products only and do not include any SKUs.\n","tags":["productsSkUs"],"parameters":[{"name":"site_id","in":"path","description":"Unique identifier for a Site","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"offset","in":"query","description":"Offset used for pagination if the results have more than limit records","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Maximum number of records to be returned (max limit: 100)","required":false,"schema":{"type":"integer"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductList"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"OAuth2":[]}]},"post":{"operationId":"productsSkUs_create-product","summary":"Create Product & SKU","description":"Adding a new Product involves creating both a Product Item and a SKU Item, since a Product Item has to have, at minimum, a SKU Item.\n\nTo create a new Product with multiple SKUs, you must:\n\n- Create the Product and Default SKU using this endpoint, making sure to add `sku-properties` in the product data.\n- You can't add `sku-values` to the SKU yet, since there are no enum IDs created yet. When this endpoint returns, it will have IDs filled in for the `sku-properties` enums.\n- With those IDs, update the default SKU with valid `sku-values` and create any additional SKUs (if needed), with valid `sku-values`.\n- You can also create the Product without `sku-properties` and add them in later.\n- If you add any `sku` properties, the default SKU will default to the first value of each option.\n\nUpon creation, the default product type will be `Advanced`. The product type is used to determine which Product and SKU fields are shown to users in the `Designer` and the `Editor`. Setting it to `Advanced` ensures that all Product and SKU fields will be shown. The product type can be edited in the `Designer` or the `Editor`.\n","tags":["productsSkUs"],"parameters":[{"name":"site_id","in":"path","description":"Unique identifier for a Site","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSKU"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"The product and sku to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSKU"}}}},"security":[{"OAuth2":[]}]}},"/sites/{site_id}/products/{product_id}":{"get":{"operationId":"productsSkUs_get-product","summary":"Get Product and SKUs","description":"Retrieve a single product by its ID. All of its SKUs will also be retrieved. The `count`, `limit`, `offset`\nand `total` values in the response represent the Product only and do not include SKUs.\n","tags":["productsSkUs"],"parameters":[{"name":"site_id","in":"path","description":"Unique identifier for a Site","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"product_id","in":"path","description":"Unique identifier for a Product","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSKUList"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"OAuth2":[]}]},"patch":{"operationId":"productsSkUs_update-product","summary":"Update Product","description":"Updating an existing Product will set the product type to `Advanced`. The product type is used to determine which Product and SKU fields are shown to users in the `Designer` and the `Editor`. Setting it to `Advanced` ensures that all Product and SKU fields will be shown. The product type can be edited in the `Designer` or the `Editor`.\n","tags":["productsSkUs"],"parameters":[{"name":"site_id","in":"path","description":"Unique identifier for a Site","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"product_id","in":"path","description":"Unique identifier for a Product","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"The product to update","content":{"application/json":{"schema":{"type":"object","properties":{"fields":{"$ref":"#/components/schemas/Field"}}}}}},"security":[{"OAuth2":[]}]}},"/sites/{site_id}/products/{product_id}/skus":{"post":{"operationId":"productsSkUs_create-skus","summary":"Create SKU","description":"Create additional SKUs to cover every variant of your Product. The Default SKU already counts as one of the variants.\n\nCreating additional SKUs will set the product type to `Advanced` for the product associated with the SKUs. The product type is used to determine which Product and SKU fields are shown to users in the `Designer` and the `Editor`. Setting it to `Advanced` ensures that all Product and SKU fields will be shown. The product type can be edited in the `Designer` or the `Editor`.\n","tags":["productsSkUs"],"parameters":[{"name":"site_id","in":"path","description":"Unique identifier for a Site","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"product_id","in":"path","description":"Unique identifier for a Product","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SKUList"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"The SKUs to add","content":{"application/json":{"schema":{"type":"object","properties":{"skus":{"type":"array","items":{"$ref":"#/components/schemas/SKU"},"description":"An array of the SKU data your are adding"}}}}}},"security":[{"OAuth2":[]}]}},"/sites/{site_id}/products/{product_id}/skus/{sku_id}":{"patch":{"operationId":"productsSkUs_update-sku","summary":"Update SKU","description":"Updating an existing SKU will set the product type to `Advanced` for the product associated with the SKU. The product type is used to determine which Product and SKU fields are shown to users in the `Designer` and the `Editor`. Setting it to `Advanced` ensures that all Product and SKU fields will be shown. The product type can be edited in the `Designer` or the `Editor`.\n","tags":["productsSkUs"],"parameters":[{"name":"site_id","in":"path","description":"Unique identifier for a Site","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"product_id","in":"path","description":"Unique identifier for a Product","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"sku_id","in":"path","description":"Unique identifier for a SKU","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SKU"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"The SKU to update","content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"$ref":"#/components/schemas/SKU"}}}}}},"security":[{"OAuth2":[]}]}},"/sites/{site_id}/orders":{"get":{"operationId":"orders_list-orders","summary":"List Orders","description":"List all orders created for a given site.","tags":["orders"],"parameters":[{"name":"site_id","in":"path","description":"Unique identifier for a Site","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"status","in":"query","description":"Filter the orders by status","required":false,"schema":{"$ref":"#/components/schemas/SitesSiteIdOrdersGetParametersStatus"}},{"name":"offset","in":"query","description":"Offset used for pagination if the results have more than limit records","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Maximum number of records to be returned (max limit: 100)","required":false,"schema":{"type":"integer"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Order"}}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"OAuth2":[]}]}},"/sites/{site_id}/order/{order_id}":{"get":{"operationId":"orders_get-order","summary":"Get Order","description":"Retrieve a single product by its ID. All of its SKUs will also be retrieved. The `count`, `limit`, `offset`\nand `total` values in the response represent the Product only and do not include SKUs.\n","tags":["orders"],"parameters":[{"name":"site_id","in":"path","description":"Unique identifier for a Site","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"order_id","in":"path","description":"Unique identifier for an Order","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"OAuth2":[]}]},"patch":{"operationId":"orders_update-order","summary":"Update Order","description":"This API lets you update the fields, `comment`, `shippingProvider`, and/or\n`shippingTracking` for a given order. All three fields can be updated\nsimultaneously or independently.\n","tags":["orders"],"parameters":[{"name":"site_id","in":"path","description":"Unique identifier for a Site","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"order_id","in":"path","description":"Unique identifier for an Order","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"The order fields to update","content":{"application/json":{"schema":{"type":"object","properties":{"fields":{"$ref":"#/components/schemas/SitesSiteIdOrderOrderIdPatchRequestBodyContentApplicationJsonSchemaFields"}}}}}},"security":[{"OAuth2":[]}]}},"/sites/{site_id}/order/{order_id}/fulfill":{"post":{"operationId":"orders_fulfill-order","summary":"Fulfill Order","description":"Updates an order's status to fulfilled","tags":["orders"],"parameters":[{"name":"site_id","in":"path","description":"Unique identifier for a Site","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"order_id","in":"path","description":"Unique identifier for an Order","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"The order fulfillment request","content":{"application/json":{"schema":{"type":"object","properties":{"sendOrderFulfilledEmail":{"type":"boolean","default":false,"description":"Whether or not the Order Fulfilled email should be sent"}}}}}},"security":[{"OAuth2":[]}]}},"/sites/{site_id}/order/{order_id}/unfulfill":{"post":{"operationId":"orders_unfulfill-order","summary":"Unfulfill Order","description":"Updates an order's status to unfulfilled","tags":["orders"],"parameters":[{"name":"site_id","in":"path","description":"Unique identifier for a Site","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"order_id","in":"path","description":"Unique identifier for an Order","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"OAuth2":[]}]}},"/sites/{site_id}/order/{order_id}/refund":{"post":{"operationId":"orders_refund-order","summary":"Refund Order","description":"This API will reverse a Stripe charge and refund an order back to a\ncustomer. It will also set the order's status to `refunded`.\n","tags":["orders"],"parameters":[{"name":"site_id","in":"path","description":"Unique identifier for a Site","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"order_id","in":"path","description":"Unique identifier for an Order","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"OAuth2":[]}]}},"/collections/{collection_id}/items/{item_id}/inventory":{"get":{"operationId":"inventory_list-inventory","summary":"List Inventory","description":"List the current inventory levels for a particular SKU item.","tags":["inventory"],"parameters":[{"name":"collection_id","in":"path","description":"Unique identifier for a Collection","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"item_id","in":"path","description":"Unique identifier for and Item","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryItem"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"OAuth2":[]}]},"patch":{"operationId":"inventory_update-inventory","summary":"Update Item Inventory","description":"Updates the current inventory levels for a particular SKU item. Updates may be\ngiven in one or two methods, absolutely or incrementally. Absolute updates\nare done by setting `quantity` directly. Incremental updates are by specifying\nthe inventory delta in `updateQuantity` which is then added to the `quantity`\nstored on the server.\n","tags":["inventory"],"parameters":[{"name":"collection_id","in":"path","description":"Unique identifier for a Collection","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"item_id","in":"path","description":"Unique identifier for and Item","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryItem"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"The updated inventory","content":{"application/json":{"schema":{"type":"object","properties":{"fields":{"$ref":"#/components/schemas/CollectionsCollectionIdItemsItemIdInventoryPatchRequestBodyContentApplicationJsonSchemaFields","description":"The inventory fields to update"}}}}}},"security":[{"OAuth2":[]}]}},"/sites/{site_id}/ecommerce/settings":{"get":{"operationId":"settings_ecommerce-settings","summary":"Get Ecommerce Settings","description":"Retrieve ecommerce settings for a site.","tags":["settings"],"parameters":[{"name":"site_id","in":"path","description":"Unique identifier for a Site","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Version","in":"header","description":"The API version","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EcommerceSettings"}}}},"400":{"description":"Request body was incorrectly formatted. Likely invalid JSON being sent up.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Provided access token is invalid or does not have access to requested resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"429":{"description":"The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"We had a problem with our server. Try again later.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"OAuth2":[]}]}}},"tags":[{"name":"meta"},{"name":"sites"},{"name":"webhooks"},{"name":"collections"},{"name":"items"},{"name":"productsSkUs"},{"name":"orders"},{"name":"inventory"},{"name":"settings"}],"servers":[{"url":"https://api.webflow.com","description":"https://api.webflow.com"}],"webhooks":{"sites_form_submission":{"post":{"operationId":"sites_form_submission","summary":"Form Submission","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"description":"The form data submitted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormSubmission"}}}}}},"sites_site_publish":{"post":{"operationId":"sites_site_publish","summary":"Site Publish","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"description":"The information about the site(s) published","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitePublish"}}}}}},"items_collection_item_created":{"post":{"operationId":"items_collection_item_created","summary":"Item Created","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"description":"The information about the collection item that was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionItem"}}}}}},"items_collection_item_changed":{"post":{"operationId":"items_collection_item_changed","summary":"Item Updated","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"description":"The information about the collection item that was changed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionItem"}}}}}},"items_collection_item_deleted":{"post":{"operationId":"items_collection_item_deleted","summary":"Item Deleted","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"description":"The results from deleting the collection item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionItemRemoved"}}}}}},"items_collection_item_unpublished":{"post":{"operationId":"items_collection_item_unpublished","summary":"Item Unpublished","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"description":"The results from unpublishing the collection item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionItemRemoved"}}}}}},"orders_ecomm_new_order":{"post":{"operationId":"orders_ecomm_new_order","summary":"New eComm Order","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"description":"The information about the new order","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}}}},"orders_ecomm_order_changed":{"post":{"operationId":"orders_ecomm_order_changed","summary":"Updated eComm Order","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"description":"The information about the order that changed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}}}},"inventory_ecomm_inventory_changed":{"post":{"operationId":"inventory_ecomm_inventory_changed","summary":"Updated eComm Inventory","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"description":"The information about the inventory item that changed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryItem"}}}}}}},"components":{"schemas":{"AuthorizedUser":{"type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"The uniqueID of the user"},"email":{"type":"string","format":"email","description":"The user's email address"},"firstName":{"type":"string","description":"The user's first name"},"lastName":{"type":"string","description":"The user's last name"}},"title":"AuthorizedUser"},"Application":{"type":"object","properties":{"_id":{"type":"string","format":"uuid"},"description":{"type":"string"},"homepage":{"type":"string","format":"uri"},"name":{"type":"string"},"owner":{"type":"string"},"ownerType":{"type":"string"}},"title":"Application"},"Authorization":{"type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"The uniqueID of the authorization"},"createdOn":{"type":"string","format":"date-time","description":"The date the authorization was created"},"grantType":{"type":"string","description":"The grant type of the authorization"},"lastUsed":{"type":"string","format":"date-time","description":"The date the authorization was last used"},"sites":{"type":"array","items":{"type":"string"},"description":"The sites authorized"},"orgs":{"type":"array","items":{"type":"string"},"description":"The organizations authorized"},"workspaces":{"type":"array","items":{"type":"string"},"description":"The workspaces authorized"},"users":{"type":"array","items":{"type":"string"},"description":"The users authorized"},"rateLimit":{"type":"integer","description":"The default rate limit for the authorization"},"status":{"type":"string","description":"The status of the authorization"},"application":{"$ref":"#/components/schemas/Application"}},"title":"Authorization"},"Site":{"type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"Unique identifier for site"},"createdOn":{"type":"string","format":"date-time","description":"Date the site was created"},"name":{"type":"string","description":"Name given to site"},"shortName":{"type":"string","description":"Slugified version of name"},"lastPublished":{"type":"string","format":"date-time","description":"Date site was last published"},"previewUrl":{"type":"string","format":"uri","description":"URL of a generated image for the given site"},"timezone":{"type":"string","description":"Site timezone set under Site Settings"}},"required":["_id"],"title":"Site"},"PublishedSite":{"type":"object","properties":{"queued":{"type":"boolean","description":"Indicates if the site has been queued for publish"}},"required":["queued"],"title":"PublishedSite"},"Domain":{"type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"Unique identifier for domain"},"name":{"type":"string","description":"The domain name"}},"required":["_id"],"title":"Domain"},"TriggerType":{"type":"string","enum":["form_submission","site_publish","ecomm_new_order","ecomm_order_changed","ecomm_inventory_changed","collection_item_created","collection_item_changed","collection_item_deleted","collection_item_unpublished","comment_created"],"description":"* `form_submission` - Sends the [form_submission](#form_submission) event\n* `site_publish` - Sends a [site_publish](#site_publish) event\n* `ecomm_new_order` - Sends the new [ecomm_new_order](#ecomm_new_order) event\n* `ecomm_order_changed` - Sends the [ecomm_order_changed](#ecomm_order_changed) event\n* `ecomm_inventory_changed` - Sends the [ecomm_inventory_changed](#ecomm_inventory_changed) event\n* `collection_item_created` - Sends the [collection_item_created](#collection_item_created) event\n* `collection_item_changed` - Sends the [collection_item_changed](#collection_item_changed) event\n* `collection_item_deleted` - Sends the [collection_item_deleted](#collection_item_deleted) event\n* `collection_item_unpublished` - Sends the [collection_item_unpublished](#collection_item_unpublished) event\n* `comment_created` - Sends the [comment_created](#comment_created) event\n","title":"TriggerType"},"WebhookFilter":{"type":"object","properties":{},"description":"filter for selecting which events you want webhooks to be triggered for.","title":"WebhookFilter"},"Webhook":{"type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"Unique identifier for a Webhook"},"triggerType":{"$ref":"#/components/schemas/TriggerType"},"triggerId":{"type":"string","format":"uuid","description":"Unique identifier for the Webhook Trigger"},"site":{"type":"string","format":"uuid","description":"Unique identifier for a Webhook"},"filter":{"$ref":"#/components/schemas/WebhookFilter","description":"filter for selecting which events you want webhooks to be triggered for."},"lastUsed":{"type":"string","format":"date-time","description":"Date trigger was last used"},"createdOn":{"type":"string","format":"date-time","description":"Date trigger was created"}},"title":"Webhook"},"SitesSiteIdWebhooksPostRequestBodyContentApplicationJsonSchemaFilter":{"type":"object","properties":{},"description":"filter for selecting which events you want webhooks to be triggered for.\n** Only available for `form_submission` trigger types.\n","title":"SitesSiteIdWebhooksPostRequestBodyContentApplicationJsonSchemaFilter"},"DeleteResult":{"type":"object","properties":{"deleted":{"type":"number","format":"double","description":"Number of records deleted"}},"description":"The result from a delete","title":"DeleteResult"},"Field":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the item"},"slug":{"type":"string","default":"new-item","description":"Slug of the item"},"name":{"type":"string","default":"My New Item","description":"item name"},"_archived":{"type":"boolean","default":false,"description":"item archive status"},"_draft":{"type":"boolean","default":false,"description":"item draft status"}},"required":["slug","name","_archived","_draft"],"description":"Fields in your collection item","title":"Field"},"Collection":{"type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"Unique identifier for collection"},"lastUpdated":{"type":"string","format":"date-time","description":"The date the collection was last updated"},"createdOn":{"type":"string","format":"date-time","description":"The date the collection was create"},"name":{"type":"string","description":"Name given to Collection"},"slug":{"type":"string","description":"Slug of Collection in Site URL structure"},"singularName":{"type":"string","description":"The name of one Item in Collection (e.g. “post” if the Collection is called “Posts”)"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/Field"},"description":"The list of fields in the collection"}},"required":["_id"],"title":"Collection"},"CollectionItem":{"type":"object","properties":{"_archived":{"type":"boolean","default":false,"description":"Boolean determining if the Item is set to archived"},"_draft":{"type":"boolean","default":false,"description":"Boolean determining if the Item is set to draft"},"_id":{"type":"string","description":"Unique identifier for the Item"},"_cid":{"type":"string","description":"Unique identifier for the Collection the Item belongs within"},"name":{"type":"string","description":"Name given to the Item"},"slug":{"type":"string","description":"URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug."}},"description":"The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items\n","title":"CollectionItem"},"CollectionItemList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CollectionItem"},"description":"List of Items within the collection"},"count":{"type":"integer","description":"Number of items returned"},"limit":{"type":"integer","default":100,"description":"The limit specified in the request"},"offset":{"type":"integer","default":0,"description":"The offset specified for pagination"},"total":{"type":"integer","description":"Total number of items in the collection"}},"description":"Results from collection items list","title":"CollectionItemList"},"RemovedItems":{"type":"object","properties":{"deletedItemIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Array of deleted item ids"},"errors":{"type":"array","items":{"type":"string"},"description":"Array of errors"}},"description":"A list of items removed","title":"RemovedItems"},"PublishedItems":{"type":"object","properties":{"publishedItemIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Array of published item ids"},"errors":{"type":"array","items":{"type":"string"},"description":"Array of errors"}},"description":"A list of items published","title":"PublishedItems"},"SKUEnum":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for a product variant/option"},"name":{"type":"string","description":"Name of the option/variant"},"slug":{"type":"string","description":"slug of option/variant in Site URL structure"}},"description":"Enumerated variant/option of a SKU","title":"SKUEnum"},"SKUProperty":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for a collection of product options/variants"},"name":{"type":"string","description":"Nme of the collection of product options/variants"},"enum":{"type":"array","items":{"$ref":"#/components/schemas/SKUEnum"},"description":"The individual options/varaiants that are contained within the collection"}},"description":"A variant/optiontype for a SKU","title":"SKUProperty"},"ProductField":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the item"},"slug":{"type":"string","default":"product-name","description":"Slug of the item"},"name":{"type":"string","default":"Product Name","description":"item name"},"_archived":{"type":"boolean","default":false,"description":"item archive status"},"_draft":{"type":"boolean","default":false,"description":"item draft status"},"sku-properties":{"type":"array","items":{"$ref":"#/components/schemas/SKUProperty"},"description":"Variant/Options types to include in SKUs"}},"required":["slug","name","_archived","_draft"],"description":"Fields in your product object","title":"ProductField"},"Product":{"type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"Unique identifier for collection"},"lastUpdated":{"type":"string","format":"date-time","description":"The date the collection was last updated"},"createdOn":{"type":"string","format":"date-time","description":"The date the collection was create"},"name":{"type":"string","description":"Name given to Collection"},"slug":{"type":"string","description":"Slug of Collection in Site URL structure"},"singularName":{"type":"string","description":"The name of one Item in Collection (e.g. “product” if the Collection is called “Product”)\n"},"fields":{"$ref":"#/components/schemas/ProductField"}},"required":["_id"],"description":"The Product object","title":"Product"},"ProductList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Product"},"description":"List of Item objects within the Collection. Contains product and skus keys"},"count":{"type":"integer","description":"Number of items returned"},"limit":{"type":"integer","default":100,"description":"The limit specified in the request"},"offset":{"type":"integer","default":0,"description":"The offset specified for pagination"},"total":{"type":"integer","description":"Total number of items in the collection"}},"description":"Results from product list","title":"ProductList"},"SkuFieldPrice":{"type":"object","properties":{"value":{"type":"number","format":"double","default":2000,"description":"Price of SKU"},"unit":{"type":"string","default":"USD","description":"Currency of Item"}},"required":["value","unit"],"description":"price of SKU","title":"SkuFieldPrice"},"SKUField":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the SKU"},"slug":{"type":"string","default":"post-body","description":"Slug of the SKU"},"name":{"type":"string","default":"Cloak Of Invisibility Color: Obsidian Black","description":"SKU name"},"_archived":{"type":"boolean","default":false,"description":"item archive status"},"_draft":{"type":"boolean","default":false,"description":"item draft status"},"price":{"$ref":"#/components/schemas/SkuFieldPrice","description":"price of SKU"}},"required":["slug","_archived","_draft","price"],"description":"Fields in your SKU object","title":"SKUField"},"SKU":{"type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"Unique identifier for collection"},"lastUpdated":{"type":"string","format":"date-time","description":"The date the collection was last updated"},"createdOn":{"type":"string","format":"date-time","description":"The date the collection was create"},"name":{"type":"string","description":"Name given to Collection"},"slug":{"type":"string","description":"Slug of Collection in Site URL structure"},"singularName":{"type":"string","description":"The name of one Item in Collection (e.g. “sku” if the Collection is called “SKU”)"},"fields":{"$ref":"#/components/schemas/SKUField"}},"required":["_id","name","slug","fields"],"description":"The SKU object","title":"SKU"},"ProductSKU":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/Product"},"sku":{"$ref":"#/components/schemas/SKU"}},"description":"A Product and Default SKU","title":"ProductSKU"},"ProductSKUList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Product"},"description":"List of SKUs for a Product"},"count":{"type":"integer","description":"Number of items returned"},"limit":{"type":"integer","default":100,"description":"The limit specified in the request"},"offset":{"type":"integer","default":0,"description":"The offset specified for pagination"},"total":{"type":"integer","description":"Total number of items in the collection"}},"description":"Return a Product and all associated SKUs","title":"ProductSKUList"},"SKUList":{"type":"object","properties":{"skus":{"type":"array","items":{"$ref":"#/components/schemas/SKU"}}},"description":"A list of SKUs","title":"SKUList"},"SitesSiteIdOrdersGetParametersStatus":{"type":"string","enum":["pending","refunded","dispute-lost","fulfilled","disputed","unfulfilled"],"title":"SitesSiteIdOrdersGetParametersStatus"},"OrderStatus":{"type":"string","enum":["pending","unfulfilled","fulfilled","disputed","dispute-lost","refunded"],"description":"One of `pending`, `unfulfilled`, `fulfilled`, `disputed`, `dispute-lost`, or `refunded`\n","title":"OrderStatus"},"OrderAmount":{"type":"object","properties":{"unit":{"type":"string"},"value":{"type":"string"},"string":{"type":"string"}},"description":"The sum of all line items.","title":"OrderAmount"},"OrderCustomerInfo":{"type":"object","properties":{"fullName":{"type":"string"},"email":{"type":"string","format":"email"}},"description":"An object with the keys `fullName` and `email`.","title":"OrderCustomerInfo"},"OrderAddressType":{"type":"string","enum":["shipping","billing"],"title":"OrderAddressType"},"OrderAddress":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/OrderAddressType"},"addressee":{"type":"string"},"line1":{"type":"string"},"line2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"postalCode":{"type":"string"}},"description":"A customer address","title":"OrderAddress"},"OrderItemImage":{"type":"object","properties":{"fileId":{"type":"string","format":"uuid"},"url":{"type":"string","format":"uri"}},"title":"OrderItemImage"},"OrderPurchasedItem":{"type":"object","properties":{"count":{"type":"number","format":"double","description":"Number of item purchased."},"rowTotal":{"$ref":"#/components/schemas/OrderAmount"},"productId":{"type":"string","format":"uuid","description":"String Product Id."},"productName":{"type":"string","description":"Name of the product."},"productSlug":{"type":"string","description":"Slug of the product."},"variantId":{"type":"string","format":"uuid","description":"String Variant Id. (SKU)"},"variantName":{"type":"string","description":"Name of the variant. (SKU)"},"variantSlug":{"type":"string","description":"Slug of the variant. (SKU)"},"variantImage":{"$ref":"#/components/schemas/OrderItemImage"},"variantPrice":{"$ref":"#/components/schemas/OrderAmount"},"height":{"type":"number","format":"double","description":"The height of the variant if provided, 0 otherwise."},"length":{"type":"number","format":"double","description":"The length of the variant if provided, 0 otherwise."},"width":{"type":"number","format":"double","description":"The width of the variant if provided, 0 otherwise"},"weight":{"type":"number","format":"double","description":"The weight of the variant if provided, 0 otherwise."},"purchasedItemsCount":{"type":"number","format":"double","description":"The sum of all 'count' fields in 'purchasedItems'."}},"description":"An item that was purchased","title":"OrderPurchasedItem"},"StripeDetails":{"type":"object","properties":{"refundReason":{"type":"string","description":"Stripe customer ID, or null."},"refundId":{"type":"string","format":"uuid","description":"Stripe charge ID, or null."},"disputeId":{"type":"string","format":"uuid","description":"Stripe dispute ID, or null."},"chargeId":{"type":"string","format":"uuid","description":"Stripe refund ID, or null."},"customerId":{"type":"string","format":"uuid"}},"description":"An object with various Stripe IDs, useful for linking into the stripe dashboard.","title":"StripeDetails"},"StripeCardBrand":{"type":"string","enum":["Visa","American Express","MasterCard","Discover","JCB","Diners Club","Unknown"],"description":"The card’s brand.","title":"StripeCardBrand"},"StripeCardExpires":{"type":"object","properties":{"year":{"type":"number","format":"double"},"month":{"type":"number","format":"double"}},"description":"The card’s expiration date.","title":"StripeCardExpires"},"StripeCard":{"type":"object","properties":{"last4":{"type":"string","description":"The last 4 digits on the card."},"brand":{"$ref":"#/components/schemas/StripeCardBrand","description":"The card’s brand."},"ownerName":{"type":"string","description":"The name on the card."},"expires":{"$ref":"#/components/schemas/StripeCardExpires","description":"The card’s expiration date."}},"description":"Details on the card used to fulfill this order, if this order was finalized with Stripe.\n","title":"StripeCard"},"OrderExtraType":{"type":"string","enum":["discount","discount-shipping","shipping","tax"],"description":"The type of extra item this is.","title":"OrderExtraType"},"OrderExtra":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/OrderExtraType","description":"The type of extra item this is."},"name":{"type":"string","description":"A human-readable (but English) name for this extra charge."},"description":{"type":"string","description":"A human-readable (but English) description of this extra charge."},"price":{"$ref":"#/components/schemas/OrderAmount"}},"description":"Extra order items, includes discounts, shipping, and taxes.","title":"OrderExtra"},"OrderTotals":{"type":"object","properties":{"subtotal":{"$ref":"#/components/schemas/OrderAmount"},"extras":{"type":"array","items":{"$ref":"#/components/schemas/OrderExtra"},"description":"An array of extra items, includes discounts, shipping, and taxes."},"total":{"$ref":"#/components/schemas/OrderAmount"}},"description":"An object describing various pricing totals.","title":"OrderTotals"},"OrderCustomDataItems":{"type":"object","properties":{},"title":"OrderCustomDataItems"},"OrderDownloadedFile":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"url":{"type":"string","format":"uri"}},"title":"OrderDownloadedFile"},"Order":{"type":"object","properties":{"orderId":{"type":"string","description":"The order ID. Will usually be 6 hex characters, but can also be 9 hex characters if the site has a very large number of orders. Randomly assigned.\n"},"status":{"$ref":"#/components/schemas/OrderStatus","description":"One of `pending`, `unfulfilled`, `fulfilled`, `disputed`, `dispute-lost`, or `refunded`\n"},"comment":{"type":"string","description":"A comment string for this order editable by API user (not used by Webflow)."},"orderComment":{"type":"string","description":"A comment that the customer left when making their order"},"acceptedOn":{"type":"string","format":"date-time","description":"The ISO8601 timestamp that an order was placed."},"disputedOn":{"type":"string","format":"date-time","description":"If an order was disputed by the customer, then this key will be set with the ISO8601 timestamp that Stripe notifies Webflow. Null if not disputed.\n"},"disputeUpdatedOn":{"type":"string","description":"If an order was disputed by the customer, then this key will be set with the ISO8601 timestamp of the last time that we got an update. Null if not disputed.\n"},"disputeLastStatus":{"type":"string","description":"If an order was disputed by the customer, then this key will be set with the [dispute's status](https://stripe.com/docs/api#dispute_object-status).\n"},"fulfilledOn":{"type":"string","format":"date-time","description":"If an order was marked as 'fulfilled', then this is the ISO8601 timestamp when that happened.\n"},"refundedOn":{"type":"string","format":"date-time","description":"If an order was refunded, this is the ISO8601 of when that happened."},"customerPaid":{"$ref":"#/components/schemas/OrderAmount"},"netAmount":{"$ref":"#/components/schemas/OrderAmount"},"requiresShipping":{"type":"boolean","description":"A boolean indicating whether the order contains one or more purchased items that require shipping.\n"},"shippingProvider":{"type":"string","description":"A string editable by the API user to note the shipping provider used (not used by Webflow).\n"},"shippingTracking":{"type":"string","description":"A string editable by the API user to note the shipping tracking number for the order (not used by Webflow).\n"},"customerInfo":{"$ref":"#/components/schemas/OrderCustomerInfo"},"allAddresses":{"type":"array","items":{"$ref":"#/components/schemas/OrderAddress"},"description":"All addresses provided by the customer during the ordering flow."},"shippingAddress":{"$ref":"#/components/schemas/OrderAddress"},"billingAddress":{"$ref":"#/components/schemas/OrderAddress"},"purchasedItems":{"type":"array","items":{"$ref":"#/components/schemas/OrderPurchasedItem"},"description":"An array of all things that the customer purchased."},"stripeDetails":{"$ref":"#/components/schemas/StripeDetails"},"stripeCard":{"$ref":"#/components/schemas/StripeCard"},"totals":{"$ref":"#/components/schemas/OrderTotals"},"customData":{"type":"array","items":{"$ref":"#/components/schemas/OrderCustomDataItems"},"description":"An array of additional inputs for custom order data gathering. Each object in the array represents an input with a name, and a textInput, textArea, or checkbox value.\n"},"downloadFiles":{"type":"array","items":{"$ref":"#/components/schemas/OrderDownloadedFile"},"description":"An array of downloadable file objects."}},"title":"Order"},"SitesSiteIdOrderOrderIdPatchRequestBodyContentApplicationJsonSchemaFields":{"type":"object","properties":{"comment":{"type":"string","description":"Arbitrary data for your records"},"shippingProvider":{"type":"string","description":"Company or method used to ship order"},"shippingTracking":{"type":"string","description":"Tracking number for order shipment"},"shippingTrackingURL":{"type":"string","description":"URL to track order shipment"}},"title":"SitesSiteIdOrderOrderIdPatchRequestBodyContentApplicationJsonSchemaFields"},"InventoryItemInventoryType":{"type":"string","enum":["infinite","finite"],"description":"infinite or finite","title":"InventoryItemInventoryType"},"InventoryItem":{"type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"Unique identifier for a SKU item"},"quantity":{"type":"number","format":"double","description":"Total quantity of items remaining in inventory (if finite)"},"inventoryType":{"$ref":"#/components/schemas/InventoryItemInventoryType","description":"infinite or finite"}},"description":"The availabile inventory for an item","title":"InventoryItem"},"CollectionsCollectionIdItemsItemIdInventoryPatchRequestBodyContentApplicationJsonSchemaFieldsInventoryType":{"type":"string","enum":["infinite","finite"],"description":"infinite or finite","title":"CollectionsCollectionIdItemsItemIdInventoryPatchRequestBodyContentApplicationJsonSchemaFieldsInventoryType"},"CollectionsCollectionIdItemsItemIdInventoryPatchRequestBodyContentApplicationJsonSchemaFields":{"type":"object","properties":{"inventoryType":{"$ref":"#/components/schemas/CollectionsCollectionIdItemsItemIdInventoryPatchRequestBodyContentApplicationJsonSchemaFieldsInventoryType","description":"infinite or finite"},"updateQuantity":{"type":"number","format":"double","description":"Adds this quantity to currently store quantity. Can be negative."},"quantity":{"type":"number","format":"double","description":"Immediately sets quantity to this value."}},"description":"The inventory fields to update","title":"CollectionsCollectionIdItemsItemIdInventoryPatchRequestBodyContentApplicationJsonSchemaFields"},"EcommerceSettings":{"type":"object","properties":{"createdOn":{"type":"string","format":"date-time","description":"Date that the site was created on"},"site":{"type":"string","format":"uuid","description":"The ID of the site being queried"},"defaultCurrency":{"type":"string","description":"The three-letter currency code of the site"}},"description":"Ecommerce settings for a site.","title":"EcommerceSettings"},"FormSubmissionData":{"type":"object","properties":{},"description":"The data submitted in the form","title":"FormSubmissionData"},"FormSubmission":{"type":"object","properties":{"name":{"type":"string","description":"The name of the form"},"site":{"type":"string","format":"uuid","description":"The ID of the site that the form was submitted from"},"data":{"$ref":"#/components/schemas/FormSubmissionData","description":"The data submitted in the form"},"d":{"type":"string","description":"The timestamp the form was submitted"},"_id":{"type":"string","format":"uuid","description":"The ID of the form submission"}},"title":"FormSubmission"},"SitePublishPublishedBy":{"type":"object","properties":{},"description":"The name andID of the user who published the site","title":"SitePublishPublishedBy"},"SitePublish":{"type":"object","properties":{"site":{"type":"string","format":"uuid","description":"The siteIDthat was published"},"publishTime":{"type":"string","format":"date-time","description":"The timestamp of the publish event"},"domains":{"type":"array","items":{"type":"string"},"description":"The domains that were published"},"publishedBy":{"$ref":"#/components/schemas/SitePublishPublishedBy","description":"The name andID of the user who published the site"}},"title":"SitePublish"},"CollectionItemRemoved":{"type":"object","properties":{"deleted":{"type":"number","format":"double","description":"The number of items deleted"},"itemId":{"type":"string","format":"uuid","description":"The ID of the collection item that was deleted"}},"title":"CollectionItemRemoved"}},"securitySchemes":{"OAuth2":{"type":"http","scheme":"bearer"}}}}