{ "openapi" : "3.0.0", "info" : { "title" : "Zid API", "description" : "# Overview\nZid Catalog APIs allows you to use Zid platform as a backend for your custom store front-end.\n\n# Authentication\nZid API uses Bearer Authentication, to obtain your key, please contact info@zid.sa.\nOnce you have your key, you can set in the \"Authorization\" header as follows:\n```\nAuthorization: Bearer \n```\n\n
\n\nAll API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.\n\n# Base URL and versioning\nAPI base URL is **api.zid.sa**.\n\nAPI version is specified at the end of the after the base URL. e.g., api.zid.sa/v2/\n\nThe latest version is **v2** older versions are **deprecated** and should not be used.\n\n# Error Codes\n**TODO**\n\n# Rate limit\n\nZid implements the [Leaky Bucket](https://en.wikipedia.org/wiki/Leaky_bucket) algorithm for rate limiting, which means requests will be served and when you hit the bucket limit requests may be throttled or dropped.\n\n# Cart Flow\n\n- Create a cart session, which will return a token that identifies the cart in all future requests.\n- Add products.\n- Add a shipping address.\n- Choose a delivery method.\n- Choose a payment method.\n- Verify, which will return a summary of the order.\n- Checkout, which will return an invoice.\n\n# Changelog\nAll notable changes to this API will be documented in this section.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\n\n## [2.0.02] - 2018-12-27\n### Added\n- View category endpoint: (View Category)[https://docs.zid.sa/#1e6a0a98-0566-4079-ac14-b2e4bcd850ef]\n\n### Removed\n- \"descriptions\" key has been removed from product objects.\n\n## [2.0.01] - 2018-12-27\n### Added\n- \"category\" key has been added to the response of [Category Products List](https://docs.zid.sa/#4cc3a087-c1d9-4fa9-934e-635189adaf7d)\n\n## [2.0.00] - 2018-12-19\n### Added\n- Multi Languages.\n- Multi Currencies.\n- Subcategories.\n", "version" : "1" }, "servers" : [ { "url" : "https://api.zid.dev/app/v1" }, { "url" : "http://api.zid.dev/app/v1" } ], "security" : [ { "default" : [ ] } ], "paths" : { "/managers/account/profile" : { "get" : { "tags" : [ "Account" ], "summary" : "Profile", "description" : "Get the current's user data with No need to pass any parameter, the system will recognize the user via X-MANAGER-Token.\n", "parameters" : [ { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/Accept-Language" } ], "responses" : { "200" : { "description" : "Profile --meta SEO tags in reponse", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-get-profile" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/managers/store/vat" : { "get" : { "tags" : [ "Stores" ], "summary" : "Get List of Vat Settings", "parameters" : [ { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/Accept-Language" } ], "responses" : { "200" : { "description" : "List of Vat Settings", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-get-all-vat" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/managers/store/inventory-addresses" : { "get" : { "tags" : [ "Stores" ], "summary" : "Get Inventory Addresses", "parameters" : [ { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/Accept-Language" } ], "responses" : { "200" : { "description" : "List of all Inventory Addresses in your store", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-get-all-inventory" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/managers/store/orders/{order-id}/change-order-status" : { "post" : { "tags" : [ "Orders" ], "summary" : "Update Order By Id", "description" : "Please consider that if the order is shipped through an integrated shipping company, then we can't update the order status from ready to new.\n
\nTo send the order to a shipping company, you will need to change the order status to ready, and to send `inventory_address_id` value with your request, it's a must since shipping companies need to know which pickup point to get the package from.
To get a list of your current inventory addresses along with their ids, please check the inventory addresses API endpoint.\n\nList of statuses:\n(new, preparing, ready, indelivery, delivered, cancelled)", "parameters" : [ { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/Accept-Language" }, { "name" : "order-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "number" } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "required" : [ "inventory_address_id", "order_status" ], "type" : "object", "properties" : { "order_status" : { "type" : "string" }, "inventory_address_id" : { "type" : "string" }, "tracking_number" : { "type" : "string" }, "tracking_url" : { "type" : "string" }, "waybill_url" : { "type" : "string" } } } } }, "required" : true }, "responses" : { "200" : { "description" : "Single Order Updated" } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/managers/store/customers" : { "get" : { "tags" : [ "Customers" ], "summary" : "List of Customers", "parameters" : [ { "name" : "page", "in" : "query", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "10" } }, { "name" : "per_page", "in" : "query", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "5" } }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/Accept-Language" } ], "responses" : { "200" : { "description" : "List of customers", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-get-all-customers" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/attributes" : { "get" : { "tags" : [ "Products Attributes" ], "summary" : "Get Product Attributes", "parameters" : [ { "$ref" : "#/components/parameters/Accept-Language" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" } ], "responses" : { "200" : { "description" : "List of your prdouct attributes", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-get-attributes" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" }, "post" : { "tags" : [ "Products Attributes" ], "summary" : "Creates an new attribute", "parameters" : [ { "$ref" : "#/components/parameters/Accept-Language" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" } ], "requestBody" : { "description" : "The Request Body that contain the new attribute", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "name" : { "type" : "object", "properties" : { "en" : { "type" : "string" }, "ar" : { "type" : "string" } } } } } } }, "required" : true }, "responses" : { "200" : { "description" : "List of attributes by ID", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-post-attribute" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/attributes/{Attribute-Id}/presets" : { "get" : { "tags" : [ "Products Attribute Presets" ], "summary" : "Get attribute presets", "parameters" : [ { "name" : "Attribute-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "1" } }, { "$ref" : "#/components/parameters/Accept-Language" }, { "$ref" : "#/components/parameters/ROLE" }, { "$ref" : "#/components/parameters/STORE-ID" } ], "responses" : { "200" : { "description" : "List of attribute presets", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-get-presets" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" }, "post" : { "tags" : [ "Products Attribute Presets" ], "summary" : "Create Attribute Preset", "parameters" : [ { "name" : "Attribute-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "1" } }, { "$ref" : "#/components/parameters/ROLE" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/STORE-ID" } ], "requestBody" : { "description" : "The Request Body that contain the new attribute preset", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "value" : { "type" : "object", "properties" : { "ar" : { "type" : "string" }, "en" : { "type" : "string" } } } } } } }, "required" : true }, "responses" : { "200" : { "description" : "Json Represent The New Attribute Preset Values.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-post-presets" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/products/{Product-Id}/categories/{Category-Id}" : { "delete" : { "tags" : [ "Product Categories" ], "summary" : "Delete a product from a category.", "parameters" : [ { "name" : "Product-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "794e96c3-227e-4abc-9521-725d147f1e61" } }, { "name" : "Category-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" } ], "responses" : { "200" : { "description" : "Product Deleted Successfully From The Given Category" } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/managers/store/categories/{Category-Id}/update" : { "post" : { "tags" : [ "Categories" ], "summary" : "Update Store Category", "parameters" : [ { "name" : "Category-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "540" } }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/Accept-Language" } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "required" : [ "description[ar]", "description[en]", "name[ar]", "name[en]" ], "type" : "object", "properties" : { "name[ar]" : { "type" : "string" }, "name[en]" : { "type" : "string" }, "description[ar]" : { "type" : "string" }, "description[en]" : { "type" : "string" }, "_method" : { "type" : "string", "example" : "put" } } } } }, "required" : true }, "responses" : { "200" : { "description" : "Single Category Updated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-get-single-category" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/products/{Product-Id}/notifications" : { "post" : { "tags" : [ "Products" ], "summary" : "Add Availability Notification", "description" : "Register an email as waiting for a product to be notified whenever the product is in back stock.", "parameters" : [ { "name" : "Product-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "107c2ff5-5c70-4749-b9bd-56dc1793013b" } }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "required" : [ "email", "language" ], "type" : "object", "properties" : { "email" : { "type" : "string" }, "language" : { "type" : "string", "example" : "ar" } } } } }, "required" : true }, "responses" : { "200" : { "description" : "Notification Added" } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/products/{Product-Id}" : { "get" : { "tags" : [ "Products" ], "summary" : "Retreives a single products.", "parameters" : [ { "name" : "Product-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "107c2ff5-5c70-4749-b9bd-56dc1793013b" } }, { "$ref" : "#/components/parameters/Accept-Language" }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" } ], "responses" : { "200" : { "description" : "Single Product", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-get-single-product" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" }, "delete" : { "tags" : [ "Products" ], "summary" : "Delete a single products.", "parameters" : [ { "name" : "Product-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "107c2ff5-5c70-4749-b9bd-56dc1793013b" } }, { "$ref" : "#/components/parameters/Accept-Language" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" } ], "responses" : { "200" : { "description" : "Product Deleted" } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" }, "patch" : { "tags" : [ "Products" ], "summary" : "Update an existing product", "parameters" : [ { "name" : "Product-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "107c2ff5-5c70-4749-b9bd-56dc1793013b" } }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/Accept-Language" }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" } ], "requestBody" : { "description" : "New product data", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "weight" : { "type" : "object", "properties" : { "unit" : { "type" : "string" }, "value" : { "type" : "integer" } } }, "keywords" : { "type" : "array", "example" : [ "apps" ], "items" : { } }, "requires_shipping" : { "type" : "boolean" }, "sku" : { "type" : "string" }, "cost" : { "type" : "string" }, "quantity" : { "type" : "integer" }, "is_infinite" : { "type" : "boolean" }, "name" : { "type" : "object", "properties" : { "ar" : { "type" : "string" }, "en" : { "type" : "string" } } }, "description" : { "type" : "object", "properties" : { "ar" : { "type" : "string" }, "en" : { "type" : "string" } } }, "price" : { "type" : "string" }, "id" : { "type" : "string" }, "is_draft" : { "type" : "boolean" }, "is_published" : { "type" : "boolean" } } } } }, "required" : true }, "responses" : { "200" : { "description" : "Updated product information", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-get-single-product" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/products/{Product-Id}/images/{Image-Id}" : { "delete" : { "tags" : [ "Products Images" ], "summary" : "Delete Single Image From a Product", "parameters" : [ { "name" : "Product-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "1" } }, { "name" : "Image-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "1" } }, { "$ref" : "#/components/parameters/Accept-Language" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" } ], "responses" : { "200" : { "description" : "single image to a product added.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-get-images" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" }, "patch" : { "tags" : [ "Products Images" ], "summary" : "Update Single Image Order In A Product", "parameters" : [ { "name" : "Product-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "1" } }, { "name" : "Image-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "1" } }, { "$ref" : "#/components/parameters/Accept-Language" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" } ], "requestBody" : { "description" : "The new display order for this image", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "display_order" : { "type" : "number" } } } } }, "required" : true }, "responses" : { "200" : { "description" : "Edited image data", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-patch-image-order" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/attributes/{Attribute-Id}" : { "get" : { "tags" : [ "Products Attributes" ], "summary" : "Retrieve a single attribute", "parameters" : [ { "name" : "Attribute-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "1" } }, { "$ref" : "#/components/parameters/Accept-Language" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" } ], "responses" : { "200" : { "description" : "Single attribute by ID", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-post-attribute" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" }, "delete" : { "tags" : [ "Products Attributes" ], "summary" : "Delete a single attribute", "parameters" : [ { "name" : "Attribute-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "1" } }, { "$ref" : "#/components/parameters/Accept-Language" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" } ], "responses" : { "200" : { "description" : "Delete of attributes by ID", "content" : { "application/json" : { "schema" : { } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" }, "patch" : { "tags" : [ "Products Attributes" ], "summary" : "Updates a single attribute", "parameters" : [ { "name" : "Attribute-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "1" } }, { "$ref" : "#/components/parameters/Accept-Language" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" } ], "requestBody" : { "description" : "The Request Body that contain the new attribute values", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "name" : { "type" : "object" } } } } }, "required" : true }, "responses" : { "200" : { "description" : "List of attributes by ID" } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/products" : { "get" : { "tags" : [ "Products" ], "summary" : "Get all products", "parameters" : [ { "name" : "page_size", "in" : "query", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "10" } }, { "name" : "page", "in" : "query", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "5" } }, { "$ref" : "#/components/parameters/Accept-Language" }, { "$ref" : "#/components/parameters/ROLE" }, { "$ref" : "#/components/parameters/STORE-ID" } ], "responses" : { "200" : { "description" : "List of products", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-get-all-products" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" }, "post" : { "tags" : [ "Products" ], "summary" : "Create a new product", "description" : "Creates a stand-alone product, to generate options (variants) refer to Add product variants endpoint.", "parameters" : [ { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" }, { "$ref" : "#/components/parameters/Accept-Language" } ], "requestBody" : { "description" : "New product data", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "cost" : { "type" : "string" }, "quantity" : { "type" : "string" }, "keywords" : { "type" : "array", "example" : [ "testables" ], "items" : { } }, "name" : { "type" : "object", "properties" : { "ar" : { "type" : "string" }, "en" : { "type" : "string" } } }, "description" : { "type" : "object", "properties" : { "ar" : { "type" : "string", "example" : "[\"

من الممكن وضع تنسيقات هنا

\"]" }, "en" : { "type" : "string", "example" : "[\"

You can add HMTL here

\"]" } } }, "price" : { "type" : "string" }, "sale_price" : { "type" : "string" }, "weight" : { "type" : "object", "properties" : { "unit" : { "type" : "string" }, "value" : { "type" : "integer" } } }, "is_published" : { "type" : "boolean" } } } } }, "required" : true }, "responses" : { "200" : { "description" : "Created product", "content" : { "application/json; charset=utf-8" : { "schema" : { "$ref" : "#/components/schemas/200-get-single-product" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" }, "patch" : { "tags" : [ "Products" ], "summary" : "Bulk update products via ID or SKU", "parameters" : [ { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" }, { "$ref" : "#/components/parameters/Accept-Language" } ], "requestBody" : { "description" : "List of products with ID/SKU and new data", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "id" : { "type" : "integer" } } } } }, "required" : true }, "responses" : { "200" : { "description" : "Updated bulk of products information" } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/products/ordering/" : { "post" : { "tags" : [ "Product Sorting" ], "summary" : "Sort List Of Products", "description" : "Sorts a list of `products`, accepts an ordered list of products ids in products, can also be used to sort products list in a `category` when the category id is passed on category field the body.", "parameters" : [ { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" } ], "requestBody" : { "description" : "List of products with given category ID", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "products" : { "type" : "array", "example" : [ "d22fb4a6-cbcf-464c-8877-6cbf3df52056", "d22fb4a6-cbcf-46g5-8877-6c367f52053" ], "items" : { } }, "category" : { "type" : "integer" } } } } }, "required" : true }, "responses" : { "200" : { "description" : "Products Sorted Successfully In The Given Category" } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" }, "delete" : { "tags" : [ "Product Sorting" ], "summary" : "Reset the manual sorting of all product", "parameters" : [ { "$ref" : "#/components/parameters/Accept-Language" }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" } ], "responses" : { "200" : { "description" : "Products Sorted Successfully In The Given Category" } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/products/{Product-Id}/custom_options_fields/" : { "post" : { "tags" : [ "Product Options" ], "summary" : "Insert Custom Options To a Product", "parameters" : [ { "name" : "Product-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "794e96c3-227e-4abc-9521-725d147f1e61" } }, { "$ref" : "#/components/parameters/Accept-Language" }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" } ], "requestBody" : { "description" : "Insert Custom Options To a Product", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "label" : { "type" : "object", "properties" : { "ar" : { "type" : "string" } } }, "choices" : { "type" : "array", "items" : { "type" : "object", "properties" : { "ar" : { "type" : "string" }, "en" : { "type" : "string" }, "price" : { "type" : "string" } } } }, "hint" : { "type" : "object", "properties" : { "ar" : { "type" : "string" }, "en" : { "type" : "string" } } } } } } }, "required" : true }, "responses" : { "200" : { "description" : "Added", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-post-product-option-custom" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/managers/store/orders" : { "get" : { "tags" : [ "Orders" ], "summary" : "List of Orders", "description" : "Get order list by filters\n", "parameters" : [ { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/Accept-Language" }, { "name" : "payload_type", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" } }, { "name" : "page", "in" : "query", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "number" } }, { "name" : "per_page", "in" : "query", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "number" } }, { "name" : "order_status", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "new", "enum" : [ "new", "preparing", "ready", "indelivery", "delivered", "canceled" ] } }, { "name" : "payment_method", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "zid_cod", "enum" : [ "zid_cod", "zid_bank_transfer", "zid_cop", "zid_credit_card" ] } }, { "name" : "customer_id", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number" } }, { "name" : "date_from", "in" : "query", "description" : "example: '2020-01-01T00:00:00.000+0000'", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" } }, { "name" : "date_to", "in" : "query", "description" : "example: '2020-01-01T00:00:00.000+0000'", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" } }, { "name" : "sort_by", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "asc", "enum" : [ "asc", "desc" ] } } ], "responses" : { "200" : { "description" : "list of orders with the given filters", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-get-all-orders" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/managers/store/abandoned-carts" : { "get" : { "tags" : [ "Abandoned Carts" ], "summary" : "List of Abandoned Carts", "description" : "Get Abandoned Carts list by filters\n", "parameters" : [ { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/Accept-Language" }, { "name" : "page", "in" : "query", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "number" } }, { "name" : "page_size", "in" : "query", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "number" } }, { "name" : "phase", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "new", "enum" : [ "new", "login", "shipping_address", "shipping_method", "payment_method", "verification", "completed" ] } }, { "name" : "search_term", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" } }, { "name" : "products_count", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number" } }, { "name" : "date_from", "in" : "query", "description" : "example: '2021-01-01'", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" } }, { "name" : "date_to", "in" : "query", "description" : "example: '2021-01-01'", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" } }, { "name" : "cart_total", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number" } } ], "responses" : { "200" : { "description" : "List of Abandoned Carts with the given filters" } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/managers/store/abandoned-carts/{id}" : { "get" : { "tags" : [ "Abandoned Carts" ], "summary" : "Get Abandoned Cart details", "parameters" : [ { "$ref" : "#/components/parameters/Accept-Language" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "name" : "id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Will get Abandoned Cart details from the given ID" } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/products/export/" : { "post" : { "tags" : [ "Prodcuts Export" ], "summary" : "Send All Products in CSV for Owner Email", "parameters" : [ { "$ref" : "#/components/parameters/Accept-Language" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" } ], "responses" : { "200" : { "description" : "All Products Sent to the Owner Email" } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/managers/store/categories/{Id}/publishing" : { "post" : { "tags" : [ "Categories" ], "summary" : "Update Category Publishing", "parameters" : [ { "name" : "Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "540" } }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/Accept-Language" } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "required" : [ "is_published" ], "type" : "object", "properties" : { "is_published" : { "type" : "string" } } } } }, "required" : true }, "responses" : { "200" : { "description" : "Publishing Changed" } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/products/{Product-Id}/options" : { "post" : { "tags" : [ "Product Options" ], "summary" : "Add Product Variantes", "description" : "This endpoint converts a product from stand-alone into a parent product (if it wasn't already a parent) and creates variants as children, to create variants you need to first create product attributes for the store using the `Create attribute` endpoint, and then use the attribute slug and define choices for them here. for example, if attribute is size choices are `small`, `big`, ...etc. Each choice is an object that accepts values in different languages, only English and Arabic are supported for now. This endpoint accepts an array of attributes and their choices, the variants will be generated using the cartesian product of these attribute values.", "parameters" : [ { "name" : "Product-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "794e96c3-227e-4abc-9521-725d147f1e61" } }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" } ], "requestBody" : { "description" : "Add Product Variantes", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "id" : { "type" : "array", "items" : { "type" : "object" } } } } } }, "required" : true }, "responses" : { "200" : { "description" : "Product Variants Added Successfully" } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/managers/store/inventory-addresses/{Inventory-Id}/view" : { "get" : { "tags" : [ "Stores" ], "summary" : "Get Inventory Address Based On ID", "parameters" : [ { "$ref" : "#/components/parameters/Accept-Language" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "name" : "Inventory-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "{{Inventory-Id}}" } } ], "responses" : { "200" : { "description" : "Will get inventory address from your store from the given ID" } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/products/{Product-Id}/images" : { "get" : { "tags" : [ "Products Images" ], "summary" : "Lists the images of a product.", "parameters" : [ { "name" : "Product-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "1" } }, { "name" : "page_size", "in" : "query", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "1" } }, { "$ref" : "#/components/parameters/Accept-Language" }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" } ], "responses" : { "200" : { "description" : "List of attributes by ID", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-get-images" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" }, "post" : { "tags" : [ "Products Images" ], "summary" : "Adds a single image to a product", "parameters" : [ { "name" : "Product-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "1" } }, { "$ref" : "#/components/parameters/Accept-Language" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "required" : [ "alt_text", "image" ], "type" : "object", "properties" : { "image" : { "type" : "string", "format" : "binary" }, "alt_text" : { "type" : "string" } } } } }, "required" : true }, "responses" : { "200" : { "description" : "." } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/managers/store/categories/{Category-Id}/view" : { "get" : { "tags" : [ "Categories" ], "summary" : "Single Category", "parameters" : [ { "name" : "Category-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "540" } }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/Accept-Language" } ], "responses" : { "200" : { "description" : "Single Category", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-get-single-category" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/managers/store/categories/{Category-Id}/products/delete" : { "post" : { "tags" : [ "Categories" ], "summary" : "Delete Category Products", "parameters" : [ { "name" : "Category-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "540" } }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/Accept-Language" } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "required" : [ "products[]" ], "type" : "object", "properties" : { "products[]" : { "type" : "string" } } } } }, "required" : true }, "responses" : { "200" : { "description" : "Product/s Deleted" } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/products/{Product-Id}/custom_user_input_fields/" : { "post" : { "tags" : [ "Product Options" ], "summary" : "Insert Custom User Input To a Product", "parameters" : [ { "name" : "Product-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "794e96c3-227e-4abc-9521-725d147f1e61" } }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" } ], "requestBody" : { "description" : "Convert Product Into Parent Product", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "price" : { "type" : "string" }, "hint" : { "type" : "object", "properties" : { "en" : { "type" : "string" }, "ar" : { "type" : "string" } } }, "label" : { "type" : "object", "properties" : { "ar" : { "type" : "string" }, "en" : { "type" : "string" } } } } } } }, "required" : true }, "responses" : { "200" : { "description" : "Added", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-post-product-input-custom" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/products/import/" : { "post" : { "tags" : [ "Prodcuts Import" ], "summary" : "Send All Products in CSV for Owner Email", "description" : "Imports a CSV or xlsx file to store products. accepts a file, a dropbox folder link for images, and has an option `delete_old_products` to delete all store previous products upon successful import.", "parameters" : [ { "$ref" : "#/components/parameters/Accept-Language" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "required" : [ "file", "response_type" ], "type" : "object", "properties" : { "file" : { "type" : "string", "format" : "binary" }, "delete_old_products" : { "type" : "boolean" }, "response_type" : { "type" : "string", "example" : "json" } } } } }, "required" : true }, "responses" : { "200" : { "description" : "All Products Sent to the Owner Email" } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/managers/account/third-parties/authorization-access-token" : { "get" : { "tags" : [ "Account" ], "summary" : "Third Party Access Token", "description" : "Get a manager token with a long lifespan (6 monthes), since regular manager tokens have a short lifespan and considered unreliable for a system to system integration.\n", "parameters" : [ { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/Accept-Language" } ], "responses" : { "200" : { "description" : "Get a manager token with a long lifespan (6 monthes), since regular manager tokens have a short lifespan and considered unreliable for a system to system integration." } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/managers/store/categories" : { "get" : { "tags" : [ "Categories" ], "summary" : "Get all categories", "parameters" : [ { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/Accept-Language" } ], "responses" : { "200" : { "description" : "List of products", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-get-all-categories" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/managers/store/customers/{Customer-Id}" : { "get" : { "tags" : [ "Customers" ], "summary" : "Customer by Id", "parameters" : [ { "name" : "Customer-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/Accept-Language" } ], "responses" : { "200" : { "description" : "Customer", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-get-single-customer" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/attributes/{Attribute-Id}/presets/{Preset-Id}" : { "delete" : { "tags" : [ "Products Attribute Presets" ], "summary" : "Delete an attribute preset", "parameters" : [ { "name" : "Attribute-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "1" } }, { "name" : "Preset-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "794e96c3-227e-4abc-9521-725d147f1e61" } }, { "$ref" : "#/components/parameters/ROLE" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/STORE-ID" } ], "responses" : { "200" : { "description" : "Preset Deleted Successfully" } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" }, "patch" : { "tags" : [ "Products Attribute Presets" ], "summary" : "Update Attribute Preset", "parameters" : [ { "name" : "Attribute-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "1" } }, { "name" : "Preset-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "794e96c3-227e-4abc-9521-725d147f1e61" } }, { "$ref" : "#/components/parameters/ROLE" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/STORE-ID" } ], "requestBody" : { "description" : "The Request Body that contain the new attribute preset", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "value" : { "type" : "object", "properties" : { "ar" : { "type" : "string" }, "en" : { "type" : "string" } } } } } } }, "required" : true }, "responses" : { "200" : { "description" : "Json Represent The New Attribute Preset Values.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-post-presets" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/managers/store/categories/add" : { "post" : { "tags" : [ "Categories" ], "summary" : "Create Store Category", "parameters" : [ { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/Accept-Language" } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "required" : [ "description[ar]", "description[en]", "name[ar]", "name[en]" ], "type" : "object", "properties" : { "name[ar]" : { "type" : "string" }, "name[en]" : { "type" : "string" }, "description[ar]" : { "type" : "string" }, "description[en]" : { "type" : "string" } } } } }, "required" : true }, "responses" : { "200" : { "description" : "Added Category" } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/products/sales-report/" : { "post" : { "tags" : [ "Prodcuts Export" ], "summary" : "Post Exported CSV Sheets", "parameters" : [ { "$ref" : "#/components/parameters/Accept-Language" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" } ], "requestBody" : { "description" : "Sends an exported Excel sheet of products sales report, can be filtered using order ids or statuses.", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "orders" : { "type" : "array", "example" : [ 271 ], "items" : { } }, "statuses" : { "type" : "array", "example" : [ "new", "preparing", "ready", "in_delivery", "delivered", "cancelled" ], "items" : { } } } } } }, "required" : true }, "responses" : { "200" : { "description" : "Sheet posted successfully" } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/products/{Product-Id}/categories" : { "post" : { "tags" : [ "Product Categories" ], "summary" : "Add single product to particluar category", "parameters" : [ { "name" : "Product-Id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "794e96c3-227e-4abc-9521-725d147f1e61" } }, { "$ref" : "#/components/parameters/STORE-ID" }, { "$ref" : "#/components/parameters/ROLE" }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" } ], "requestBody" : { "description" : "The Category ID", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "example" : 409 } } } } }, "required" : true }, "responses" : { "200" : { "description" : "Product Added Successfully To The Given Category", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-post-product-catigories" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/managers/store/orders/{order-id}/view" : { "get" : { "tags" : [ "Orders" ], "summary" : "Order By Id", "description" : "Get a specific order by its id.\n", "parameters" : [ { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/Accept-Language" }, { "name" : "order-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "number" } } ], "responses" : { "200" : { "description" : "Single Order", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-get-single-order" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/managers/store/delivery-options" : { "get" : { "tags" : [ "Delivery Options" ], "summary" : "List of Delivery Option", "parameters" : [ { "name" : "payload_type", "in" : "query", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "simple" } }, { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/Accept-Language" } ], "responses" : { "200" : { "description" : "List of Delivery Options", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-get-delivery-options" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/managers/store/delivery-options/add" : { "post" : { "tags" : [ "Delivery Options" ], "summary" : "Add Shipping Option", "description" : "To Add Shipping Option To Store", "parameters" : [ { "name" : "X-MANAGER-TOKEN", "in" : "header", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "Accept-Language", "in" : "header", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "required" : [ "additional_weight", "base_weight", "cities[]", "cod_enabled", "cod_fee", "cost", "delivery_estimated_time_ar", "delivery_estimated_time_en", "is_customizable_weight_cost", "is_weight_enabled", "name" ], "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "The name of the option to be shown to customers", "example" : "SMSA" }, "cost" : { "type" : "string", "description" : "cost of the delivery to be shown to customers", "example" : "20" }, "cod_enabled" : { "type" : "string", "description" : "1 to enable 0 to disable" }, "cod_fee" : { "type" : "string", "description" : "COD fee to be shown to customers" }, "cities[]" : { "type" : "string", "description" : "The id of the city that enabled in this option (note that each city should be in a diffrent parameter)" }, "delivery_estimated_time_ar" : { "type" : "string", "description" : "Arabic delivery description to be shown to cutomers." }, "delivery_estimated_time_en" : { "type" : "string", "description" : "English delivery description to be shown to cutomers." } } } } }, "required" : true }, "responses" : { "200" : { "description" : "ok" } }, "security" : [ { "default" : [ "Shipping-Partners" ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/managers/store/payment-methods" : { "get" : { "tags" : [ "Payment Methods" ], "summary" : "List of Payment Method", "parameters" : [ { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/Accept-Language" } ], "responses" : { "200" : { "description" : "List of Payment Options", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-get-payment-methods" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/settings/countries" : { "get" : { "tags" : [ "Countries and Cities" ], "parameters" : [ ], "responses" : { "200" : { "description" : "ok" } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/settings/cities/by-country-id/{country-id}" : { "get" : { "tags" : [ "Countries and Cities" ], "parameters" : [ { "name" : "country-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "184" } } ], "responses" : { "200" : { "description" : "ok" } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" } }, "/managers/webhooks" : { "get" : { "tags" : [ "WebHook" ], "summary" : "List of Webhooks", "parameters" : [ { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/Accept-Language" } ], "responses" : { "200" : { "description" : "List of all webhooks", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-get-all-webhooks" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" }, "post" : { "tags" : [ "WebHook" ], "summary" : "Create a Webhook", "description" : "Supported webhooks events:\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
EventSource
order.createOrder
order.status.updateOrder
product.createProduct
product.updateProduct
product.publishProduct
product.deleteProduct
\n", "parameters" : [ { "$ref" : "#/components/parameters/X-MANAGER-TOKEN" }, { "$ref" : "#/components/parameters/Accept-Language" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "event" : { "type" : "string", "example" : "order.create" }, "target_url" : { "type" : "string", "example" : "http://zid.sa" }, "original_id" : { "type" : "integer", "example" : 1 }, "subscriber" : { "type" : "string" }, "conditions" : { "type" : "object", "properties" : { "status" : { "type" : "string", "example" : "ready" }, "delivery_option_id" : { "type" : "integer", "example" : 0 } } } } } } }, "required" : true }, "responses" : { "200" : { "description" : "Created WebHook Information", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/200-post-create-webhook" } } } } }, "security" : [ { "default" : [ ] } ], "x-auth-type" : "Application & Application User", "x-throttling-tier" : "Unlimited" }, "delete" : { "tags" : [ "WebHook" ], "summary" : "Delete a Webhook By Original Id", "description" : "