{"id":"673bc492-06a6-4c2b-81b4-de403f707397","createdDate":"2024-03-07T13:41:01.255Z","updatedDate":"2024-03-07T13:41:01.255Z","resourceId":"54537129-d8ed-4a05-ae78-3e2852f02fdc","api":{"schema":{"object":{"displayName":"Orders Object","description":"","slug":"orders-object","$ref":"#/components/schemas/wix.orders.api.v2.Order","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/ecom.git"},"methods":[{"summary":"Create Order","description":"

\n\n__Deprecation Notice:__\n\nThis endpoint has been replaced with\n[eCommerce Create Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/create-order)\nand will be removed on September 4, 2024.\n\n

\n\nCreates a new order.\n\n> **Notes:**\n> + Only orders with the `paymentStatus` parameter set as `\"PAID\"` or `\"NOT_PAID\"` will show up in the site owner's Stores Orders tab in their dashboard.\n> + The `billingInfo.paymentProviderTransactionId` and `billingInfo.paymentMethod` parameters can only be passed when paymentStatus is PAID.\n> + The `billingInfo`.address parameter is required unless `channelInfo.type: \"POS\"`.\n> + The `shippingInfo.shipmentDetails.address` parameter is required unless one of the following is true:\n> + The `shippingInfo.pickupDetails` is passed instead\n> + `channelInfo.type: \"POS\"`\n> + All order items are of type digital - `lineItems.lineItemType: \"DIGITAL\"`.\n> + When passing `lineItems.variantId`, `lineItems.options` is required.\n> + When passing `lineItems.productId`, `lineItem.lineItemType` is limited to `\"PHYSICAL\"`.\n> + When not passing `lineItems.productId`, `lineItem.lineItemType` is limited to `\"CUSTOM_AMOUNT_ITEM\"`.","operationId":"wix.orders.api.v2.OrdersWriteAPI.CreateOrder","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.orders.api.v2.CreateOrderResponse","description":""}},"deprecated":true,"servers":[{"url":"https://www.wixapis.com/stores/v2/orders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v2/orders","destinationPath":"/v2/orders","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateOrderRequest","description":"","properties":{"order":{"description":"","$ref":"#/components/schemas/wix.orders.api.v2.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["order","order.totals"]}}},"x-wix-docs":{"deprecated":{"message":"Stores Create Order has been replaced with eCommerce Create Order.","replacedBy":"CreateOrder","targetRemovalDate":"2024-09-04"}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.orders.api.v2.OrdersWriteAPI","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.CREATE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-orders-api","serviceArtifactId":"com.wixpress.ecom.orders-reverse-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.orders.api.v2.CreateOrderRequest","responseMessage":"wix.orders.api.v2.CreateOrderResponse"},"deprecated":{"message":"Stores Create Order has been replaced with eCommerce Create Order.","replacedBy":"CreateOrder","targetRemovalDate":"2024-09-04"},"legacyExamples":[{"name":"CreateOrder","type":"METHOD","order":2,"content":{"title":"Create order example - full order","request":"curl 'https://www.wixapis.com/stores/v2/orders' \\\n--data-binary '{\n \"order\": {\n \"totals\": {\n \"subtotal\": \"10\",\n \"shipping\": \"3\",\n \"tax\": \"3\",\n \"discount\": \"1\",\n \"total\": \"15\"\n },\n \"billingInfo\": {\n \"paymentMethod\": \"PayPal\",\n \"paymentProviderTransactionId\": \"tx_1806\",\n \"address\": {\n \"fullName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n },\n \"country\": \"US\",\n \"city\": \"New York\",\n \"zipCode\": \"92544\",\n \"phone\": \"+972 555234555\",\n \"email\": \"Ivanushka@example.com\"\n }\n },\n \"shippingInfo\": {\n \"deliveryOption\": \"Express\",\n \"estimatedDeliveryTime\": \"Today\",\n \"shippingRegion\": \"Domestic\",\n \"shipmentDetails\": {\n \"address\": {\n \"fullName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n },\n \"country\": \"US\",\n \"city\": \"New York\",\n \"zipCode\": \"92544\",\n \"phone\": \"+972 555234555\",\n \"email\": \"Ivanushka@example.com\"\n },\n \"tax\": \"1\",\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"3\"\n }\n }\n },\n \"paymentStatus\": \"PAID\",\n \"lineItems\": [\n {\n \"quantity\": 2,\n \"discount\": \"1\",\n \"tax\": \"1\",\n \"name\": \"my product\",\n \"productId\": \"a1f9d337-f831-4529-31e6-67db8fd4e1aa\",\n \"lineItemType\": \"PHYSICAL\",\n \"weight\": \"15\",\n \"sku\": \"12345678\",\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"5\"\n }\n }\n ],\n \"channelInfo\": {\n \"type\": \"WEB\"\n }\n }\n }' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '","response":"{\n \"order\":{\n \"id\":\"fedb19f5-bd4c-4bfc-b2d1-212538319611\",\n \"number\":10096,\n \"dateCreated\":\"2020-03-18T16:47:59.222Z\",\n \"currency\":\"USD\",\n \"weightUnit\":\"LB\",\n \"totals\":{\n \"subtotal\":\"10\",\n \"shipping\":\"3\",\n \"tax\":\"3\",\n \"discount\":\"1\",\n \"total\":\"15\",\n \"weight\":\"30\",\n \"quantity\":2\n },\n \"billingInfo\":{\n \"paymentMethod\":\"PayPal\",\n \"externalTransactionId\":\"tx_1806\",\n \"paymentProviderTransactionId\":\"tx_1806\",\n \"address\":{\n \"fullName\":{\n \"firstName\":\"John\",\n \"lastName\":\"Smith\"\n },\n \"country\":\"US\",\n \"city\":\"New York\",\n \"zipCode\":\"92544\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"paidDate\":\"2020-03-18T16:47:59.244Z\"\n },\n \"shippingInfo\":{\n \"deliveryOption\":\"Express\",\n \"estimatedDeliveryTime\":\"Today\",\n \"shipmentDetails\":{\n \"address\":{\n \"fullName\":{\n \"firstName\":\"John\",\n \"lastName\":\"Smith\"\n },\n \"country\":\"US\",\n \"city\":\"New York\",\n \"zipCode\":\"92544\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"discount\":\"0\",\n \"tax\":\"1\",\n \"priceData\":{\n \"taxIncludedInPrice\":false,\n \"price\":\"3\"\n }\n }\n },\n \"read\":false,\n \"archived\":false,\n \"paymentStatus\":\"PAID\",\n \"fulfillmentStatus\":\"NOT_FULFILLED\",\n \"lineItems\":[\n {\n \"index\":1,\n \"quantity\":2,\n \"name\":\"my product\",\n \"productId\":\"a1f9d337-f831-4529-31e6-67db8fd4e1aa\",\n \"lineItemType\":\"PHYSICAL\",\n \"options\":[],\n \"customTextFields\":[],\n \"weight\":\"15\",\n \"sku\":\"12345678\",\n \"discount\":\"1\",\n \"tax\":\"1\",\n \"priceData\":{\n \"taxIncludedInPrice\":false,\n \"price\":\"5\",\n \"totalPrice\":\"10\"\n }\n }\n ],\n \"activities\":[\n {\n \"type\":\"ORDER_PLACED\",\n \"timestamp\":\"2020-03-18T16:47:59.222Z\"\n },\n {\n \"type\":\"ORDER_PAID\",\n \"timestamp\":\"2020-03-18T16:47:59.244Z\"\n }\n ],\n \"fulfillments\":[],\n \"discount\":{\n \"value\":\"1\"\n },\n \"buyerLanguage\":\"en\",\n \"channelInfo\":{\n \"type\":\"WEB\"\n },\n \"enteredBy\":{\n \"id\":\"e85274cf-047a-4989-baff-dac5e0c3971d\",\n \"identityType\":\"USER\"\n },\n \"lastUpdated\":\"2020-03-18T16:47:59.244Z\"\n }\n}"}},{"name":"CreateOrder","type":"METHOD","order":1,"content":{"title":"Create order example - minimum required fields","request":"curl 'https://www.wixapis.com/stores/v2/orders' \\\n--data-binary '{\n \"order\": {\n \"totals\": {\n \"subtotal\": \"10\",\n \"total\": \"10\"\n },\n \"billingInfo\": {\n \"address\": {\n \"email\": \"Ivanushka@example.com\"\n }\n },\n \"shippingInfo\": {\n \"shipmentDetails\": {\n \"address\": {\n \"email\": \"Ivanushka@example.com\"\n }\n }\n },\n \"paymentStatus\": \"PAID\",\n \"lineItems\": [\n {\n \"quantity\": 1,\n \"name\": \"my product\",\n \"priceData\": {\n \"price\": \"10\"\n }\n }\n ],\n \"channelInfo\": {\n \"type\": \"WEB\"\n }\n }\n }' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '","response":"{\n \"order\": {\n \"totals\": {\n \"subtotal\": \"7\",\n \"total\": \"10\"\n },\n \"billingInfo\": {\n \"address\": {\n \"email\": \"tomj5@example.com\"\n }\n },\n \"paymentStatus\": \"PAID\",\n \"lineItems\": [\n {\n \"quantity\": 1,\n \"price\": \"5\",\n \"name\": \"my product\"\n }\n ],\n \"channelInfo\": {\n \"type\": \"WEB\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v2/orders","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.orders.api.v2.OrdersWriteAPI","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.CREATE_ORDERS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-orders-api","serviceArtifactId":"com.wixpress.ecom.orders-reverse-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.orders.api.v2.CreateOrderRequest","responseMessage":"wix.orders.api.v2.CreateOrderResponse"},"legacyExamples":[{"name":"CreateOrder","type":"METHOD","order":2,"content":{"title":"Create order example - full order","request":"curl 'https://www.wixapis.com/stores/v2/orders' \\\n--data-binary '{\n \"order\": {\n \"totals\": {\n \"subtotal\": \"10\",\n \"shipping\": \"3\",\n \"tax\": \"3\",\n \"discount\": \"1\",\n \"total\": \"15\"\n },\n \"billingInfo\": {\n \"paymentMethod\": \"PayPal\",\n \"paymentProviderTransactionId\": \"tx_1806\",\n \"address\": {\n \"fullName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n },\n \"country\": \"US\",\n \"city\": \"New York\",\n \"zipCode\": \"92544\",\n \"phone\": \"+972 555234555\",\n \"email\": \"Ivanushka@example.com\"\n }\n },\n \"shippingInfo\": {\n \"deliveryOption\": \"Express\",\n \"estimatedDeliveryTime\": \"Today\",\n \"shippingRegion\": \"Domestic\",\n \"shipmentDetails\": {\n \"address\": {\n \"fullName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n },\n \"country\": \"US\",\n \"city\": \"New York\",\n \"zipCode\": \"92544\",\n \"phone\": \"+972 555234555\",\n \"email\": \"Ivanushka@example.com\"\n },\n \"tax\": \"1\",\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"3\"\n }\n }\n },\n \"paymentStatus\": \"PAID\",\n \"lineItems\": [\n {\n \"quantity\": 2,\n \"discount\": \"1\",\n \"tax\": \"1\",\n \"name\": \"my product\",\n \"productId\": \"a1f9d337-f831-4529-31e6-67db8fd4e1aa\",\n \"lineItemType\": \"PHYSICAL\",\n \"weight\": \"15\",\n \"sku\": \"12345678\",\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"5\"\n }\n }\n ],\n \"channelInfo\": {\n \"type\": \"WEB\"\n }\n }\n }' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '","response":"{\n \"order\":{\n \"id\":\"fedb19f5-bd4c-4bfc-b2d1-212538319611\",\n \"number\":10096,\n \"dateCreated\":\"2020-03-18T16:47:59.222Z\",\n \"currency\":\"USD\",\n \"weightUnit\":\"LB\",\n \"totals\":{\n \"subtotal\":\"10\",\n \"shipping\":\"3\",\n \"tax\":\"3\",\n \"discount\":\"1\",\n \"total\":\"15\",\n \"weight\":\"30\",\n \"quantity\":2\n },\n \"billingInfo\":{\n \"paymentMethod\":\"PayPal\",\n \"externalTransactionId\":\"tx_1806\",\n \"paymentProviderTransactionId\":\"tx_1806\",\n \"address\":{\n \"fullName\":{\n \"firstName\":\"John\",\n \"lastName\":\"Smith\"\n },\n \"country\":\"US\",\n \"city\":\"New York\",\n \"zipCode\":\"92544\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"paidDate\":\"2020-03-18T16:47:59.244Z\"\n },\n \"shippingInfo\":{\n \"deliveryOption\":\"Express\",\n \"estimatedDeliveryTime\":\"Today\",\n \"shipmentDetails\":{\n \"address\":{\n \"fullName\":{\n \"firstName\":\"John\",\n \"lastName\":\"Smith\"\n },\n \"country\":\"US\",\n \"city\":\"New York\",\n \"zipCode\":\"92544\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"discount\":\"0\",\n \"tax\":\"1\",\n \"priceData\":{\n \"taxIncludedInPrice\":false,\n \"price\":\"3\"\n }\n }\n },\n \"read\":false,\n \"archived\":false,\n \"paymentStatus\":\"PAID\",\n \"fulfillmentStatus\":\"NOT_FULFILLED\",\n \"lineItems\":[\n {\n \"index\":1,\n \"quantity\":2,\n \"name\":\"my product\",\n \"productId\":\"a1f9d337-f831-4529-31e6-67db8fd4e1aa\",\n \"lineItemType\":\"PHYSICAL\",\n \"options\":[],\n \"customTextFields\":[],\n \"weight\":\"15\",\n \"sku\":\"12345678\",\n \"discount\":\"1\",\n \"tax\":\"1\",\n \"priceData\":{\n \"taxIncludedInPrice\":false,\n \"price\":\"5\",\n \"totalPrice\":\"10\"\n }\n }\n ],\n \"activities\":[\n {\n \"type\":\"ORDER_PLACED\",\n \"timestamp\":\"2020-03-18T16:47:59.222Z\"\n },\n {\n \"type\":\"ORDER_PAID\",\n \"timestamp\":\"2020-03-18T16:47:59.244Z\"\n }\n ],\n \"fulfillments\":[],\n \"discount\":{\n \"value\":\"1\"\n },\n \"buyerLanguage\":\"en\",\n \"channelInfo\":{\n \"type\":\"WEB\"\n },\n \"enteredBy\":{\n \"id\":\"e85274cf-047a-4989-baff-dac5e0c3971d\",\n \"identityType\":\"USER\"\n },\n \"lastUpdated\":\"2020-03-18T16:47:59.244Z\"\n }\n}"}},{"name":"CreateOrder","type":"METHOD","order":1,"content":{"title":"Create order example - minimum required fields","request":"curl 'https://www.wixapis.com/stores/v2/orders' \\\n--data-binary '{\n \"order\": {\n \"totals\": {\n \"subtotal\": \"10\",\n \"total\": \"10\"\n },\n \"billingInfo\": {\n \"address\": {\n \"email\": \"Ivanushka@example.com\"\n }\n },\n \"shippingInfo\": {\n \"shipmentDetails\": {\n \"address\": {\n \"email\": \"Ivanushka@example.com\"\n }\n }\n },\n \"paymentStatus\": \"PAID\",\n \"lineItems\": [\n {\n \"quantity\": 1,\n \"name\": \"my product\",\n \"priceData\": {\n \"price\": \"10\"\n }\n }\n ],\n \"channelInfo\": {\n \"type\": \"WEB\"\n }\n }\n }' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '","response":"{\n \"order\": {\n \"totals\": {\n \"subtotal\": \"7\",\n \"total\": \"10\"\n },\n \"billingInfo\": {\n \"address\": {\n \"email\": \"tomj5@example.com\"\n }\n },\n \"paymentStatus\": \"PAID\",\n \"lineItems\": [\n {\n \"quantity\": 1,\n \"price\": \"5\",\n \"name\": \"my product\"\n }\n ],\n \"channelInfo\": {\n \"type\": \"WEB\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Create Order","slugifiedName":"create-order"},"deprecationDetails":{"message":"Stores Create Order has been replaced with eCommerce Create Order.","replacedBy":"CreateOrder","targetRemovalDate":"2024-09-04"},"permissionScopes":[{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Update Order Email","description":"

\n\n__Deprecation Notice:__\n\nThis endpoint has been replaced with\n[eCommerce Update Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/update-order)\nand will be removed on September 4, 2024.\n\n

\n\nUpdates the email address of a specified order's billing info.\nIf shipping was selected as the delivery method, shipping info email will also be updated.","operationId":"wix.orders.api.v2.OrdersWriteAPI.UpdateOrderEmail","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"orderId","description":"Order ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.orders.api.v2.UpdateOrderEmailResponse","description":""}},"deprecated":true,"servers":[{"url":"https://www.wixapis.com/stores/v2/orders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v2/orders","destinationPath":"/v2/orders","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateOrderEmailRequest","description":"","properties":{"email":{"description":"New email address for billing and shipping info.","maxLength":100,"format":"EMAIL","title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["orderId"]}}},"x-wix-docs":{"deprecated":{"message":"Stores Update Order Email has been replaced with eCommerce Update Order.","replacedBy":"UpdateOrder","targetRemovalDate":"2024-09-04"}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.orders.api.v2.OrdersWriteAPI","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_ORDERS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-orders-api","serviceArtifactId":"com.wixpress.ecom.orders-reverse-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.orders.api.v2.UpdateOrderEmailRequest","responseMessage":"wix.orders.api.v2.UpdateOrderEmailResponse"},"deprecated":{"message":"Stores Update Order Email has been replaced with eCommerce Update Order.","replacedBy":"UpdateOrder","targetRemovalDate":"2024-09-04"},"legacyExamples":[{"name":"UpdateOrderEmail","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH 'https://www.wixapis.com/stores/v2/orders/4b070345-5813-49b6-b0ad-2125e5ca5b50/updateEmail' \\\n--data-binary '{\n \"orderId\":\"4b070345-5813-49b6-b0ad-2125e5ca5b50\",\n \"email\":\"JohnSmith@example.com\"\n}' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"jsonrpc\": \"2.0\",\n \"id\": 4,\n \"result\": {\n \"order\": {\n \"id\": \"4b070345-5813-49b6-b0ad-2125e5ca5b50\",\n \"number\": 10124,\n \"dateCreated\": \"2020-08-26T11:43:42.028Z\",\n \"buyerInfo\": {\n \"id\": \"ebb9e43a-29b9-4c3f-b117-2a3a9e85ce09\",\n \"type\": \"MEMBER\",\n \"identityType\": \"MEMBER\",\n \"firstName\": \"Naor\",\n \"lastName\": \"Lipa\",\n \"phone\": \"545442147\",\n \"email\": \"Ivanushka@example.com\"\n },\n \"currency\": \"USD\",\n \"weightUnit\": \"LB\",\n \"totals\": {\n \"subtotal\": \"248.0\",\n \"shipping\": \"15.0\",\n \"tax\": \"6.79\",\n \"discount\": \"0.0\",\n \"total\": \"269.79\",\n \"weight\": \"1000.0\",\n \"quantity\": 3\n },\n \"billingInfo\": {\n \"paymentMethod\": \"Stripe\",\n \"externalTransactionId\": \"pi_1HKN2aEQJH0qyaWeKASeZehh\",\n \"paymentProviderTransactionId\": \"pi_1HKN2aEQJH0qyaWeKASeZehh\",\n \"paymentGatewayTransactionId\": \"3b2a27a0-7723-4e67-bbc0-f10fc749f16b\",\n \"address\": {\n \"fullName\": {\n \"firstName\": \"Naor\",\n \"lastName\": \"Lipa\"\n },\n \"country\": \"IN\",\n \"subdivision\": \"IN-WB\",\n \"city\": \"Kolkata\",\n \"zipCode\": \"700091\",\n \"phone\": \"545442147\",\n \"email\": \"Ivanushka@example.com\",\n \"addressLine1\": \"SDF Building, GP Block, Sector V, Bidhannagar, Kolkata, West Bengal 700091, India\"\n },\n \"paidDate\": \"2020-08-26T11:43:45.563Z\"\n },\n \"shippingInfo\": {\n \"deliveryOption\": \"standard\",\n \"estimatedDeliveryTime\": \"10-20\",\n \"shippingRegion\": \"Region 3\",\n \"shipmentDetails\": {\n \"address\": {\n \"fullName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n },\n \"country\": \"US\",\n \"city\": \"New York\",\n \"zipCode\": \"92544\",\n \"phone\": \"+972 555234555\",\n \"email\": \"Ivanushka@example.com\"\n },\n \"discount\": \"0.0\",\n \"tax\": \"0.39\",\n \"priceData\": {\n \"price\": \"15.0\"\n }\n }\n },\n \"read\": true,\n \"paymentStatus\": \"PAID\",\n \"lineItems\": [\n {\n \"index\": 1,\n \"quantity\": 2,\n \"price\": \"84.0\",\n \"name\": \"Women's hoodies Black Pink kpop\",\n \"translatedName\": \"Women's hoodies Black Pink kpop\",\n \"productId\": \"cecada02-47c2-4f4c-b15a-4258a2fa758b\",\n \"totalPrice\": \"168.0\",\n \"lineItemType\": \"PHYSICAL\",\n \"options\": [\n {\n \"option\": \"Color\",\n \"selection\": \"Gray\"\n },\n {\n \"option\": \"Size\",\n \"selection\": \"L\"\n }\n ],\n \"mediaItem\": {\n \"mediaType\": \"IMAGE\",\n \"url\": \"https://static.wixstatic.com/media/9a1bff_cd5b6c34f83c4d01a8814b713ee9a750~mv2.jpg/v1/fit/w_800,h_800,q_90/file.jpg\",\n \"width\": 800,\n \"height\": 800,\n \"mediaId\": \"9a1bff_cd5b6c34f83c4d01a8814b713ee9a750~mv2.jpg\",\n \"id\": \"9a1bff_cd5b6c34f83c4d01a8814b713ee9a750~mv2.jpg\"\n },\n \"sku\": \"14:691;5:361385-32954066607\",\n \"variantId\": \"00000000-0000-005f-0005-a48308e4493f\",\n \"fulfillerId\": \"f4ef9627-612a-4b63-b8bd-edb7831dcc92\",\n \"discount\": \"0.0\",\n \"tax\": \"0.0\",\n \"taxGroupId\": \"1cabe02f-1a30-4952-920f-36977f3259ef\",\n \"priceData\": {\n \"price\": \"84.0\",\n \"totalPrice\": \"168.0\"\n }\n },\n {\n \"index\": 2,\n \"quantity\": 1,\n \"price\": \"80.0\",\n \"name\": \"Boring turtle\",\n \"translatedName\": \"Boring turtle\",\n \"productId\": \"762c3bc6-c4f8-fb4d-456e-24beb6f052aa\",\n \"totalPrice\": \"80.0\",\n \"lineItemType\": \"PHYSICAL\",\n \"options\": [\n {\n \"option\": \"Color\",\n \"selection\": \"White\"\n }\n ],\n \"weight\": \"1000.0\",\n \"mediaItem\": {\n \"mediaType\": \"IMAGE\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_6c4f375f7665657935776b~mv2_d_6016_4016_s_4_2.jpg/v1/fit/w_6016,h_4016,q_90/file.jpg\",\n \"width\": 6016,\n \"height\": 4016,\n \"mediaId\": \"nsplsh_6c4f375f7665657935776b~mv2_d_6016_4016_s_4_2.jpg\",\n \"id\": \"nsplsh_6c4f375f7665657935776b~mv2_d_6016_4016_s_4_2.jpg\"\n },\n \"variantId\": \"00000000-0000-0000-0000-000000000000\",\n \"fulfillerId\": \"0dae62fd-c36e-48db-a151-1f4b3d924d62\",\n \"discount\": \"0.0\",\n \"tax\": \"6.4\",\n \"priceData\": {\n \"price\": \"80.0\",\n \"totalPrice\": \"80.0\"\n }\n }\n ],\n \"activities\": [\n {\n \"type\": \"ORDER_PLACED\",\n \"timestamp\": \"2020-08-26T11:43:42.028Z\"\n },\n {\n \"type\": \"ORDER_PAID\",\n \"timestamp\": \"2020-08-26T11:43:45.563Z\"\n },\n {\n \"type\": \"INVOICE_WAS_SET\",\n \"timestamp\": \"2020-08-30T08:28:35.633Z\"\n },\n {\n \"type\": \"EMAIL_EDITED\",\n \"timestamp\": \"2020-09-01T16:19:33.386Z\"\n }\n ],\n \"invoiceInfo\": {\n \"id\": \"93518b17-b10a-45ca-87fe-a1e9c02b402a\",\n \"source\": \"WIX\"\n },\n \"cartId\": \"7e27f5a6-ebab-449f-8a40-d88f8a65f683\",\n \"buyerLanguage\": \"en\",\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"enteredBy\": {\n \"id\": \"ebb9e43a-29b9-4c3f-b117-2a3a9e85ce09\",\n \"identityType\": \"MEMBER\"\n },\n \"lastUpdated\": \"2020-09-01T16:19:33.386Z\",\n \"numericId\": \"10124\"\n }\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"patch","path":"/v2/orders/{orderId}/updateEmail","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.orders.api.v2.OrdersWriteAPI","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_ORDERS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-orders-api","serviceArtifactId":"com.wixpress.ecom.orders-reverse-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.orders.api.v2.UpdateOrderEmailRequest","responseMessage":"wix.orders.api.v2.UpdateOrderEmailResponse"},"legacyExamples":[{"name":"UpdateOrderEmail","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X PATCH 'https://www.wixapis.com/stores/v2/orders/4b070345-5813-49b6-b0ad-2125e5ca5b50/updateEmail' \\\n--data-binary '{\n \"orderId\":\"4b070345-5813-49b6-b0ad-2125e5ca5b50\",\n \"email\":\"JohnSmith@example.com\"\n}' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"jsonrpc\": \"2.0\",\n \"id\": 4,\n \"result\": {\n \"order\": {\n \"id\": \"4b070345-5813-49b6-b0ad-2125e5ca5b50\",\n \"number\": 10124,\n \"dateCreated\": \"2020-08-26T11:43:42.028Z\",\n \"buyerInfo\": {\n \"id\": \"ebb9e43a-29b9-4c3f-b117-2a3a9e85ce09\",\n \"type\": \"MEMBER\",\n \"identityType\": \"MEMBER\",\n \"firstName\": \"Naor\",\n \"lastName\": \"Lipa\",\n \"phone\": \"545442147\",\n \"email\": \"Ivanushka@example.com\"\n },\n \"currency\": \"USD\",\n \"weightUnit\": \"LB\",\n \"totals\": {\n \"subtotal\": \"248.0\",\n \"shipping\": \"15.0\",\n \"tax\": \"6.79\",\n \"discount\": \"0.0\",\n \"total\": \"269.79\",\n \"weight\": \"1000.0\",\n \"quantity\": 3\n },\n \"billingInfo\": {\n \"paymentMethod\": \"Stripe\",\n \"externalTransactionId\": \"pi_1HKN2aEQJH0qyaWeKASeZehh\",\n \"paymentProviderTransactionId\": \"pi_1HKN2aEQJH0qyaWeKASeZehh\",\n \"paymentGatewayTransactionId\": \"3b2a27a0-7723-4e67-bbc0-f10fc749f16b\",\n \"address\": {\n \"fullName\": {\n \"firstName\": \"Naor\",\n \"lastName\": \"Lipa\"\n },\n \"country\": \"IN\",\n \"subdivision\": \"IN-WB\",\n \"city\": \"Kolkata\",\n \"zipCode\": \"700091\",\n \"phone\": \"545442147\",\n \"email\": \"Ivanushka@example.com\",\n \"addressLine1\": \"SDF Building, GP Block, Sector V, Bidhannagar, Kolkata, West Bengal 700091, India\"\n },\n \"paidDate\": \"2020-08-26T11:43:45.563Z\"\n },\n \"shippingInfo\": {\n \"deliveryOption\": \"standard\",\n \"estimatedDeliveryTime\": \"10-20\",\n \"shippingRegion\": \"Region 3\",\n \"shipmentDetails\": {\n \"address\": {\n \"fullName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n },\n \"country\": \"US\",\n \"city\": \"New York\",\n \"zipCode\": \"92544\",\n \"phone\": \"+972 555234555\",\n \"email\": \"Ivanushka@example.com\"\n },\n \"discount\": \"0.0\",\n \"tax\": \"0.39\",\n \"priceData\": {\n \"price\": \"15.0\"\n }\n }\n },\n \"read\": true,\n \"paymentStatus\": \"PAID\",\n \"lineItems\": [\n {\n \"index\": 1,\n \"quantity\": 2,\n \"price\": \"84.0\",\n \"name\": \"Women's hoodies Black Pink kpop\",\n \"translatedName\": \"Women's hoodies Black Pink kpop\",\n \"productId\": \"cecada02-47c2-4f4c-b15a-4258a2fa758b\",\n \"totalPrice\": \"168.0\",\n \"lineItemType\": \"PHYSICAL\",\n \"options\": [\n {\n \"option\": \"Color\",\n \"selection\": \"Gray\"\n },\n {\n \"option\": \"Size\",\n \"selection\": \"L\"\n }\n ],\n \"mediaItem\": {\n \"mediaType\": \"IMAGE\",\n \"url\": \"https://static.wixstatic.com/media/9a1bff_cd5b6c34f83c4d01a8814b713ee9a750~mv2.jpg/v1/fit/w_800,h_800,q_90/file.jpg\",\n \"width\": 800,\n \"height\": 800,\n \"mediaId\": \"9a1bff_cd5b6c34f83c4d01a8814b713ee9a750~mv2.jpg\",\n \"id\": \"9a1bff_cd5b6c34f83c4d01a8814b713ee9a750~mv2.jpg\"\n },\n \"sku\": \"14:691;5:361385-32954066607\",\n \"variantId\": \"00000000-0000-005f-0005-a48308e4493f\",\n \"fulfillerId\": \"f4ef9627-612a-4b63-b8bd-edb7831dcc92\",\n \"discount\": \"0.0\",\n \"tax\": \"0.0\",\n \"taxGroupId\": \"1cabe02f-1a30-4952-920f-36977f3259ef\",\n \"priceData\": {\n \"price\": \"84.0\",\n \"totalPrice\": \"168.0\"\n }\n },\n {\n \"index\": 2,\n \"quantity\": 1,\n \"price\": \"80.0\",\n \"name\": \"Boring turtle\",\n \"translatedName\": \"Boring turtle\",\n \"productId\": \"762c3bc6-c4f8-fb4d-456e-24beb6f052aa\",\n \"totalPrice\": \"80.0\",\n \"lineItemType\": \"PHYSICAL\",\n \"options\": [\n {\n \"option\": \"Color\",\n \"selection\": \"White\"\n }\n ],\n \"weight\": \"1000.0\",\n \"mediaItem\": {\n \"mediaType\": \"IMAGE\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_6c4f375f7665657935776b~mv2_d_6016_4016_s_4_2.jpg/v1/fit/w_6016,h_4016,q_90/file.jpg\",\n \"width\": 6016,\n \"height\": 4016,\n \"mediaId\": \"nsplsh_6c4f375f7665657935776b~mv2_d_6016_4016_s_4_2.jpg\",\n \"id\": \"nsplsh_6c4f375f7665657935776b~mv2_d_6016_4016_s_4_2.jpg\"\n },\n \"variantId\": \"00000000-0000-0000-0000-000000000000\",\n \"fulfillerId\": \"0dae62fd-c36e-48db-a151-1f4b3d924d62\",\n \"discount\": \"0.0\",\n \"tax\": \"6.4\",\n \"priceData\": {\n \"price\": \"80.0\",\n \"totalPrice\": \"80.0\"\n }\n }\n ],\n \"activities\": [\n {\n \"type\": \"ORDER_PLACED\",\n \"timestamp\": \"2020-08-26T11:43:42.028Z\"\n },\n {\n \"type\": \"ORDER_PAID\",\n \"timestamp\": \"2020-08-26T11:43:45.563Z\"\n },\n {\n \"type\": \"INVOICE_WAS_SET\",\n \"timestamp\": \"2020-08-30T08:28:35.633Z\"\n },\n {\n \"type\": \"EMAIL_EDITED\",\n \"timestamp\": \"2020-09-01T16:19:33.386Z\"\n }\n ],\n \"invoiceInfo\": {\n \"id\": \"93518b17-b10a-45ca-87fe-a1e9c02b402a\",\n \"source\": \"WIX\"\n },\n \"cartId\": \"7e27f5a6-ebab-449f-8a40-d88f8a65f683\",\n \"buyerLanguage\": \"en\",\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"enteredBy\": {\n \"id\": \"ebb9e43a-29b9-4c3f-b117-2a3a9e85ce09\",\n \"identityType\": \"MEMBER\"\n },\n \"lastUpdated\": \"2020-09-01T16:19:33.386Z\",\n \"numericId\": \"10124\"\n }\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update Order Email","slugifiedName":"update-order-email"},"deprecationDetails":{"message":"Stores Update Order Email has been replaced with eCommerce Update Order.","replacedBy":"UpdateOrder","targetRemovalDate":"2024-09-04"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Update Order Shipping Address","description":"

\n\n__Deprecation Notice:__\n\nThis endpoint has been replaced with\n[eCommerce Update Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/update-order)\nand will be removed on September 4, 2024.\n\n

\n\nUpdates the shipping address of a specified order.","operationId":"wix.orders.api.v2.OrdersWriteAPI.UpdateOrderShippingAddress","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"orderId","description":"Order ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.orders.api.v2.UpdateOrderShippingAddressResponse","description":""}},"deprecated":true,"servers":[{"url":"https://www.wixapis.com/stores/v2/orders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v2/orders","destinationPath":"/v2/orders","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateOrderShippingAddressRequest","description":"","properties":{"shippingAddress":{"description":"New order shipping address.","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.Address","summary":"shippingAddress","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["orderId"]}}},"x-wix-docs":{"deprecated":{"message":"Stores Update Order Shipping Address has been replaced with eCommerce Update Order.","replacedBy":"UpdateOrder","targetRemovalDate":"2024-09-04"}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.orders.api.v2.OrdersWriteAPI","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_ORDERS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-orders-api","serviceArtifactId":"com.wixpress.ecom.orders-reverse-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.orders.api.v2.UpdateOrderShippingAddressRequest","responseMessage":"wix.orders.api.v2.UpdateOrderShippingAddressResponse"},"deprecated":{"message":"Stores Update Order Shipping Address has been replaced with eCommerce Update Order.","replacedBy":"UpdateOrder","targetRemovalDate":"2024-09-04"},"legacyExamples":[{"name":"UpdateOrderShippingAddress","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X PUT 'https://www.wixapis.com/stores/v2/orders/4b070345-5813-49b6-b0ad-2125e5ca5b50/updateShippingAddress' \\\n--data-binary '{\n \"orderId\":\"4b070345-5813-49b6-b0ad-2125e5ca5b50\",\n \"shippingAddress\":{\n \"fullName\":{\n \"firstName\":\"John\",\n \"lastName\":\"Smith\"\n },\n \"country\":\"US\",\n \"city\":\"New York\",\n \"zipCode\":\"92544\",\n \"phone\":\"+972 555234555\"\n }\n}' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"jsonrpc\": \"2.0\",\n \"id\": 2,\n \"result\": {\n \"order\": {\n \"id\": \"4b070345-5813-49b6-b0ad-2125e5ca5b50\",\n \"number\": 10124,\n \"dateCreated\": \"2020-08-26T11:43:42.028Z\",\n \"buyerInfo\": {\n \"id\": \"ebb9e43a-29b9-4c3f-b117-2a3a9e85ce09\",\n \"type\": \"MEMBER\",\n \"identityType\": \"MEMBER\",\n \"firstName\": \"Naor\",\n \"lastName\": \"Lipa\",\n \"phone\": \"545442147\",\n \"email\": \"Ivanushka@example.com\"\n },\n \"currency\": \"USD\",\n \"weightUnit\": \"LB\",\n \"totals\": {\n \"subtotal\": \"248.0\",\n \"shipping\": \"15.0\",\n \"tax\": \"6.79\",\n \"discount\": \"0.0\",\n \"total\": \"269.79\",\n \"weight\": \"1000.0\",\n \"quantity\": 3\n },\n \"billingInfo\": {\n \"paymentMethod\": \"Stripe\",\n \"externalTransactionId\": \"pi_1HKN2aEQJH0qyaWeKASeZehh\",\n \"paymentProviderTransactionId\": \"pi_1HKN2aEQJH0qyaWeKASeZehh\",\n \"paymentGatewayTransactionId\": \"3b2a27a0-7723-4e67-bbc0-f10fc749f16b\",\n \"address\": {\n \"fullName\": {\n \"firstName\": \"Naor\",\n \"lastName\": \"Lipa\"\n },\n \"country\": \"IN\",\n \"subdivision\": \"IN-WB\",\n \"city\": \"Kolkata\",\n \"zipCode\": \"700091\",\n \"phone\": \"545442147\",\n \"email\": \"Ivanushka@example.com\",\n \"addressLine1\": \"SDF Building, GP Block, Sector V, Bidhannagar, Kolkata, West Bengal 700091, India\"\n },\n \"paidDate\": \"2020-08-26T11:43:45.563Z\"\n },\n \"shippingInfo\": {\n \"deliveryOption\": \"standard\",\n \"estimatedDeliveryTime\": \"10-20\",\n \"shippingRegion\": \"Region 3\",\n \"shipmentDetails\": {\n \"address\": {\n \"fullName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n },\n \"country\": \"US\",\n \"city\": \"New York\",\n \"zipCode\": \"92544\",\n \"phone\": \"+972 555234555\",\n \"email\": \"Ivanushka@example.com\"\n },\n \"discount\": \"0.0\",\n \"tax\": \"0.39\",\n \"priceData\": {\n \"price\": \"15.0\"\n }\n }\n },\n \"read\": true,\n \"paymentStatus\": \"PAID\",\n \"lineItems\": [\n {\n \"index\": 1,\n \"quantity\": 2,\n \"price\": \"84.0\",\n \"name\": \"Women's hoodies Black Pink kpop\",\n \"translatedName\": \"Women's hoodies Black Pink kpop\",\n \"productId\": \"cecada02-47c2-4f4c-b15a-4258a2fa758b\",\n \"totalPrice\": \"168.0\",\n \"lineItemType\": \"PHYSICAL\",\n \"options\": [\n {\n \"option\": \"Color\",\n \"selection\": \"Gray\"\n },\n {\n \"option\": \"Size\",\n \"selection\": \"L\"\n }\n ],\n \"mediaItem\": {\n \"mediaType\": \"IMAGE\",\n \"url\": \"https://static.wixstatic.com/media/9a1bff_cd5b6c34f83c4d01a8814b713ee9a750~mv2.jpg/v1/fit/w_800,h_800,q_90/file.jpg\",\n \"width\": 800,\n \"height\": 800,\n \"mediaId\": \"9a1bff_cd5b6c34f83c4d01a8814b713ee9a750~mv2.jpg\",\n \"id\": \"9a1bff_cd5b6c34f83c4d01a8814b713ee9a750~mv2.jpg\"\n },\n \"sku\": \"14:691;5:361385-32954066607\",\n \"variantId\": \"00000000-0000-005f-0005-a48308e4493f\",\n \"fulfillerId\": \"f4ef9627-612a-4b63-b8bd-edb7831dcc92\",\n \"discount\": \"0.0\",\n \"tax\": \"0.0\",\n \"taxGroupId\": \"1cabe02f-1a30-4952-920f-36977f3259ef\",\n \"priceData\": {\n \"price\": \"84.0\",\n \"totalPrice\": \"168.0\"\n }\n },\n {\n \"index\": 2,\n \"quantity\": 1,\n \"price\": \"80.0\",\n \"name\": \"Boring turtle\",\n \"translatedName\": \"Boring turtle\",\n \"productId\": \"762c3bc6-c4f8-fb4d-456e-24beb6f052aa\",\n \"totalPrice\": \"80.0\",\n \"lineItemType\": \"PHYSICAL\",\n \"options\": [\n {\n \"option\": \"Color\",\n \"selection\": \"White\"\n }\n ],\n \"weight\": \"1000.0\",\n \"mediaItem\": {\n \"mediaType\": \"IMAGE\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_6c4f375f7665657935776b~mv2_d_6016_4016_s_4_2.jpg/v1/fit/w_6016,h_4016,q_90/file.jpg\",\n \"width\": 6016,\n \"height\": 4016,\n \"mediaId\": \"nsplsh_6c4f375f7665657935776b~mv2_d_6016_4016_s_4_2.jpg\",\n \"id\": \"nsplsh_6c4f375f7665657935776b~mv2_d_6016_4016_s_4_2.jpg\"\n },\n \"variantId\": \"00000000-0000-0000-0000-000000000000\",\n \"fulfillerId\": \"0dae62fd-c36e-48db-a151-1f4b3d924d62\",\n \"discount\": \"0.0\",\n \"tax\": \"6.4\",\n \"priceData\": {\n \"price\": \"80.0\",\n \"totalPrice\": \"80.0\"\n }\n }\n ],\n \"activities\": [\n {\n \"type\": \"ORDER_PLACED\",\n \"timestamp\": \"2020-08-26T11:43:42.028Z\"\n },\n {\n \"type\": \"ORDER_PAID\",\n \"timestamp\": \"2020-08-26T11:43:45.563Z\"\n },\n {\n \"type\": \"INVOICE_WAS_SET\",\n \"timestamp\": \"2020-08-30T08:28:35.633Z\"\n },\n {\n \"type\": \"SHIPPING_ADDRESS_EDITED\",\n \"timestamp\": \"2020-09-01T08:38:45.823Z\"\n }\n ],\n \"invoiceInfo\": {\n \"id\": \"93518b17-b10a-45ca-87fe-a1e9c02b402a\",\n \"source\": \"WIX\"\n },\n \"cartId\": \"7e27f5a6-ebab-449f-8a40-d88f8a65f683\",\n \"buyerLanguage\": \"en\",\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"enteredBy\": {\n \"id\": \"ebb9e43a-29b9-4c3f-b117-2a3a9e85ce09\",\n \"identityType\": \"MEMBER\"\n },\n \"lastUpdated\": \"2020-09-01T16:19:33.386Z\",\n \"numericId\": \"10124\"\n }\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"put","path":"/v2/orders/{orderId}/updateShippingAddress","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.orders.api.v2.OrdersWriteAPI","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_ORDERS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-orders-api","serviceArtifactId":"com.wixpress.ecom.orders-reverse-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.orders.api.v2.UpdateOrderShippingAddressRequest","responseMessage":"wix.orders.api.v2.UpdateOrderShippingAddressResponse"},"legacyExamples":[{"name":"UpdateOrderShippingAddress","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X PUT 'https://www.wixapis.com/stores/v2/orders/4b070345-5813-49b6-b0ad-2125e5ca5b50/updateShippingAddress' \\\n--data-binary '{\n \"orderId\":\"4b070345-5813-49b6-b0ad-2125e5ca5b50\",\n \"shippingAddress\":{\n \"fullName\":{\n \"firstName\":\"John\",\n \"lastName\":\"Smith\"\n },\n \"country\":\"US\",\n \"city\":\"New York\",\n \"zipCode\":\"92544\",\n \"phone\":\"+972 555234555\"\n }\n}' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"jsonrpc\": \"2.0\",\n \"id\": 2,\n \"result\": {\n \"order\": {\n \"id\": \"4b070345-5813-49b6-b0ad-2125e5ca5b50\",\n \"number\": 10124,\n \"dateCreated\": \"2020-08-26T11:43:42.028Z\",\n \"buyerInfo\": {\n \"id\": \"ebb9e43a-29b9-4c3f-b117-2a3a9e85ce09\",\n \"type\": \"MEMBER\",\n \"identityType\": \"MEMBER\",\n \"firstName\": \"Naor\",\n \"lastName\": \"Lipa\",\n \"phone\": \"545442147\",\n \"email\": \"Ivanushka@example.com\"\n },\n \"currency\": \"USD\",\n \"weightUnit\": \"LB\",\n \"totals\": {\n \"subtotal\": \"248.0\",\n \"shipping\": \"15.0\",\n \"tax\": \"6.79\",\n \"discount\": \"0.0\",\n \"total\": \"269.79\",\n \"weight\": \"1000.0\",\n \"quantity\": 3\n },\n \"billingInfo\": {\n \"paymentMethod\": \"Stripe\",\n \"externalTransactionId\": \"pi_1HKN2aEQJH0qyaWeKASeZehh\",\n \"paymentProviderTransactionId\": \"pi_1HKN2aEQJH0qyaWeKASeZehh\",\n \"paymentGatewayTransactionId\": \"3b2a27a0-7723-4e67-bbc0-f10fc749f16b\",\n \"address\": {\n \"fullName\": {\n \"firstName\": \"Naor\",\n \"lastName\": \"Lipa\"\n },\n \"country\": \"IN\",\n \"subdivision\": \"IN-WB\",\n \"city\": \"Kolkata\",\n \"zipCode\": \"700091\",\n \"phone\": \"545442147\",\n \"email\": \"Ivanushka@example.com\",\n \"addressLine1\": \"SDF Building, GP Block, Sector V, Bidhannagar, Kolkata, West Bengal 700091, India\"\n },\n \"paidDate\": \"2020-08-26T11:43:45.563Z\"\n },\n \"shippingInfo\": {\n \"deliveryOption\": \"standard\",\n \"estimatedDeliveryTime\": \"10-20\",\n \"shippingRegion\": \"Region 3\",\n \"shipmentDetails\": {\n \"address\": {\n \"fullName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n },\n \"country\": \"US\",\n \"city\": \"New York\",\n \"zipCode\": \"92544\",\n \"phone\": \"+972 555234555\",\n \"email\": \"Ivanushka@example.com\"\n },\n \"discount\": \"0.0\",\n \"tax\": \"0.39\",\n \"priceData\": {\n \"price\": \"15.0\"\n }\n }\n },\n \"read\": true,\n \"paymentStatus\": \"PAID\",\n \"lineItems\": [\n {\n \"index\": 1,\n \"quantity\": 2,\n \"price\": \"84.0\",\n \"name\": \"Women's hoodies Black Pink kpop\",\n \"translatedName\": \"Women's hoodies Black Pink kpop\",\n \"productId\": \"cecada02-47c2-4f4c-b15a-4258a2fa758b\",\n \"totalPrice\": \"168.0\",\n \"lineItemType\": \"PHYSICAL\",\n \"options\": [\n {\n \"option\": \"Color\",\n \"selection\": \"Gray\"\n },\n {\n \"option\": \"Size\",\n \"selection\": \"L\"\n }\n ],\n \"mediaItem\": {\n \"mediaType\": \"IMAGE\",\n \"url\": \"https://static.wixstatic.com/media/9a1bff_cd5b6c34f83c4d01a8814b713ee9a750~mv2.jpg/v1/fit/w_800,h_800,q_90/file.jpg\",\n \"width\": 800,\n \"height\": 800,\n \"mediaId\": \"9a1bff_cd5b6c34f83c4d01a8814b713ee9a750~mv2.jpg\",\n \"id\": \"9a1bff_cd5b6c34f83c4d01a8814b713ee9a750~mv2.jpg\"\n },\n \"sku\": \"14:691;5:361385-32954066607\",\n \"variantId\": \"00000000-0000-005f-0005-a48308e4493f\",\n \"fulfillerId\": \"f4ef9627-612a-4b63-b8bd-edb7831dcc92\",\n \"discount\": \"0.0\",\n \"tax\": \"0.0\",\n \"taxGroupId\": \"1cabe02f-1a30-4952-920f-36977f3259ef\",\n \"priceData\": {\n \"price\": \"84.0\",\n \"totalPrice\": \"168.0\"\n }\n },\n {\n \"index\": 2,\n \"quantity\": 1,\n \"price\": \"80.0\",\n \"name\": \"Boring turtle\",\n \"translatedName\": \"Boring turtle\",\n \"productId\": \"762c3bc6-c4f8-fb4d-456e-24beb6f052aa\",\n \"totalPrice\": \"80.0\",\n \"lineItemType\": \"PHYSICAL\",\n \"options\": [\n {\n \"option\": \"Color\",\n \"selection\": \"White\"\n }\n ],\n \"weight\": \"1000.0\",\n \"mediaItem\": {\n \"mediaType\": \"IMAGE\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_6c4f375f7665657935776b~mv2_d_6016_4016_s_4_2.jpg/v1/fit/w_6016,h_4016,q_90/file.jpg\",\n \"width\": 6016,\n \"height\": 4016,\n \"mediaId\": \"nsplsh_6c4f375f7665657935776b~mv2_d_6016_4016_s_4_2.jpg\",\n \"id\": \"nsplsh_6c4f375f7665657935776b~mv2_d_6016_4016_s_4_2.jpg\"\n },\n \"variantId\": \"00000000-0000-0000-0000-000000000000\",\n \"fulfillerId\": \"0dae62fd-c36e-48db-a151-1f4b3d924d62\",\n \"discount\": \"0.0\",\n \"tax\": \"6.4\",\n \"priceData\": {\n \"price\": \"80.0\",\n \"totalPrice\": \"80.0\"\n }\n }\n ],\n \"activities\": [\n {\n \"type\": \"ORDER_PLACED\",\n \"timestamp\": \"2020-08-26T11:43:42.028Z\"\n },\n {\n \"type\": \"ORDER_PAID\",\n \"timestamp\": \"2020-08-26T11:43:45.563Z\"\n },\n {\n \"type\": \"INVOICE_WAS_SET\",\n \"timestamp\": \"2020-08-30T08:28:35.633Z\"\n },\n {\n \"type\": \"SHIPPING_ADDRESS_EDITED\",\n \"timestamp\": \"2020-09-01T08:38:45.823Z\"\n }\n ],\n \"invoiceInfo\": {\n \"id\": \"93518b17-b10a-45ca-87fe-a1e9c02b402a\",\n \"source\": \"WIX\"\n },\n \"cartId\": \"7e27f5a6-ebab-449f-8a40-d88f8a65f683\",\n \"buyerLanguage\": \"en\",\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"enteredBy\": {\n \"id\": \"ebb9e43a-29b9-4c3f-b117-2a3a9e85ce09\",\n \"identityType\": \"MEMBER\"\n },\n \"lastUpdated\": \"2020-09-01T16:19:33.386Z\",\n \"numericId\": \"10124\"\n }\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update Order Shipping Address","slugifiedName":"update-order-shipping-address"},"deprecationDetails":{"message":"Stores Update Order Shipping Address has been replaced with eCommerce Update Order.","replacedBy":"UpdateOrder","targetRemovalDate":"2024-09-04"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Get Order","description":"

\n\n__Deprecation Notice:__\n\nThis endpoint has been replaced with\n[eCommerce Get Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/get-order)\nand will be removed on September 4, 2024.\n\n

\n\nReturns an order with the provided ID.","operationId":"wix.orders.api.v2.OrdersV2.GetOrder","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Requested order ID","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.orders.api.v2.GetOrderResponseV2","description":""}},"deprecated":true,"servers":[{"url":"https://www.wixapis.com/stores/v2/orders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v2/orders","destinationPath":"/v2/orders","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.orders.api.v2.OrdersV2","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_ORDERS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-orders-api","serviceArtifactId":"com.wixpress.ecom.orders-reverse-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.orders.api.v2.GetOrderRequestV2","responseMessage":"wix.orders.api.v2.GetOrderResponseV2"},"deprecated":{"message":"Stores Get Order has been replaced with eCommerce Get Order.","replacedBy":"GetOrder","targetRemovalDate":"2024-09-04"},"legacyExamples":[{"name":"GetOrder","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl 'https://www.wixapis.com/stores/v2/orders/7001d34b-11a6-4a34-8746-dc8ababeca42' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"order\": {\n \"id\": \"7001d34b-11a6-4a34-8746-dc8ababeca42\",\n \"number\": 10012,\n \"dateCreated\": \"2023-03-07T10:24:03.380Z\",\n \"buyerInfo\": {\n \"id\": \"24de6f0b-60ce-4faa-9138-2e39f1415615\",\n \"type\": \"CONTACT\",\n \"identityType\": \"CONTACT\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"0555555555\",\n \"email\": \"janedoe@gmail.com\",\n \"contactId\": \"24de6f0b-60ce-4faa-9138-2e39f1415615\"\n },\n \"currency\": \"USD\",\n \"weightUnit\": \"KG\",\n \"totals\": {\n \"subtotal\": \"130.00\",\n \"shipping\": \"10.0\",\n \"tax\": \"0.0\",\n \"discount\": \"10.0\",\n \"total\": \"130.00\",\n \"weight\": \"0\",\n \"quantity\": 3\n },\n \"billingInfo\": {\n \"paymentMethod\": \"In Person\",\n \"paymentGatewayTransactionId\": \"620fb6cf-c11f-4b29-8a37-d1bb550a5912\",\n \"address\": {\n \"fullName\": {\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\"\n },\n \"country\": \"US\",\n \"subdivision\": \"US-NY\",\n \"city\": \"New York\",\n \"zipCode\": \"10173\",\n \"phone\": \"0555555555\",\n \"email\": \"janedoe@gmail.com\",\n \"addressLine1\": \"525 5th Avenue\"\n },\n \"refundableByPaymentProvider\": true\n },\n \"shippingInfo\": {\n \"deliveryOption\": \"Standard US Shipping\",\n \"shippingRegion\": \"USA shipping\",\n \"code\": \"ed5bbce2-9533-dff4-7db0-13702fd139c5\",\n \"shipmentDetails\": {\n \"address\": {\n \"fullName\": {\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\"\n },\n \"country\": \"US\",\n \"subdivision\": \"US-NY\",\n \"city\": \"New York\",\n \"zipCode\": \"10173\",\n \"phone\": \"0555555555\",\n \"email\": \"janedoe@gmail.com\",\n \"addressLine1\": \"525 5th Avenue\"\n },\n \"trackingInfo\": {\n \"trackingNumber\": \"43255\",\n \"shippingProvider\": \"FEDEX\",\n \"trackingLink\": \"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=43255\"\n },\n \"discount\": \"0\",\n \"tax\": \"0.0\",\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"10\"\n }\n }\n },\n \"buyerNote\": \"Happy Birthday!\",\n \"read\": true,\n \"archived\": false,\n \"paymentStatus\": \"PARTIALLY_PAID\",\n \"fulfillmentStatus\": \"PARTIALLY_FULFILLED\",\n \"lineItems\": [\n {\n \"index\": 1,\n \"quantity\": 1,\n \"price\": \"85.00\",\n \"name\": \"Shoe\",\n \"translatedName\": \"Shoe\",\n \"productId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"totalPrice\": \"85.00\",\n \"lineItemType\": \"PHYSICAL\",\n \"options\": [\n {\n \"option\": \"Color\",\n \"selection\": \"Brown\"\n }\n ],\n \"customTextFields\": [],\n \"mediaItem\": {\n \"mediaType\": \"IMAGE\",\n \"url\": \"https://static.wixstatic.com/media/3c76e2_bf235c38610f4d2a905db71095b351cf~mv2.jpg/v1/fit/w_1000,h_1000,q_90/file.jpg\",\n \"width\": 1000,\n \"height\": 1000,\n \"mediaId\": \"3c76e2_bf235c38610f4d2a905db71095b351cf~mv2.jpg\",\n \"id\": \"3c76e2_bf235c38610f4d2a905db71095b351cf~mv2.jpg\"\n },\n \"sku\": \"364215376135191\",\n \"variantId\": \"2f430d69-9b75-4874-bfbd-c5f6fa5aff3d\",\n \"discount\": \"0\",\n \"tax\": \"0.0\",\n \"taxIncludedInPrice\": false,\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"85.00\",\n \"totalPrice\": \"85.00\"\n },\n \"refundedQuantity\": 0\n },\n {\n \"index\": 2,\n \"quantity\": 1,\n \"price\": \"35.00\",\n \"name\": \"Watch\",\n \"translatedName\": \"Watch\",\n \"productId\": \"1a2d7e83-4bef-31d5-09e1-3326ee271c09\",\n \"totalPrice\": \"35.00\",\n \"lineItemType\": \"PHYSICAL\",\n \"options\": [\n {\n \"option\": \"Size\",\n \"selection\": \"Large\"\n },\n {\n \"option\": \"Color\",\n \"selection\": \"Black\"\n }\n ],\n \"customTextFields\": [],\n \"mediaItem\": {\n \"mediaType\": \"IMAGE\",\n \"url\": \"https://static.wixstatic.com/media/3c76e2_8891bbe3372a428aac976ac59aa0ac74~mv2.jpg/v1/fit/w_1000,h_1000,q_90/file.jpg\",\n \"width\": 1000,\n \"height\": 1000,\n \"mediaId\": \"3c76e2_8891bbe3372a428aac976ac59aa0ac74~mv2.jpg\",\n \"id\": \"3c76e2_8891bbe3372a428aac976ac59aa0ac74~mv2.jpg\"\n },\n \"sku\": \"217537123517253\",\n \"variantId\": \"63f56c6d-8dcb-491c-8e06-0220b3cd89f2\",\n \"discount\": \"0\",\n \"tax\": \"0.0\",\n \"taxIncludedInPrice\": false,\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"35.00\",\n \"totalPrice\": \"35.00\"\n },\n \"refundedQuantity\": 0\n },\n {\n \"index\": 3,\n \"quantity\": 1,\n \"price\": \"10.00\",\n \"name\": \"Shirt\",\n \"translatedName\": \"Shirt\",\n \"productId\": \"c8539b66-7a44-fe18-affc-afec4be8562a\",\n \"totalPrice\": \"10.00\",\n \"lineItemType\": \"PHYSICAL\",\n \"options\": [],\n \"customTextFields\": [],\n \"mediaItem\": {\n \"mediaType\": \"IMAGE\",\n \"url\": \"https://static.wixstatic.com/media/3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg/v1/fit/w_1000,h_1000,q_90/file.jpg\",\n \"width\": 1000,\n \"height\": 1000,\n \"mediaId\": \"3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg\",\n \"id\": \"3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg\"\n },\n \"sku\": \"364115376135191\",\n \"variantId\": \"00000000-0000-0000-0000-000000000000\",\n \"discount\": \"10.0\",\n \"tax\": \"0.0\",\n \"taxIncludedInPrice\": false,\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"10.00\",\n \"totalPrice\": \"10.00\"\n },\n \"refundedQuantity\": 0\n }\n ],\n \"activities\": [\n {\n \"type\": \"ORDER_PLACED\",\n \"timestamp\": \"2023-03-07T10:24:03.380Z\"\n },\n {\n \"type\": \"TRACKING_NUMBER_ADDED\",\n \"timestamp\": \"2023-03-07T10:24:56.406Z\"\n },\n {\n \"type\": \"TRACKING_LINK_WAS_SET\",\n \"timestamp\": \"2023-03-07T10:24:56.406Z\"\n },\n {\n \"type\": \"ORDER_PARTIALLY_PAID\",\n \"timestamp\": \"2023-03-07T10:25:22.889Z\"\n }\n ],\n \"fulfillments\": [\n {\n \"id\": \"47451ae1-7325-4ef6-a0d8-fb91ffa88e2e\",\n \"dateCreated\": \"2023-03-07T10:24:56.406Z\",\n \"lineItems\": [\n {\n \"index\": 1,\n \"quantity\": 1\n },\n {\n \"index\": 2,\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"43255\",\n \"shippingProvider\": \"fedex\",\n \"trackingLink\": \"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=43255\"\n }\n }\n ],\n \"discount\": {\n \"value\": \"10.0\",\n \"appliedCoupon\": {\n \"couponId\": \"fbb94b06-7447-4161-9c48-59bfcdc39e77\",\n \"name\": \"SUMMERSALE10\",\n \"code\": \"SUMMERSALE10\"\n }\n },\n \"cartId\": \"1e61e838-d3a0-4ab7-8348-b37d1d954919\",\n \"buyerLanguage\": \"en\",\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"enteredBy\": {\n \"id\": \"24de6f0b-60ce-4faa-9138-2e39f1415615\",\n \"identityType\": \"CONTACT\"\n },\n \"lastUpdated\": \"2023-03-07T10:25:22.889Z\",\n \"numericId\": \"10012\",\n \"refunds\": [],\n \"checkoutId\": \"d118aa97-1bcb-462e-9265-3603f6e07df6\",\n \"isInternalOrderCreate\": false\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v2/orders/{id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.orders.api.v2.OrdersV2","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_ORDERS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-orders-api","serviceArtifactId":"com.wixpress.ecom.orders-reverse-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.orders.api.v2.GetOrderRequestV2","responseMessage":"wix.orders.api.v2.GetOrderResponseV2"},"legacyExamples":[{"name":"GetOrder","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl 'https://www.wixapis.com/stores/v2/orders/7001d34b-11a6-4a34-8746-dc8ababeca42' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"order\": {\n \"id\": \"7001d34b-11a6-4a34-8746-dc8ababeca42\",\n \"number\": 10012,\n \"dateCreated\": \"2023-03-07T10:24:03.380Z\",\n \"buyerInfo\": {\n \"id\": \"24de6f0b-60ce-4faa-9138-2e39f1415615\",\n \"type\": \"CONTACT\",\n \"identityType\": \"CONTACT\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"0555555555\",\n \"email\": \"janedoe@gmail.com\",\n \"contactId\": \"24de6f0b-60ce-4faa-9138-2e39f1415615\"\n },\n \"currency\": \"USD\",\n \"weightUnit\": \"KG\",\n \"totals\": {\n \"subtotal\": \"130.00\",\n \"shipping\": \"10.0\",\n \"tax\": \"0.0\",\n \"discount\": \"10.0\",\n \"total\": \"130.00\",\n \"weight\": \"0\",\n \"quantity\": 3\n },\n \"billingInfo\": {\n \"paymentMethod\": \"In Person\",\n \"paymentGatewayTransactionId\": \"620fb6cf-c11f-4b29-8a37-d1bb550a5912\",\n \"address\": {\n \"fullName\": {\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\"\n },\n \"country\": \"US\",\n \"subdivision\": \"US-NY\",\n \"city\": \"New York\",\n \"zipCode\": \"10173\",\n \"phone\": \"0555555555\",\n \"email\": \"janedoe@gmail.com\",\n \"addressLine1\": \"525 5th Avenue\"\n },\n \"refundableByPaymentProvider\": true\n },\n \"shippingInfo\": {\n \"deliveryOption\": \"Standard US Shipping\",\n \"shippingRegion\": \"USA shipping\",\n \"code\": \"ed5bbce2-9533-dff4-7db0-13702fd139c5\",\n \"shipmentDetails\": {\n \"address\": {\n \"fullName\": {\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\"\n },\n \"country\": \"US\",\n \"subdivision\": \"US-NY\",\n \"city\": \"New York\",\n \"zipCode\": \"10173\",\n \"phone\": \"0555555555\",\n \"email\": \"janedoe@gmail.com\",\n \"addressLine1\": \"525 5th Avenue\"\n },\n \"trackingInfo\": {\n \"trackingNumber\": \"43255\",\n \"shippingProvider\": \"FEDEX\",\n \"trackingLink\": \"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=43255\"\n },\n \"discount\": \"0\",\n \"tax\": \"0.0\",\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"10\"\n }\n }\n },\n \"buyerNote\": \"Happy Birthday!\",\n \"read\": true,\n \"archived\": false,\n \"paymentStatus\": \"PARTIALLY_PAID\",\n \"fulfillmentStatus\": \"PARTIALLY_FULFILLED\",\n \"lineItems\": [\n {\n \"index\": 1,\n \"quantity\": 1,\n \"price\": \"85.00\",\n \"name\": \"Shoe\",\n \"translatedName\": \"Shoe\",\n \"productId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n \"totalPrice\": \"85.00\",\n \"lineItemType\": \"PHYSICAL\",\n \"options\": [\n {\n \"option\": \"Color\",\n \"selection\": \"Brown\"\n }\n ],\n \"customTextFields\": [],\n \"mediaItem\": {\n \"mediaType\": \"IMAGE\",\n \"url\": \"https://static.wixstatic.com/media/3c76e2_bf235c38610f4d2a905db71095b351cf~mv2.jpg/v1/fit/w_1000,h_1000,q_90/file.jpg\",\n \"width\": 1000,\n \"height\": 1000,\n \"mediaId\": \"3c76e2_bf235c38610f4d2a905db71095b351cf~mv2.jpg\",\n \"id\": \"3c76e2_bf235c38610f4d2a905db71095b351cf~mv2.jpg\"\n },\n \"sku\": \"364215376135191\",\n \"variantId\": \"2f430d69-9b75-4874-bfbd-c5f6fa5aff3d\",\n \"discount\": \"0\",\n \"tax\": \"0.0\",\n \"taxIncludedInPrice\": false,\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"85.00\",\n \"totalPrice\": \"85.00\"\n },\n \"refundedQuantity\": 0\n },\n {\n \"index\": 2,\n \"quantity\": 1,\n \"price\": \"35.00\",\n \"name\": \"Watch\",\n \"translatedName\": \"Watch\",\n \"productId\": \"1a2d7e83-4bef-31d5-09e1-3326ee271c09\",\n \"totalPrice\": \"35.00\",\n \"lineItemType\": \"PHYSICAL\",\n \"options\": [\n {\n \"option\": \"Size\",\n \"selection\": \"Large\"\n },\n {\n \"option\": \"Color\",\n \"selection\": \"Black\"\n }\n ],\n \"customTextFields\": [],\n \"mediaItem\": {\n \"mediaType\": \"IMAGE\",\n \"url\": \"https://static.wixstatic.com/media/3c76e2_8891bbe3372a428aac976ac59aa0ac74~mv2.jpg/v1/fit/w_1000,h_1000,q_90/file.jpg\",\n \"width\": 1000,\n \"height\": 1000,\n \"mediaId\": \"3c76e2_8891bbe3372a428aac976ac59aa0ac74~mv2.jpg\",\n \"id\": \"3c76e2_8891bbe3372a428aac976ac59aa0ac74~mv2.jpg\"\n },\n \"sku\": \"217537123517253\",\n \"variantId\": \"63f56c6d-8dcb-491c-8e06-0220b3cd89f2\",\n \"discount\": \"0\",\n \"tax\": \"0.0\",\n \"taxIncludedInPrice\": false,\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"35.00\",\n \"totalPrice\": \"35.00\"\n },\n \"refundedQuantity\": 0\n },\n {\n \"index\": 3,\n \"quantity\": 1,\n \"price\": \"10.00\",\n \"name\": \"Shirt\",\n \"translatedName\": \"Shirt\",\n \"productId\": \"c8539b66-7a44-fe18-affc-afec4be8562a\",\n \"totalPrice\": \"10.00\",\n \"lineItemType\": \"PHYSICAL\",\n \"options\": [],\n \"customTextFields\": [],\n \"mediaItem\": {\n \"mediaType\": \"IMAGE\",\n \"url\": \"https://static.wixstatic.com/media/3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg/v1/fit/w_1000,h_1000,q_90/file.jpg\",\n \"width\": 1000,\n \"height\": 1000,\n \"mediaId\": \"3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg\",\n \"id\": \"3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg\"\n },\n \"sku\": \"364115376135191\",\n \"variantId\": \"00000000-0000-0000-0000-000000000000\",\n \"discount\": \"10.0\",\n \"tax\": \"0.0\",\n \"taxIncludedInPrice\": false,\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"10.00\",\n \"totalPrice\": \"10.00\"\n },\n \"refundedQuantity\": 0\n }\n ],\n \"activities\": [\n {\n \"type\": \"ORDER_PLACED\",\n \"timestamp\": \"2023-03-07T10:24:03.380Z\"\n },\n {\n \"type\": \"TRACKING_NUMBER_ADDED\",\n \"timestamp\": \"2023-03-07T10:24:56.406Z\"\n },\n {\n \"type\": \"TRACKING_LINK_WAS_SET\",\n \"timestamp\": \"2023-03-07T10:24:56.406Z\"\n },\n {\n \"type\": \"ORDER_PARTIALLY_PAID\",\n \"timestamp\": \"2023-03-07T10:25:22.889Z\"\n }\n ],\n \"fulfillments\": [\n {\n \"id\": \"47451ae1-7325-4ef6-a0d8-fb91ffa88e2e\",\n \"dateCreated\": \"2023-03-07T10:24:56.406Z\",\n \"lineItems\": [\n {\n \"index\": 1,\n \"quantity\": 1\n },\n {\n \"index\": 2,\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"43255\",\n \"shippingProvider\": \"fedex\",\n \"trackingLink\": \"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=43255\"\n }\n }\n ],\n \"discount\": {\n \"value\": \"10.0\",\n \"appliedCoupon\": {\n \"couponId\": \"fbb94b06-7447-4161-9c48-59bfcdc39e77\",\n \"name\": \"SUMMERSALE10\",\n \"code\": \"SUMMERSALE10\"\n }\n },\n \"cartId\": \"1e61e838-d3a0-4ab7-8348-b37d1d954919\",\n \"buyerLanguage\": \"en\",\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"enteredBy\": {\n \"id\": \"24de6f0b-60ce-4faa-9138-2e39f1415615\",\n \"identityType\": \"CONTACT\"\n },\n \"lastUpdated\": \"2023-03-07T10:25:22.889Z\",\n \"numericId\": \"10012\",\n \"refunds\": [],\n \"checkoutId\": \"d118aa97-1bcb-462e-9265-3603f6e07df6\",\n \"isInternalOrderCreate\": false\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Order","slugifiedName":"get-order"},"deprecationDetails":{"message":"Stores Get Order has been replaced with eCommerce Get Order.","replacedBy":"GetOrder","targetRemovalDate":"2024-09-04"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Query Orders","description":"

\n\n__Deprecation Notice:__\n\nThis endpoint has been replaced with\n[eCommerce Search Orders](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/search-orders)\nand will be removed on September 4, 2024.\n\n

\n\nReturns a list of up to 100 orders, given the provided paging, sorting and filters.\nSee [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.\nHidden orders are not returned.","operationId":"wix.orders.api.v2.OrdersV2.QueryOrders","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.orders.api.v2.QueryOrdersResponseV2","description":""}},"deprecated":true,"servers":[{"url":"https://www.wixapis.com/stores/v2/orders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v2/orders","destinationPath":"/v2/orders","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryOrdersRequestV2","description":"","properties":{"query":{"description":"Query","$ref":"#/components/schemas/wix.orders.api.v2.Query","summary":"query","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false}}},"x-wix-docs":{"deprecated":{"message":"Stores Query Orders has been replaced with eCommerce Search Orders.","replacedBy":"SearchOrders","targetRemovalDate":"2024-09-04"}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.orders.api.v2.OrdersV2","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_ORDERS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-orders-api","serviceArtifactId":"com.wixpress.ecom.orders-reverse-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.orders.api.v2.QueryOrdersRequestV2","responseMessage":"wix.orders.api.v2.QueryOrdersResponseV2"},"deprecated":{"message":"Stores Query Orders has been replaced with eCommerce Search Orders.","replacedBy":"SearchOrders","targetRemovalDate":"2024-09-04"},"legacyExamples":[{"name":"QueryOrders","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl 'https://www.wixapis.com/stores/v2/orders/query' \\\n--data-binary '{\n \"query\": {\n \"filter\": \"{\\\"paymentStatus\\\": \\\"PAID\\\"}\",\n \"paging\": {\n \"limit\": 1\n },\n \"sort\": \"[{\\\"number\\\": \\\"desc\\\"}]\"\n }\n }' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"orders\": [\n {\n \"id\": \"265c7d98-a7c3-48c4-89cd-bbdc00921eab\",\n \"number\": 10108,\n \"dateCreated\": \"2021-05-25T13:51:01.718Z\",\n \"buyerInfo\": {\n \"id\": \"f61f30cd-7474-47b7-95a2-339c0fcacbd3\",\n \"type\": \"CONTACT\",\n \"identityType\": \"CONTACT\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"+1234567890\",\n \"email\": \"janedoe@gmail.com\",\n \"contactId\": \"f61f30cd-7474-47b7-95a2-339c0fcacbd3\"\n },\n \"currency\": \"USD\",\n \"weightUnit\": \"KG\",\n \"totals\": {\n \"subtotal\": \"216.25\",\n \"shipping\": \"2.0\",\n \"tax\": \"8.22\",\n \"discount\": \"10.81\",\n \"total\": \"215.66\",\n \"weight\": \"1.5\",\n \"quantity\": 5\n },\n \"billingInfo\": {\n \"paymentMethod\": \"offline\",\n \"paymentGatewayTransactionId\": \"5c08a09b-867b-49bf-afeb-db59548419e0\",\n \"address\": {\n \"fullName\": {\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\"\n },\n \"country\": \"US\",\n \"subdivision\": \"US-NY\",\n \"city\": \"New York\",\n \"zipCode\": \"10011\",\n \"phone\": \"+1234567890\",\n \"email\": \"janedoe@gmail.com\",\n \"addressLine1\": \"235 West 23rd Street\",\n \"addressLine2\": \"3rd floor\"\n },\n \"paidDate\": \"2021-05-25T13:55:55.130Z\"\n },\n \"shippingInfo\": {\n \"deliveryOption\": \"U.S Shipping\",\n \"estimatedDeliveryTime\": \"3 - 5 business days\",\n \"shippingRegion\": \"Region 3\",\n \"code\": \"a0fde0a4-6f4e-3716-64be-c0acbde1696a\",\n \"shipmentDetails\": {\n \"address\": {\n \"fullName\": {\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\"\n },\n \"country\": \"US\",\n \"subdivision\": \"US-NY\",\n \"city\": \"New York\",\n \"zipCode\": \"10011\",\n \"phone\": \"+1234567890\",\n \"email\": \"janedoe@gmail.com\",\n \"addressLine1\": \"235 West 23rd Street\",\n \"addressLine2\": \"3rd floor\"\n },\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"UPS\",\n \"trackingLink\": \"https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=12345\"\n },\n \"discount\": \"0.0\",\n \"tax\": \"0.0\",\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"2.0\"\n }\n }\n },\n \"read\": true,\n \"archived\": false,\n \"paymentStatus\": \"PAID\",\n \"fulfillmentStatus\": \"FULFILLED\",\n \"lineItems\": [\n {\n \"index\": 1,\n \"quantity\": 2,\n \"price\": \"35.0\",\n \"name\": \"Indonesian Blend\",\n \"translatedName\": \"Indonesian Blend\",\n \"productId\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a\",\n \"totalPrice\": \"70.0\",\n \"lineItemType\": \"PHYSICAL\",\n \"options\": [\n {\n \"option\": \"Weight\",\n \"selection\": \"250g\"\n },\n {\n \"option\": \"Ground for\",\n \"selection\": \"Stovetop\"\n }\n ],\n \"customTextFields\": [\n {\n \"title\": \"What would you like written on the custom label?\",\n \"value\": \"Hope you enjoy the coffee! :)\"\n }\n ],\n \"mediaItem\": {\n \"mediaType\": \"IMAGE\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg\",\n \"width\": 2977,\n \"height\": 3951,\n \"mediaId\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\",\n \"id\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\"\n },\n \"variantId\": \"00000000-0000-0020-0005-ad9cdc10d3b8\",\n \"discount\": \"3.5\",\n \"tax\": \"2.66\",\n \"taxIncludedInPrice\": false,\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"35.0\",\n \"totalPrice\": \"70.0\"\n },\n \"refundedQuantity\": 0\n },\n {\n \"index\": 2,\n \"quantity\": 3,\n \"price\": \"48.75\",\n \"name\": \"Brazilian Arabica\",\n \"translatedName\": \"Brazilian Arabica\",\n \"productId\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5\",\n \"totalPrice\": \"146.25\",\n \"lineItemType\": \"PHYSICAL\",\n \"options\": [\n {\n \"option\": \"Weight\",\n \"selection\": \"500g\"\n },\n {\n \"option\": \"Ground for\",\n \"selection\": \"Filter\"\n }\n ],\n \"customTextFields\": [\n {\n \"title\": \"What would you like written on the custom label?\",\n \"value\": \"This is great for the filter method.\"\n }\n ],\n \"weight\": \"0.5\",\n \"mediaItem\": {\n \"mediaType\": \"IMAGE\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg\",\n \"width\": 4517,\n \"height\": 2992,\n \"mediaId\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\",\n \"id\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\"\n },\n \"variantId\": \"00000000-0000-0040-0005-a316f7c67df7\",\n \"fulfillerId\": \"85e29287-a5bf-4c25-b303-a2ddc9d975e2\",\n \"discount\": \"7.31\",\n \"tax\": \"5.56\",\n \"taxIncludedInPrice\": false,\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"48.75\",\n \"totalPrice\": \"146.25\"\n },\n \"refundedQuantity\": 0\n }\n ],\n \"activities\": [\n {\n \"type\": \"ORDER_PLACED\",\n \"timestamp\": \"2021-05-25T13:51:01.718Z\"\n },\n {\n \"type\": \"TRACKING_NUMBER_ADDED\",\n \"timestamp\": \"2021-05-25T13:55:26.458Z\"\n },\n {\n \"type\": \"TRACKING_NUMBER_ADDED\",\n \"timestamp\": \"2021-05-25T13:55:47.605Z\"\n },\n {\n \"type\": \"ORDER_PAID\",\n \"timestamp\": \"2021-05-25T13:55:55.130Z\"\n }\n ],\n \"fulfillments\": [\n {\n \"id\": \"80f939c8-cdc4-44fe-a058-b54d506af170\",\n \"dateCreated\": \"2021-05-25T13:55:26.458Z\",\n \"lineItems\": [\n {\n \"index\": 1,\n \"quantity\": 2\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"ups\",\n \"trackingLink\": \"https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=12345\"\n }\n },\n {\n \"id\": \"eb9138ff-1490-4dbc-b053-743240b9ab8f\",\n \"dateCreated\": \"2021-05-25T13:55:47.605Z\",\n \"lineItems\": [\n {\n \"index\": 2,\n \"quantity\": 3\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"ups\",\n \"trackingLink\": \"https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=12345\"\n }\n }\n ],\n \"discount\": {\n \"value\": \"10.81\",\n \"appliedCoupon\": {\n \"couponId\": \"4294c3d3-1604-41b8-9ba5-119bb17d2d7d\",\n \"name\": \"5 percent - summer sale\",\n \"code\": \"SUMMERSALE5\"\n }\n },\n \"cartId\": \"d56e7d15-0f07-4723-9069-c90c5cdec230\",\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"enteredBy\": {\n \"id\": \"f61f30cd-7474-47b7-95a2-339c0fcacbd3\",\n \"identityType\": \"CONTACT\"\n },\n \"lastUpdated\": \"2021-05-25T13:55:55.130Z\",\n \"numericId\": \"10108\",\n \"refunds\": [],\n \"isInternalOrderCreate\": false\n }\n ],\n \"metadata\": {\n \"items\": 1,\n \"offset\": 0\n },\n \"totalResults\": 77\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v2/orders/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.orders.api.v2.OrdersV2","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.READ_ORDERS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-orders-api","serviceArtifactId":"com.wixpress.ecom.orders-reverse-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.orders.api.v2.QueryOrdersRequestV2","responseMessage":"wix.orders.api.v2.QueryOrdersResponseV2"},"legacyExamples":[{"name":"QueryOrders","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl 'https://www.wixapis.com/stores/v2/orders/query' \\\n--data-binary '{\n \"query\": {\n \"filter\": \"{\\\"paymentStatus\\\": \\\"PAID\\\"}\",\n \"paging\": {\n \"limit\": 1\n },\n \"sort\": \"[{\\\"number\\\": \\\"desc\\\"}]\"\n }\n }' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"orders\": [\n {\n \"id\": \"265c7d98-a7c3-48c4-89cd-bbdc00921eab\",\n \"number\": 10108,\n \"dateCreated\": \"2021-05-25T13:51:01.718Z\",\n \"buyerInfo\": {\n \"id\": \"f61f30cd-7474-47b7-95a2-339c0fcacbd3\",\n \"type\": \"CONTACT\",\n \"identityType\": \"CONTACT\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"+1234567890\",\n \"email\": \"janedoe@gmail.com\",\n \"contactId\": \"f61f30cd-7474-47b7-95a2-339c0fcacbd3\"\n },\n \"currency\": \"USD\",\n \"weightUnit\": \"KG\",\n \"totals\": {\n \"subtotal\": \"216.25\",\n \"shipping\": \"2.0\",\n \"tax\": \"8.22\",\n \"discount\": \"10.81\",\n \"total\": \"215.66\",\n \"weight\": \"1.5\",\n \"quantity\": 5\n },\n \"billingInfo\": {\n \"paymentMethod\": \"offline\",\n \"paymentGatewayTransactionId\": \"5c08a09b-867b-49bf-afeb-db59548419e0\",\n \"address\": {\n \"fullName\": {\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\"\n },\n \"country\": \"US\",\n \"subdivision\": \"US-NY\",\n \"city\": \"New York\",\n \"zipCode\": \"10011\",\n \"phone\": \"+1234567890\",\n \"email\": \"janedoe@gmail.com\",\n \"addressLine1\": \"235 West 23rd Street\",\n \"addressLine2\": \"3rd floor\"\n },\n \"paidDate\": \"2021-05-25T13:55:55.130Z\"\n },\n \"shippingInfo\": {\n \"deliveryOption\": \"U.S Shipping\",\n \"estimatedDeliveryTime\": \"3 - 5 business days\",\n \"shippingRegion\": \"Region 3\",\n \"code\": \"a0fde0a4-6f4e-3716-64be-c0acbde1696a\",\n \"shipmentDetails\": {\n \"address\": {\n \"fullName\": {\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\"\n },\n \"country\": \"US\",\n \"subdivision\": \"US-NY\",\n \"city\": \"New York\",\n \"zipCode\": \"10011\",\n \"phone\": \"+1234567890\",\n \"email\": \"janedoe@gmail.com\",\n \"addressLine1\": \"235 West 23rd Street\",\n \"addressLine2\": \"3rd floor\"\n },\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"UPS\",\n \"trackingLink\": \"https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=12345\"\n },\n \"discount\": \"0.0\",\n \"tax\": \"0.0\",\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"2.0\"\n }\n }\n },\n \"read\": true,\n \"archived\": false,\n \"paymentStatus\": \"PAID\",\n \"fulfillmentStatus\": \"FULFILLED\",\n \"lineItems\": [\n {\n \"index\": 1,\n \"quantity\": 2,\n \"price\": \"35.0\",\n \"name\": \"Indonesian Blend\",\n \"translatedName\": \"Indonesian Blend\",\n \"productId\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a\",\n \"totalPrice\": \"70.0\",\n \"lineItemType\": \"PHYSICAL\",\n \"options\": [\n {\n \"option\": \"Weight\",\n \"selection\": \"250g\"\n },\n {\n \"option\": \"Ground for\",\n \"selection\": \"Stovetop\"\n }\n ],\n \"customTextFields\": [\n {\n \"title\": \"What would you like written on the custom label?\",\n \"value\": \"Hope you enjoy the coffee! :)\"\n }\n ],\n \"mediaItem\": {\n \"mediaType\": \"IMAGE\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/v1/fit/w_2977,h_3951,q_90/file.jpg\",\n \"width\": 2977,\n \"height\": 3951,\n \"mediaId\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\",\n \"id\": \"nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg\"\n },\n \"variantId\": \"00000000-0000-0020-0005-ad9cdc10d3b8\",\n \"discount\": \"3.5\",\n \"tax\": \"2.66\",\n \"taxIncludedInPrice\": false,\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"35.0\",\n \"totalPrice\": \"70.0\"\n },\n \"refundedQuantity\": 0\n },\n {\n \"index\": 2,\n \"quantity\": 3,\n \"price\": \"48.75\",\n \"name\": \"Brazilian Arabica\",\n \"translatedName\": \"Brazilian Arabica\",\n \"productId\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5\",\n \"totalPrice\": \"146.25\",\n \"lineItemType\": \"PHYSICAL\",\n \"options\": [\n {\n \"option\": \"Weight\",\n \"selection\": \"500g\"\n },\n {\n \"option\": \"Ground for\",\n \"selection\": \"Filter\"\n }\n ],\n \"customTextFields\": [\n {\n \"title\": \"What would you like written on the custom label?\",\n \"value\": \"This is great for the filter method.\"\n }\n ],\n \"weight\": \"0.5\",\n \"mediaItem\": {\n \"mediaType\": \"IMAGE\",\n \"url\": \"https://static.wixstatic.com/media/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg/v1/fit/w_4517,h_2992,q_90/file.jpg\",\n \"width\": 4517,\n \"height\": 2992,\n \"mediaId\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\",\n \"id\": \"nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg\"\n },\n \"variantId\": \"00000000-0000-0040-0005-a316f7c67df7\",\n \"fulfillerId\": \"85e29287-a5bf-4c25-b303-a2ddc9d975e2\",\n \"discount\": \"7.31\",\n \"tax\": \"5.56\",\n \"taxIncludedInPrice\": false,\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"48.75\",\n \"totalPrice\": \"146.25\"\n },\n \"refundedQuantity\": 0\n }\n ],\n \"activities\": [\n {\n \"type\": \"ORDER_PLACED\",\n \"timestamp\": \"2021-05-25T13:51:01.718Z\"\n },\n {\n \"type\": \"TRACKING_NUMBER_ADDED\",\n \"timestamp\": \"2021-05-25T13:55:26.458Z\"\n },\n {\n \"type\": \"TRACKING_NUMBER_ADDED\",\n \"timestamp\": \"2021-05-25T13:55:47.605Z\"\n },\n {\n \"type\": \"ORDER_PAID\",\n \"timestamp\": \"2021-05-25T13:55:55.130Z\"\n }\n ],\n \"fulfillments\": [\n {\n \"id\": \"80f939c8-cdc4-44fe-a058-b54d506af170\",\n \"dateCreated\": \"2021-05-25T13:55:26.458Z\",\n \"lineItems\": [\n {\n \"index\": 1,\n \"quantity\": 2\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"ups\",\n \"trackingLink\": \"https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=12345\"\n }\n },\n {\n \"id\": \"eb9138ff-1490-4dbc-b053-743240b9ab8f\",\n \"dateCreated\": \"2021-05-25T13:55:47.605Z\",\n \"lineItems\": [\n {\n \"index\": 2,\n \"quantity\": 3\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"ups\",\n \"trackingLink\": \"https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=12345\"\n }\n }\n ],\n \"discount\": {\n \"value\": \"10.81\",\n \"appliedCoupon\": {\n \"couponId\": \"4294c3d3-1604-41b8-9ba5-119bb17d2d7d\",\n \"name\": \"5 percent - summer sale\",\n \"code\": \"SUMMERSALE5\"\n }\n },\n \"cartId\": \"d56e7d15-0f07-4723-9069-c90c5cdec230\",\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"enteredBy\": {\n \"id\": \"f61f30cd-7474-47b7-95a2-339c0fcacbd3\",\n \"identityType\": \"CONTACT\"\n },\n \"lastUpdated\": \"2021-05-25T13:55:55.130Z\",\n \"numericId\": \"10108\",\n \"refunds\": [],\n \"isInternalOrderCreate\": false\n }\n ],\n \"metadata\": {\n \"items\": 1,\n \"offset\": 0\n },\n \"totalResults\": 77\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Query Orders","slugifiedName":"query-orders"},"deprecationDetails":{"message":"Stores Query Orders has been replaced with eCommerce Search Orders.","replacedBy":"SearchOrders","targetRemovalDate":"2024-09-04"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Create Fulfillment","description":"

\n\n__Deprecation Notice:__\n\nThis endpoint has been replaced with\n[eCommerce Create Fulfillment](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/create-fulfillment)\nand will be removed on September 4, 2024.\n\n

\n\nCreates a fulfillment (a subset of an order, with line items that are being shipped together) based on the body parameters passed with the request.\nIf the site owner has requested it, calling this request will trigger an email to the customer (based on the Wix store settings).","operationId":"wix.orders.api.v2.OrdersV2.CreateFulfillment","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"orderId","description":"Order ID (to which the fulfillment will be related).","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.orders.api.v2.CreateFulfillmentResponse","description":""}},"deprecated":true,"servers":[{"url":"https://www.wixapis.com/stores/v2/orders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v2/orders","destinationPath":"/v2/orders","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateFulfillmentRequest","description":"","properties":{"fulfillment":{"description":"Fulfillment info.","$ref":"#/components/schemas/wix.orders.api.v2.Fulfillment","summary":"fulfillment","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["fulfillment","orderId"]}}},"x-wix-docs":{"deprecated":{"message":"Stores Create Fulfillment has been replaced with eCommerce Create Fulfillment.","replacedBy":"CreateFulfillment","targetRemovalDate":"2024-09-04"}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.orders.api.v2.OrdersV2","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_ORDERS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-orders-api","serviceArtifactId":"com.wixpress.ecom.orders-reverse-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.orders.api.v2.CreateFulfillmentRequest","responseMessage":"wix.orders.api.v2.CreateFulfillmentResponse"},"deprecated":{"message":"Stores Create Fulfillment has been replaced with eCommerce Create Fulfillment.","replacedBy":"CreateFulfillment","targetRemovalDate":"2024-09-04"},"legacyExamples":[{"name":"CreateFulfillment","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl 'https://www.wixapis.com/stores/v2/orders/fedb19f5-bd4c-4bfc-b2d1-212538319611/fulfillments' \\\n--data-binary '{\n \"fulfillment\": {\n \"lineItems\": [\n {\n \"index\": 1,\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"shippingProvider\": \"fedex\",\n \"trackingNumber\": \"1234\",\n \"trackingLink\": \"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=1234\"\n }\n }\n }' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"id\":\"0175f0e8-f877-40a9-b980-0d336c64c726\",\n \"order\":{\n \"id\":\"fedb19f5-bd4c-4bfc-b2d1-212538319611\",\n \"number\":10096,\n \"dateCreated\":\"2020-03-18T16:47:59.222Z\",\n \"buyerInfo\":{\n \"id\":\"e9a69747-6816-42fb-87bf-4cd60a408b4e\",\n \"type\":\"CONTACT\",\n \"identityType\":\"CONTACT\",\n \"firstName\":\"John\",\n \"lastName\":\"Smith\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"currency\":\"USD\",\n \"weightUnit\":\"LB\",\n \"totals\":{\n \"subtotal\":\"10\",\n \"shipping\":\"3\",\n \"tax\":\"3\",\n \"discount\":\"1\",\n \"total\":\"15\",\n \"weight\":\"30\",\n \"quantity\":2\n },\n \"billingInfo\":{\n \"paymentMethod\":\"PayPal\",\n \"externalTransactionId\":\"tx_1806\",\n \"paymentProviderTransactionId\":\"tx_1806\",\n \"address\":{\n \"fullName\":{\n \"firstName\":\"John\",\n \"lastName\":\"Smith\"\n },\n \"country\":\"US\",\n \"city\":\"New York\",\n \"zipCode\":\"92544\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"paidDate\":\"2020-03-18T16:47:59.244Z\"\n },\n \"shippingInfo\":{\n \"deliveryOption\":\"Express\",\n \"estimatedDeliveryTime\":\"Today\",\n \"shipmentDetails\":{\n \"address\":{\n \"fullName\":{\n \"firstName\":\"John\",\n \"lastName\":\"Smith\"\n },\n \"country\":\"US\",\n \"city\":\"New York\",\n \"zipCode\":\"92544\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"trackingInfo\":{\n \"trackingNumber\":\"1234\",\n \"shippingProvider\":\"FEDEX\",\n \"trackingLink\":\"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=1234\"\n },\n \"discount\":\"0\",\n \"tax\":\"1\",\n \"priceData\":{\n \"taxIncludedInPrice\":false,\n \"price\":\"3\"\n }\n }\n },\n \"read\":false,\n \"archived\":false,\n \"paymentStatus\":\"PAID\",\n \"fulfillmentStatus\":\"PARTIALLY_FULFILLED\",\n \"lineItems\":[\n {\n \"index\":1,\n \"quantity\":2,\n \"price\":\"5\",\n \"name\":\"my product\",\n \"productId\":\"a1f9d337-f831-4529-31e6-67db8fd4e1aa\",\n \"totalPrice\":\"10\",\n \"lineItemType\":\"PHYSICAL\",\n \"options\":[\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v2/orders/{orderId}/fulfillments","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.orders.api.v2.OrdersV2","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_ORDERS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-orders-api","serviceArtifactId":"com.wixpress.ecom.orders-reverse-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.orders.api.v2.CreateFulfillmentRequest","responseMessage":"wix.orders.api.v2.CreateFulfillmentResponse"},"legacyExamples":[{"name":"CreateFulfillment","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl 'https://www.wixapis.com/stores/v2/orders/fedb19f5-bd4c-4bfc-b2d1-212538319611/fulfillments' \\\n--data-binary '{\n \"fulfillment\": {\n \"lineItems\": [\n {\n \"index\": 1,\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"shippingProvider\": \"fedex\",\n \"trackingNumber\": \"1234\",\n \"trackingLink\": \"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=1234\"\n }\n }\n }' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"id\":\"0175f0e8-f877-40a9-b980-0d336c64c726\",\n \"order\":{\n \"id\":\"fedb19f5-bd4c-4bfc-b2d1-212538319611\",\n \"number\":10096,\n \"dateCreated\":\"2020-03-18T16:47:59.222Z\",\n \"buyerInfo\":{\n \"id\":\"e9a69747-6816-42fb-87bf-4cd60a408b4e\",\n \"type\":\"CONTACT\",\n \"identityType\":\"CONTACT\",\n \"firstName\":\"John\",\n \"lastName\":\"Smith\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"currency\":\"USD\",\n \"weightUnit\":\"LB\",\n \"totals\":{\n \"subtotal\":\"10\",\n \"shipping\":\"3\",\n \"tax\":\"3\",\n \"discount\":\"1\",\n \"total\":\"15\",\n \"weight\":\"30\",\n \"quantity\":2\n },\n \"billingInfo\":{\n \"paymentMethod\":\"PayPal\",\n \"externalTransactionId\":\"tx_1806\",\n \"paymentProviderTransactionId\":\"tx_1806\",\n \"address\":{\n \"fullName\":{\n \"firstName\":\"John\",\n \"lastName\":\"Smith\"\n },\n \"country\":\"US\",\n \"city\":\"New York\",\n \"zipCode\":\"92544\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"paidDate\":\"2020-03-18T16:47:59.244Z\"\n },\n \"shippingInfo\":{\n \"deliveryOption\":\"Express\",\n \"estimatedDeliveryTime\":\"Today\",\n \"shipmentDetails\":{\n \"address\":{\n \"fullName\":{\n \"firstName\":\"John\",\n \"lastName\":\"Smith\"\n },\n \"country\":\"US\",\n \"city\":\"New York\",\n \"zipCode\":\"92544\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"trackingInfo\":{\n \"trackingNumber\":\"1234\",\n \"shippingProvider\":\"FEDEX\",\n \"trackingLink\":\"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=1234\"\n },\n \"discount\":\"0\",\n \"tax\":\"1\",\n \"priceData\":{\n \"taxIncludedInPrice\":false,\n \"price\":\"3\"\n }\n }\n },\n \"read\":false,\n \"archived\":false,\n \"paymentStatus\":\"PAID\",\n \"fulfillmentStatus\":\"PARTIALLY_FULFILLED\",\n \"lineItems\":[\n {\n \"index\":1,\n \"quantity\":2,\n \"price\":\"5\",\n \"name\":\"my product\",\n \"productId\":\"a1f9d337-f831-4529-31e6-67db8fd4e1aa\",\n \"totalPrice\":\"10\",\n \"lineItemType\":\"PHYSICAL\",\n \"options\":[\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Create Fulfillment","slugifiedName":"create-fulfillment"},"deprecationDetails":{"message":"Stores Create Fulfillment has been replaced with eCommerce Create Fulfillment.","replacedBy":"CreateFulfillment","targetRemovalDate":"2024-09-04"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Update Fulfillment","description":"

\n\n__Deprecation Notice:__\n\nThis endpoint has been replaced with\n[eCommerce Update Fulfillment](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/update-fulfillment)\nand will be removed on September 4, 2024.\n\n

\n\nUpdates an existing fulfillment.","operationId":"wix.orders.api.v2.OrdersV2.UpdateFulfillment","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"orderId","description":"Order ID.","x-wix-docs":{"exposure":"PUBLIC"}},{"in":"path","schema":{"type":"string"},"required":true,"name":"fulfillmentId","description":"Fulfillment ID","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.orders.api.v2.UpdateFulfillmentResponse","description":""}},"deprecated":true,"servers":[{"url":"https://www.wixapis.com/stores/v2/orders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v2/orders","destinationPath":"/v2/orders","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateFulfillmentRequest","description":"","properties":{"fulfillmentTrackingInfo":{"description":"Updated tracking info.","$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentTrackingInfo","summary":"fulfillmentTrackingInfo","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["orderId","fulfillmentId"]}}},"x-wix-docs":{"deprecated":{"message":"Stores Update Fulfillment has been replaced with eCommerce Update Fulfillment.","replacedBy":"UpdateFulfillment","targetRemovalDate":"2024-09-04"}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.orders.api.v2.OrdersV2","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_ORDERS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-orders-api","serviceArtifactId":"com.wixpress.ecom.orders-reverse-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.orders.api.v2.UpdateFulfillmentRequest","responseMessage":"wix.orders.api.v2.UpdateFulfillmentResponse"},"deprecated":{"message":"Stores Update Fulfillment has been replaced with eCommerce Update Fulfillment.","replacedBy":"UpdateFulfillment","targetRemovalDate":"2024-09-04"},"legacyExamples":[{"name":"UpdateFulfillment","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X PUT 'https://www.wixapis.com/stores/v2/orders/fedb19f5-bd4c-4bfc-b2d1-212538319611/fulfillments/5945017a-bf19-414e-ae67-af3d2dbc66ff' \\\n--data-binary '{\n \"fulfillmentTrackingInfo\": {\n \"shippingProvider\": \"fedex\",\n \"trackingNumber\": \"123\"\n }\n }' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"order\":{\n \"id\":\"fedb19f5-bd4c-4bfc-b2d1-212538319611\",\n \"number\":10096,\n \"dateCreated\":\"2020-03-18T16:47:59.222Z\",\n \"buyerInfo\":{\n \"id\":\"e9a69747-6816-42fb-87bf-4cd60a408b4e\",\n \"type\":\"CONTACT\",\n \"identityType\":\"CONTACT\",\n \"firstName\":\"John\",\n \"lastName\":\"Smith\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"currency\":\"USD\",\n \"weightUnit\":\"LB\",\n \"totals\":{\n \"subtotal\":\"10\",\n \"shipping\":\"3\",\n \"tax\":\"3\",\n \"discount\":\"1\",\n \"total\":\"15\",\n \"weight\":\"30\",\n \"quantity\":2\n },\n \"billingInfo\":{\n \"paymentMethod\":\"PayPal\",\n \"externalTransactionId\":\"tx_1806\",\n \"paymentProviderTransactionId\":\"tx_1806\",\n \"address\":{\n \"fullName\":{\n \"firstName\":\"John\",\n \"lastName\":\"Smith\"\n },\n \"country\":\"US\",\n \"city\":\"New York\",\n \"zipCode\":\"92544\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"paidDate\":\"2020-03-18T16:47:59.244Z\"\n },\n \"shippingInfo\":{\n \"deliveryOption\":\"Express\",\n \"estimatedDeliveryTime\":\"Today\",\n \"shipmentDetails\":{\n \"address\":{\n \"fullName\":{\n \"firstName\":\"John\",\n \"lastName\":\"Smith\"\n },\n \"country\":\"US\",\n \"city\":\"New York\",\n \"zipCode\":\"92544\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"trackingInfo\":{\n \"trackingNumber\":\"123\",\n \"shippingProvider\":\"FEDEX\",\n \"trackingLink\":\"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=123\"\n },\n \"discount\":\"0\",\n \"tax\":\"1\",\n \"priceData\":{\n \"taxIncludedInPrice\":false,\n \"price\":\"3\"\n }\n }\n },\n \"read\":false,\n \"archived\":false,\n \"paymentStatus\":\"PAID\",\n \"fulfillmentStatus\":\"PARTIALLY_FULFILLED\",\n \"lineItems\":[\n {\n \"index\":1,\n \"quantity\":2,\n \"price\":\"5\",\n \"name\":\"my product\",\n \"productId\":\"a1f9d337-f831-4529-31e6-67db8fd4e1aa\",\n \"totalPrice\":\"10\",\n \"lineItemType\":\"PHYSICAL\",\n \"options\":[\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"put","path":"/v2/orders/{orderId}/fulfillments/{fulfillmentId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.orders.api.v2.OrdersV2","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_ORDERS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-orders-api","serviceArtifactId":"com.wixpress.ecom.orders-reverse-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.orders.api.v2.UpdateFulfillmentRequest","responseMessage":"wix.orders.api.v2.UpdateFulfillmentResponse"},"legacyExamples":[{"name":"UpdateFulfillment","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X PUT 'https://www.wixapis.com/stores/v2/orders/fedb19f5-bd4c-4bfc-b2d1-212538319611/fulfillments/5945017a-bf19-414e-ae67-af3d2dbc66ff' \\\n--data-binary '{\n \"fulfillmentTrackingInfo\": {\n \"shippingProvider\": \"fedex\",\n \"trackingNumber\": \"123\"\n }\n }' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"order\":{\n \"id\":\"fedb19f5-bd4c-4bfc-b2d1-212538319611\",\n \"number\":10096,\n \"dateCreated\":\"2020-03-18T16:47:59.222Z\",\n \"buyerInfo\":{\n \"id\":\"e9a69747-6816-42fb-87bf-4cd60a408b4e\",\n \"type\":\"CONTACT\",\n \"identityType\":\"CONTACT\",\n \"firstName\":\"John\",\n \"lastName\":\"Smith\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"currency\":\"USD\",\n \"weightUnit\":\"LB\",\n \"totals\":{\n \"subtotal\":\"10\",\n \"shipping\":\"3\",\n \"tax\":\"3\",\n \"discount\":\"1\",\n \"total\":\"15\",\n \"weight\":\"30\",\n \"quantity\":2\n },\n \"billingInfo\":{\n \"paymentMethod\":\"PayPal\",\n \"externalTransactionId\":\"tx_1806\",\n \"paymentProviderTransactionId\":\"tx_1806\",\n \"address\":{\n \"fullName\":{\n \"firstName\":\"John\",\n \"lastName\":\"Smith\"\n },\n \"country\":\"US\",\n \"city\":\"New York\",\n \"zipCode\":\"92544\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"paidDate\":\"2020-03-18T16:47:59.244Z\"\n },\n \"shippingInfo\":{\n \"deliveryOption\":\"Express\",\n \"estimatedDeliveryTime\":\"Today\",\n \"shipmentDetails\":{\n \"address\":{\n \"fullName\":{\n \"firstName\":\"John\",\n \"lastName\":\"Smith\"\n },\n \"country\":\"US\",\n \"city\":\"New York\",\n \"zipCode\":\"92544\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"trackingInfo\":{\n \"trackingNumber\":\"123\",\n \"shippingProvider\":\"FEDEX\",\n \"trackingLink\":\"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=123\"\n },\n \"discount\":\"0\",\n \"tax\":\"1\",\n \"priceData\":{\n \"taxIncludedInPrice\":false,\n \"price\":\"3\"\n }\n }\n },\n \"read\":false,\n \"archived\":false,\n \"paymentStatus\":\"PAID\",\n \"fulfillmentStatus\":\"PARTIALLY_FULFILLED\",\n \"lineItems\":[\n {\n \"index\":1,\n \"quantity\":2,\n \"price\":\"5\",\n \"name\":\"my product\",\n \"productId\":\"a1f9d337-f831-4529-31e6-67db8fd4e1aa\",\n \"totalPrice\":\"10\",\n \"lineItemType\":\"PHYSICAL\",\n \"options\":[\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update Fulfillment","slugifiedName":"update-fulfillment"},"deprecationDetails":{"message":"Stores Update Fulfillment has been replaced with eCommerce Update Fulfillment.","replacedBy":"UpdateFulfillment","targetRemovalDate":"2024-09-04"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Delete Fulfillment","description":"

\n\n__Deprecation Notice:__\n\nThis endpoint has been replaced with\n[eCommerce Delete Fulfillment](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/delete-fulfillment)\nand will be removed on September 4, 2024.\n\n

\n\nDeletes an existing fulfillment.","operationId":"wix.orders.api.v2.OrdersV2.DeleteFulfillment","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"orderId","description":"Order ID.","x-wix-docs":{"exposure":"PUBLIC"}},{"in":"path","schema":{"type":"string"},"required":true,"name":"fulfillmentId","description":"Fulfillment ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.orders.api.v2.DeleteFulfillmentResponse","description":""}},"deprecated":true,"servers":[{"url":"https://www.wixapis.com/stores/v2/orders","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v2/orders","destinationPath":"/v2/orders","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.orders.api.v2.OrdersV2","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_ORDERS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-orders-api","serviceArtifactId":"com.wixpress.ecom.orders-reverse-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.orders.api.v2.DeleteFulfillmentRequest","responseMessage":"wix.orders.api.v2.DeleteFulfillmentResponse"},"deprecated":{"message":"Stores Delete Fulfillment has been replaced with eCommerce Delete Fulfillment.","replacedBy":"DeleteFulfillment","targetRemovalDate":"2024-09-04"},"legacyExamples":[{"name":"DeleteFulfillment","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X DELETE 'https://www.wixapis.com/stores/v2/orders/fedb19f5-bd4c-4bfc-b2d1-212538319611/fulfillments/0175f0e8-f877-40a9-b980-0d336c64c726' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"order\":{\n \"id\":\"fedb19f5-bd4c-4bfc-b2d1-212538319611\",\n \"number\":10096,\n \"dateCreated\":\"2020-03-18T16:47:59.222Z\",\n \"buyerInfo\":{\n \"id\":\"e9a69747-6816-42fb-87bf-4cd60a408b4e\",\n \"type\":\"CONTACT\",\n \"identityType\":\"CONTACT\",\n \"firstName\":\"John\",\n \"lastName\":\"Smith\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"currency\":\"USD\",\n \"weightUnit\":\"LB\",\n \"totals\":{\n \"subtotal\":\"10\",\n \"shipping\":\"3\",\n \"tax\":\"3\",\n \"discount\":\"1\",\n \"total\":\"15\",\n \"weight\":\"30\",\n \"quantity\":2\n },\n \"billingInfo\":{\n \"paymentMethod\":\"PayPal\",\n \"externalTransactionId\":\"tx_1806\",\n \"paymentProviderTransactionId\":\"tx_1806\",\n \"address\":{\n \"fullName\":{\n \"firstName\":\"John\",\n \"lastName\":\"Smith\"\n },\n \"country\":\"US\",\n \"city\":\"New York\",\n \"zipCode\":\"92544\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"paidDate\":\"2020-03-18T16:47:59.244Z\"\n },\n \"shippingInfo\":{\n \"deliveryOption\":\"Express\",\n \"estimatedDeliveryTime\":\"Today\",\n \"shipmentDetails\":{\n \"address\":{\n \"fullName\":{\n \"firstName\":\"John\",\n \"lastName\":\"Smith\"\n },\n \"country\":\"US\",\n \"city\":\"New York\",\n \"zipCode\":\"92544\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"discount\":\"0\",\n \"tax\":\"1\",\n \"priceData\":{\n \"taxIncludedInPrice\":false,\n \"price\":\"3\"\n }\n }\n },\n \"read\":false,\n \"archived\":false,\n \"paymentStatus\":\"PAID\",\n \"fulfillmentStatus\":\"NOT_FULFILLED\",\n \"lineItems\":[\n {\n \"index\":1,\n \"quantity\":2,\n \"price\":\"5\",\n \"name\":\"my product\",\n \"productId\":\"a1f9d337-f831-4529-31e6-67db8fd4e1aa\",\n \"totalPrice\":\"10\",\n \"lineItemType\":\"PHYSICAL\",\n \"options\":[\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"delete","path":"/v2/orders/{orderId}/fulfillments/{fulfillmentId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.orders.api.v2.OrdersV2","errors":[],"exposure":"PUBLIC","permissions":["WIX_STORES.MODIFY_ORDERS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.ecommerce:wix-ecommerce-orders-api","serviceArtifactId":"com.wixpress.ecom.orders-reverse-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.orders.api.v2.DeleteFulfillmentRequest","responseMessage":"wix.orders.api.v2.DeleteFulfillmentResponse"},"legacyExamples":[{"name":"DeleteFulfillment","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X DELETE 'https://www.wixapis.com/stores/v2/orders/fedb19f5-bd4c-4bfc-b2d1-212538319611/fulfillments/0175f0e8-f877-40a9-b980-0d336c64c726' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"order\":{\n \"id\":\"fedb19f5-bd4c-4bfc-b2d1-212538319611\",\n \"number\":10096,\n \"dateCreated\":\"2020-03-18T16:47:59.222Z\",\n \"buyerInfo\":{\n \"id\":\"e9a69747-6816-42fb-87bf-4cd60a408b4e\",\n \"type\":\"CONTACT\",\n \"identityType\":\"CONTACT\",\n \"firstName\":\"John\",\n \"lastName\":\"Smith\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"currency\":\"USD\",\n \"weightUnit\":\"LB\",\n \"totals\":{\n \"subtotal\":\"10\",\n \"shipping\":\"3\",\n \"tax\":\"3\",\n \"discount\":\"1\",\n \"total\":\"15\",\n \"weight\":\"30\",\n \"quantity\":2\n },\n \"billingInfo\":{\n \"paymentMethod\":\"PayPal\",\n \"externalTransactionId\":\"tx_1806\",\n \"paymentProviderTransactionId\":\"tx_1806\",\n \"address\":{\n \"fullName\":{\n \"firstName\":\"John\",\n \"lastName\":\"Smith\"\n },\n \"country\":\"US\",\n \"city\":\"New York\",\n \"zipCode\":\"92544\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"paidDate\":\"2020-03-18T16:47:59.244Z\"\n },\n \"shippingInfo\":{\n \"deliveryOption\":\"Express\",\n \"estimatedDeliveryTime\":\"Today\",\n \"shipmentDetails\":{\n \"address\":{\n \"fullName\":{\n \"firstName\":\"John\",\n \"lastName\":\"Smith\"\n },\n \"country\":\"US\",\n \"city\":\"New York\",\n \"zipCode\":\"92544\",\n \"phone\":\"+972 555234555\",\n \"email\":\"Ivanushka@example.com\"\n },\n \"discount\":\"0\",\n \"tax\":\"1\",\n \"priceData\":{\n \"taxIncludedInPrice\":false,\n \"price\":\"3\"\n }\n }\n },\n \"read\":false,\n \"archived\":false,\n \"paymentStatus\":\"PAID\",\n \"fulfillmentStatus\":\"NOT_FULFILLED\",\n \"lineItems\":[\n {\n \"index\":1,\n \"quantity\":2,\n \"price\":\"5\",\n \"name\":\"my product\",\n \"productId\":\"a1f9d337-f831-4529-31e6-67db8fd4e1aa\",\n \"totalPrice\":\"10\",\n \"lineItemType\":\"PHYSICAL\",\n \"options\":[\n~~~"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Delete Fulfillment","slugifiedName":"delete-fulfillment"},"deprecationDetails":{"message":"Stores Delete Fulfillment has been replaced with eCommerce Delete Fulfillment.","replacedBy":"DeleteFulfillment","targetRemovalDate":"2024-09-04"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]}],"webhooks":[{"summary":"Order Created","title":"Orders Order Created","description":"

\n\n__Deprecation Notice:__\n\nThis webhook has been replaced with\n[eCommerce Order Approved Event](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-approved)\nand will be removed on September 4, 2024.\n\n

\n\nTriggered when an order is created.","permissions":["WIX_STORES.READ_ORDERS"],"payload":{"schemaName":"wix.orders.api.v2.OrderCreated"},"exposure":"PUBLIC","maturity":"GA","slug":"order_created","eventTopic":"wixStores-order-new-with-content","serviceName":"wix.orders.api.v2.OrdersV2","domainEvent":"NOT_DOMAIN_EVENT","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"legacyExamples":[{"name":"Order Created","type":"LEGACY_EVENT","content":"{\n \"orderId\": \"afc47c2d-4fbf-450d-9f20-478e54b46b89\",\n \"number\": \"10001\",\n \"dateCreated\": \"2019-08-28T08:30:42.074Z\",\n \"buyerInfo\": {\n \"id\": \"d52512dc-131f-4062-abf3-a653552bbbd2\",\n \"type\": \"CONTACT\",\n \"identityType\": \"CONTACT\",\n \"firstName\": \"Eric\",\n \"lastName\": \"Ben\",\n \"phone\": \"055223399\",\n \"email\": \"test123@wix.com\"\n },\n \"currency\": \"USD\",\n \"weightUnit\": \"KG\",\n \"totals\": {\n \"subtotal\": \"1\",\n \"shipping\": \"2\",\n \"tax\": \"3\",\n \"discount\": \"0\",\n \"total\": \"5\",\n \"weight\": \"0\",\n \"quantity\": 2\n },\n \"read\": true,\n \"paymentStatus\": \"PAID\",\n \"fulfillmentStatus\": \"FULFILLED\"\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.orders.api.v2.OrderCreated","contentLink":{"displayName":"Order Created","slugifiedName":"order-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Order Paid","title":"Orders Order Paid","description":"

\n\n__Deprecation Notice:__\n\nThis webhook has been replaced with\n[eCommerce Order Payment Status Updated Event](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/payment-status-updated)\nand will be removed on September 4, 2024.\n\n

\n\nTriggered when an order is paid.","permissions":["WIX_STORES.READ_ORDERS"],"payload":{"schemaName":"com.wix.ecommerce.orders.api.v2.OrderPaid"},"exposure":"PUBLIC","maturity":"GA","slug":"order_paid","eventTopic":"wixStores-order-paid","serviceName":"wix.orders.api.v2.OrdersV2","domainEvent":"NOT_DOMAIN_EVENT","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"OrderPaid","legacyExamples":[{"name":"Order Paid","type":"LEGACY_EVENT","content":"{\n \"order\": {\n \"id\": \"fedb19f5-bd4c-4bfc-b2d1-212538319611\",\n \"number\": 10096,\n \"dateCreated\": \"2020-03-18T16:47:59.222Z\",\n \"currency\": \"USD\",\n \"weightUnit\": \"LB\",\n \"totals\": {\n \"subtotal\": \"10\",\n \"shipping\": \"3\",\n \"tax\": \"3\",\n \"discount\": \"1\",\n \"total\": \"15\",\n \"weight\": \"30\",\n \"quantity\": 2\n },\n \"billingInfo\": {\n \"paymentMethod\": \"PayPal\",\n \"externalTransactionId\": \"tx_1806\",\n \"paymentProviderTransactionId\": \"tx_1806\",\n \"address\": {\n \"fullName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n },\n \"country\": \"US\",\n \"city\": \"New York\",\n \"zipCode\": \"92544\",\n \"phone\": \"+972 555234555\",\n \"email\": \"Ivanushka@example.com\"\n },\n \"paidDate\": \"2020-03-18T16:47:59.244Z\"\n },\n \"shippingInfo\": {\n \"deliveryOption\": \"Express\",\n \"estimatedDeliveryTime\": \"Today\",\n \"shippingRegion\": \"East coast\",\n \"shipmentDetails\": {\n \"address\": {\n \"fullName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n },\n \"country\": \"US\",\n \"city\": \"New York\",\n \"zipCode\": \"92544\",\n \"phone\": \"+972 555234555\",\n \"email\": \"Ivanushka@example.com\"\n },\n \"discount\": \"0\",\n \"tax\": \"1\",\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"3\"\n }\n }\n },\n \"read\": false,\n \"archived\": false,\n \"paymentStatus\": \"PAID\",\n \"fulfillmentStatus\": \"NOT_FULFILLED\",\n \"lineItems\": [\n {\n \"index\": 1,\n \"quantity\": 2,\n \"name\": \"my product\",\n \"productId\": \"a1f9d337-f831-4529-31e6-67db8fd4e1aa\",\n \"lineItemType\": \"PHYSICAL\",\n \"options\": [],\n \"customTextFields\": [],\n \"weight\": \"15\",\n \"sku\": \"12345678\",\n \"discount\": \"1\",\n \"tax\": \"1\",\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"5\",\n \"totalPrice\": \"10\"\n }\n }\n ],\n \"activities\": [\n {\n \"type\": \"ORDER_PLACED\",\n \"timestamp\": \"2020-03-18T16:47:59.222Z\"\n },\n {\n \"type\": \"ORDER_PAID\",\n \"timestamp\": \"2020-03-18T16:47:59.244Z\"\n }\n ],\n \"fulfillments\": [],\n \"discount\": {\n \"value\": \"1\"\n },\n \"buyerLanguage\": \"en\",\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"enteredBy\": {\n \"id\": \"e85274cf-047a-4989-baff-dac5e0c3971d\",\n \"identityType\": \"USER\"\n },\n \"lastUpdated\": \"2020-03-18T16:47:59.244Z\"\n }\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/com.wix.ecommerce.orders.api.v2.OrderPaid","contentLink":{"displayName":"Order Paid","slugifiedName":"order-paid"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Order Canceled","title":"Orders Order Canceled","description":"

\n\n__Deprecation Notice:__\n\nThis webhook has been replaced with\n[eCommerce Order Canceled Event](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-canceled)\nand will be removed on September 4, 2024.\n\n

\n\nTriggered when an order is canceled.","permissions":["WIX_STORES.READ_ORDERS"],"payload":{"schemaName":"wix.orders.api.v2.OrderCanceled"},"exposure":"PUBLIC","maturity":"GA","slug":"order_canceled","eventTopic":"wixStores-cancel-event","serviceName":"wix.orders.api.v2.OrdersV2","domainEvent":"NOT_DOMAIN_EVENT","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"OrderCanceled","legacyExamples":[{"name":"Order Canceled","type":"LEGACY_EVENT","content":"{\n \"order\": {\n \"id\": \"fedb19f5-bd4c-4bfc-b2d1-212538319611\",\n \"number\": 10096,\n \"dateCreated\": \"2020-03-18T16:47:59.222Z\",\n \"currency\": \"USD\",\n \"weightUnit\": \"LB\",\n \"totals\": {\n \"subtotal\": \"10\",\n \"shipping\": \"3\",\n \"tax\": \"3\",\n \"discount\": \"1\",\n \"total\": \"15\",\n \"weight\": \"30\",\n \"quantity\": 2\n },\n \"billingInfo\": {\n \"paymentMethod\": \"PayPal\",\n \"externalTransactionId\": \"tx_1806\",\n \"paymentProviderTransactionId\": \"tx_1806\",\n \"address\": {\n \"fullName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n },\n \"country\": \"US\",\n \"city\": \"New York\",\n \"zipCode\": \"92544\",\n \"phone\": \"+972 555234555\",\n \"email\": \"Ivanushka@example.com\"\n },\n \"paidDate\": \"2020-03-18T16:47:59.244Z\"\n },\n \"shippingInfo\": {\n \"deliveryOption\": \"Express\",\n \"estimatedDeliveryTime\": \"Today\",\n \"shipmentDetails\": {\n \"address\": {\n \"fullName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n },\n \"country\": \"US\",\n \"city\": \"New York\",\n \"zipCode\": \"92544\",\n \"phone\": \"+972 555234555\",\n \"email\": \"Ivanushka@example.com\"\n },\n \"discount\": \"0\",\n \"tax\": \"1\",\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"3\"\n }\n }\n },\n \"read\": false,\n \"archived\": false,\n \"paymentStatus\": \"PAID\",\n \"fulfillmentStatus\": \"CANCELED\",\n \"lineItems\": [\n {\n \"index\": 1,\n \"quantity\": 2,\n \"name\": \"my product\",\n \"productId\": \"a1f9d337-f831-4529-31e6-67db8fd4e1aa\",\n \"lineItemType\": \"PHYSICAL\",\n \"options\": [],\n \"customTextFields\": [],\n \"weight\": \"15\",\n \"sku\": \"12345678\",\n \"discount\": \"1\",\n \"tax\": \"1\",\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"5\",\n \"totalPrice\": \"10\"\n }\n }\n ],\n \"activities\": [\n {\n \"type\": \"ORDER_PLACED\",\n \"timestamp\": \"2020-03-18T16:47:59.222Z\"\n },\n {\n \"type\": \"ORDER_PAID\",\n \"timestamp\": \"2020-03-18T16:47:59.244Z\"\n }\n ],\n \"fulfillments\": [],\n \"discount\": {\n \"value\": \"1\"\n },\n \"buyerLanguage\": \"en\",\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"enteredBy\": {\n \"id\": \"e85274cf-047a-4989-baff-dac5e0c3971d\",\n \"identityType\": \"USER\"\n },\n \"lastUpdated\": \"2020-03-18T16:47:59.244Z\"\n }\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.orders.api.v2.OrderCanceled","contentLink":{"displayName":"Order Canceled","slugifiedName":"order-canceled"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Order Refunded","title":"Orders Order Refunded","description":"

\n\n__Deprecation Notice:__\n\nThis webhook has been replaced with\n[eCommerce Order Transactions Updated Event](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/order-transactions-updated)\nand will be removed on September 4, 2024.\n\n

\n\nTriggered when an order is refunded.","permissions":["WIX_STORES.READ_ORDERS"],"payload":{"schemaName":"wix.orders.api.v2.OrderRefunded"},"exposure":"PUBLIC","maturity":"GA","slug":"order_refunded","eventTopic":"wixStores-refund-event","serviceName":"wix.orders.api.v2.OrdersV2","domainEvent":"NOT_DOMAIN_EVENT","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"OrderRefunded","legacyExamples":[{"name":"Order Refunded","type":"LEGACY_EVENT","content":"{\n \"refundId\": \"2a7ca480-e02b-73f2-e015-800174c576e9\",\n \"order\": {\n \"id\": \"fedb19f5-bd4c-4bfc-b2d1-212538319611\",\n \"number\": 10096,\n \"dateCreated\": \"2020-03-18T16:47:59.222Z\",\n \"currency\": \"USD\",\n \"weightUnit\": \"LB\",\n \"totals\": {\n \"subtotal\": \"10\",\n \"shipping\": \"3\",\n \"tax\": \"3\",\n \"discount\": \"1\",\n \"total\": \"15\",\n \"weight\": \"30\",\n \"quantity\": 2,\n \"refund\": \"15\"\n },\n \"billingInfo\": {\n \"paymentMethod\": \"PayPal\",\n \"externalTransactionId\": \"tx_1806\",\n \"paymentProviderTransactionId\": \"tx_1806\",\n \"address\": {\n \"fullName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n },\n \"country\": \"US\",\n \"city\": \"New York\",\n \"zipCode\": \"92544\",\n \"phone\": \"+972 555234555\",\n \"email\": \"Ivanushka@example.com\"\n },\n \"paidDate\": \"2020-03-18T16:47:59.244Z\"\n },\n \"shippingInfo\": {\n \"deliveryOption\": \"Express\",\n \"estimatedDeliveryTime\": \"Today\",\n \"shipmentDetails\": {\n \"address\": {\n \"fullName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n },\n \"country\": \"US\",\n \"city\": \"New York\",\n \"zipCode\": \"92544\",\n \"phone\": \"+972 555234555\",\n \"email\": \"Ivanushka@example.com\"\n },\n \"discount\": \"0\",\n \"tax\": \"1\",\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"3\"\n }\n }\n },\n \"read\": false,\n \"archived\": false,\n \"paymentStatus\": \"FULLY_REFUNDED\",\n \"fulfillmentStatus\": \"CANCELED\",\n \"lineItems\": [\n {\n \"index\": 1,\n \"quantity\": 2,\n \"name\": \"my product\",\n \"productId\": \"a1f9d337-f831-4529-31e6-67db8fd4e1aa\",\n \"lineItemType\": \"PHYSICAL\",\n \"options\": [],\n \"customTextFields\": [],\n \"weight\": \"15\",\n \"sku\": \"12345678\",\n \"discount\": \"1\",\n \"tax\": \"1\",\n \"priceData\": {\n \"taxIncludedInPrice\": false,\n \"price\": \"5\",\n \"totalPrice\": \"10\"\n }\n }\n ],\n \"activities\": [\n {\n \"type\": \"ORDER_PLACED\",\n \"timestamp\": \"2020-03-18T16:47:59.222Z\"\n },\n {\n \"type\": \"ORDER_PAID\",\n \"timestamp\": \"2020-03-18T16:47:59.244Z\"\n }\n ],\n \"fulfillments\": [],\n \"discount\": {\n \"value\": \"1\"\n },\n \"buyerLanguage\": \"en\",\n \"channelInfo\": {\n \"type\": \"WEB\"\n },\n \"enteredBy\": {\n \"id\": \"e85274cf-047a-4989-baff-dac5e0c3971d\",\n \"identityType\": \"USER\"\n },\n \"lastUpdated\": \"2020-03-18T16:47:59.244Z\",\n \"refunds\": [\n {\n \"dateCreated\": \"2020-09-01T12:30:56.208Z\",\n \"amount\": \"21.0\",\n \"paymentProviderTransactionId\": \"re_1HMYdXEQJH0qyaWeD0fm1qmN\",\n \"id\": \"2a7ca480-e02b-73f2-e015-800174c576e9\",\n \"externalRefund\": false\n }\n ]\n }\n}\n\n"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.orders.api.v2.OrderRefunded","contentLink":{"displayName":"Order Refunded","slugifiedName":"order-refunded"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Fulfillment Created","title":"Orders Fulfillment Created","description":"

\n\n__Deprecation Notice:__\n\nThis webhook has been replaced with\n[eCommerce Order With Fulfillments Updated Event](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/order-with-fulfillments-updated)\nand will be removed on September 4, 2024.\n\n

\n\nTriggered when a tracking number is added to a fulfillment.","permissions":["WIX_STORES.READ_ORDERS"],"payload":{"schemaName":"wix.orders.api.v2.FulfillmentCreated"},"exposure":"PUBLIC","maturity":"GA","slug":"fulfillment_created","eventTopic":"wixStores-order-fulfillment-api-event","serviceName":"wix.orders.api.v2.OrdersV2","domainEvent":"NOT_DOMAIN_EVENT","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"FulfillmentCreated","legacyExamples":[{"name":"Fulfillment Created","type":"LEGACY_EVENT","content":"{\n \"orderId\": \"8234d6e7-d92f-4c0d-b973-8fadec29fa47\",\n \"fulfillmentId\": \"ca4abdc6-ac46-430a-8db9-9c866fa11a50\",\n \"dateCreated\": \"2019-12-10T15:03:30.800Z\",\n \"buyerInfo\": {\n \"id\": \"aa3159c6-5d5c-4b1c-bcf1-6b0d9e5a3897\",\n \"type\": \"CONTACT\",\n \"identityType\": \"CONTACT\",\n \"firstName\": \"John\",\n \"lastName\": \"Israeli\",\n \"phone\": \"0123456789\",\n \"email\": \"John.Israeli123@hotmail.com\"\n },\n \"fulfillmentStatus\": \"FULFILLED\",\n \"trackingInfo\": {\n \"trackingNumber\": \"1234-5678-9101-1121-3141-51\",\n \"shippingProvider\": \"usps\",\n \"trackingLink\": \"https://tools.usps.com/go/TrackConfirmAction.action?tLabels=1234-5678-9101-1121-3141-51\"\n }\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentCreated","contentLink":{"displayName":"Fulfillment Created","slugifiedName":"fulfillment-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Fulfillment Updated","title":"Orders Fulfillment Updated","description":"

\n\n__Deprecation Notice:__\n\nThis webhook has been replaced with\n[eCommerce Order With Fulfillments Updated Event](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/order-with-fulfillments-updated)\nand will be removed on September 4, 2024.\n\n

\n\nTriggered when a fulfillment is updated.","permissions":["WIX_STORES.READ_ORDERS"],"payload":{"schemaName":"wix.orders.api.v2.FulfillmentUpdated"},"exposure":"PUBLIC","maturity":"GA","slug":"fulfillment_updated","eventTopic":"wixStores-order-fulfillment-api-event","serviceName":"wix.orders.api.v2.OrdersV2","domainEvent":"NOT_DOMAIN_EVENT","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"FulfillmentUpdated","legacyExamples":[{"name":"Fulfillment Updated","type":"LEGACY_EVENT","content":"{\n \"orderId\": \"8234d6e7-d92f-4c0d-b973-8fadec29fa47\",\n \"fulfillmentId\": \"ca4abdc6-ac46-430a-8db9-9c866fa11a50\",\n \"trackingInfo\": {\n \"trackingNumber\": \"1234-5678-9101-1121-3141-51\",\n \"shippingProvider\": \"usps\",\n \"trackingLink\": \"https://tools.usps.com/go/TrackConfirmAction.action?tLabels=1234-5678-9101-1121-3141-51\"\n }\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentUpdated","contentLink":{"displayName":"Fulfillment Updated","slugifiedName":"fulfillment-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Fulfillment Deleted","title":"Orders Fulfillment Deleted","description":"

\n\n__Deprecation Notice:__\n\nThis webhook has been replaced with\n[eCommerce Order With Fulfillments Updated Event](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/order-with-fulfillments-updated)\nand will be removed on September 4, 2024.\n\n

\n\nTriggered when a fulfillment is deleted.","permissions":["WIX_STORES.READ_ORDERS"],"payload":{"schemaName":"wix.orders.api.v2.FulfillmentDeleted"},"exposure":"PUBLIC","maturity":"GA","slug":"fulfillment_deleted","eventTopic":"wixStores-order-fulfillment-api-event","serviceName":"wix.orders.api.v2.OrdersV2","domainEvent":"NOT_DOMAIN_EVENT","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"FulfillmentDeleted","legacyExamples":[{"name":"Fulfillment Deleted","type":"LEGACY_EVENT","content":"{\n \"orderId\": \"8234d6e7-d92f-4c0d-b973-8fadec29fa47\",\n \"fulfillmentId\": \"ca4abdc6-ac46-430a-8db9-9c866fa11a50\",\n \"fulfillmentStatus\": \"NOT_FULFILLED\"\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentDeleted","contentLink":{"displayName":"Fulfillment Deleted","slugifiedName":"fulfillment-deleted"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Orders Order Declined","title":"Orders Order Declined","description":"Triggered when an order is declined.","permissions":["WIX_STORES.READ_ORDERS"],"payload":{"schemaName":"com.wix.ecommerce.orders.api.v2.OrderDeclined"},"exposure":"PUBLIC","maturity":"GA","slug":"order_declined","eventTopic":"wixStores-order-declined","serviceName":"wix.orders.api.v2.OrdersV2","domainEvent":"NOT_DOMAIN_EVENT","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/com.wix.ecommerce.orders.api.v2.OrderDeclined","contentLink":{"displayName":"Orders Order Declined","slugifiedName":"orders-order-declined"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Orders Service\n\n

\n\n__Deprecation Notice:__\n\nStores Orders API has been replaced with\n[eCommerce Orders API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::546b2514-6a71-4148-bccf-1fb8d8604792slug::introduction*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/introduction)\nand will be removed on September 4, 2024.\n\nLearn more about [migrating from Wix Stores to Wix eCommerce](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::546b2514-6a71-4148-bccf-1fb8d8604792slug::order-object-conversion*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion).\n\n

\n\n## About This API\n\nStores Orders API allows third party apps to create and manage orders for Wix store owners.\n\nUse this API to:\n1. Query the orders in the store\n2. Get a specific order\n3. Get notifications (via webhook) about new orders\n4. Create and update orders\n\n## Order Types\n\n- **Shipping orders**: Order and shipment of any selection of products from the store's catalog.\n\n- **Pickup orders**: Order of any selection of products from the store's catalog for user pickup.\n\n- **Point of Sale (POS) orders**: Sale consisting only of price and partial billing information, of products not included in the store's catalog.\n","sourceRepo":"git@github.com:wix-private/ecom.git","path":"docs/intro.md"},{"displayName":"Filter and sort","slugifyName":"filter-and-sort","content":"# Filter and Sort\n\n## Query Language\n\nEndpoints that allow querying follow these format [guidelines](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language).\n\n## Fields That Allow Filtering\n\n| Field | Operators | Sorting Allowed|\n| --- | --- | --- |\n| dateCreated |$eq,$ne,$hasSome,$lt,$lte,$gt,$gte|Allowed|\n| lastUpdated |$eq,$ne,$hasSome,$lt,$lte,$gt,$gte|Allowed|\n| paymentStatus |$eq,$ne,$hasSome|\n| archived |$eq,$ne||\n| number |$eq,$ne,$hasSome,$lt,$lte,$gt,$gte|Allowed|\n| fulfillmentStatus |$eq,$ne,$hasSome|\n| id |$eq,$ne,$hasSome|\n| lineItems.productId|$eq,$ne,$hasSome,$hasAll|\n| lineItems.name|$eq,$ne,$hasSome,$hasAll|\n| billingInfo.address.fullName|$eq,$ne,$hasSome,$contains,$startsWith|\n| buyerInfo.id|$eq,$ne,$hasSome|\n| channelInfo.type|$eq,$ne,$hasSome|\n| enteredBy.id|$eq,$ne,$hasSome|\n| channelInfo.externalOrderId|$eq,$ne,$hasSome|\n\n** Note that \"HasSome\" is same as the operator \"IN\" in SQL\n\n## Examples\n\n**Get all paid orders**\n\n```\ncurl 'https://www.wixapis.com/stores/v2/orders/query' --data-binary '{\"query\":{\"filter\":\"{\\\"paymentStatus\\\": \\\"PAID\\\"}\"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'\n```\n\n**Get all orders, sorted by creation time**\n\n```\ncurl 'https://www.wixapis.com/stores/v2/orders/query' --data-binary '{\"query\":{\"sort\":\"[{\\\"dateCreated\\\": \\\"asc\\\"}]\"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'\n```\n\n**Get orders updated within a specific timeframe**\n```\ncurl 'https://www.wixapis.com/stores/v2/orders/query' --data-binary '{\"query\": {\"filter\": \"{\\\"$and\\\": [{\\\"lastUpdated\\\":{\\\"$lte\\\":1588110826000}}, {\\\"lastUpdated\\\":{\\\"$gte\\\":1585518845000}}]}\", \"sort\": \"[{\\\"number\\\":\\\"asc\\\"}]\" }}' -H 'Content-Type: application/json' -H 'Authorization: XXX'\n```\n\n**Get orders by IDs**\n\n```\ncurl 'https://www.wixapis.com/stores/v2/orders/query' --data-binary '{\"query\":{\"filter\":\"{\\\"id\\\": {\\\"$hasSome\\\": [\\\"ORDER_ID_1\\\",\\\"ORDER_ID_2\\\"]}}\"}}' -H 'Content-Type: application/json' -H 'Authorization: xxx'\n```\n","sourceRepo":"git@github.com:wix-private/ecom.git","path":"docs/filterAndSort.md"},{"displayName":"Edit Order Migration","slugifyName":"edit-order-migration","content":"# Edit Order/Draft Orders API Migration Guide\n\n> **Notes:**\n>\n> + This migration is relevant for all apps that currently use the Stores Orders API.\n> + The Stores Orders API will soon be deprecated in favor of the eCommerce Orders API.\n\nWe’re introducing a new Wix eCommerce Orders API that enables business owners to meet new customer needs and provide better customer service. This will eventually replace the existing Stores Orders API. This quick guide will help you to make sure your app is ready for the migration.\n\n## New object and webhook structures\n\nThe structure of the eCommerce Order object is different from the Stores Order object. You can learn more about these structural changes [here](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::546b2514-6a71-4148-bccf-1fb8d8604792slug::order-object-conversion*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion).\n\nThe webhook payload structure has also changed. To facilitate your move to these webhooks, have a look at the [webhook conversion table](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::546b2514-6a71-4148-bccf-1fb8d8604792slug::order-object-conversion#webhook-conversion-table*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).\n\n## Users can now edit orders\n\nCustomers occasionally make mistakes when placing an order, or they might simply want to make a change to an existing order. This could include adding items, updating prices, revising customer details, and more.\n\nThe new eCommerce service includes functionality that lets users edit existing orders. **This will be known as Draft Orders when using our REST APIs, and as Edit Order in the dashboard.**\n\nWhen an existing order is edited, the [Order Updated Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::546b2514-6a71-4148-bccf-1fb8d8604792slug::order-updated*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-updated) is triggered. This webhook returns the whole order object in the eCommerce order structure, but you can still pass the edited order’s ID to the Stores Orders endpoints if you’d like to fetch the order in the Stores structure.\n\n## Impact examples\n\nIf a Wix user edits an existing order, depending on your app type you might need your app to be aware of the change. Here are some examples:\n\n- A user changes the quantity of a product item in an existing order. As a result, the number of items to be shipped has changed.\n- A user changes the shipping address in an existing order.\n- A user adds a new item to an existing order. As a result, the amount to be paid changes.\n- A user changes the price of an item in an existing order. As a result, the total payable amount of the order, as well as the payment status can change.\n\n## How to add the new Order Updated webhook\n\n1. Go to your app in the [Wix Developers Center](fallback::https://dev.wix.com/).\n2. Go to the **Webhooks** tab in the side menu.\n3. Click **+ Add Webhook**.\n4. Select an **API Category** > **Wix eCommerce**\n5. Find and select the [Order Updated Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::546b2514-6a71-4148-bccf-1fb8d8604792slug::order-updated*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-updated)\n6. Add a **Callback URL**.\n7. Click **Save**.\n\n## How to test the impact on your app\n\nEdit Order is not yet available publicly, but if you’d like to test the feature yourself and understand any implications it may have for your app, follow these steps:\n\n1. Install the [EditThisCookie Chrome extension](fallback::https://chromewebstore.google.com/detail/editthiscookie/fngmhnnpilhplaeedifhccceomclgfbg?pli=1).\n2. Click + to add a new cookie, select `petri-ovr` and fill out the following fields:\n- Value: `specs.stores.OrderEditPageComponent#true`\n- Domain: `.wix.com`\n- Secure: Check the box\n- HttpOnly: Check the box\n\n![editorder](https://wixmp-833713b177cebf373f611808.wixmp.com/images/edit-order-notice-md_docs_images_edit-order.png)\n\n3. Create a new Wix website with Wix Stores installed (testing this change only works on **new sites**).\n4. Refresh the **Orders** page.\n5. Navigate to an [unfulfilled order in the dashboard](fallback::https://support.wix.com/en/article/wix-stores-fulfilling-store-orders).\n6. Click on the **More Actions** button in the top right corner.\n7. Click on **Edit Order**.\n\n> **Note:**\n>\n> All orders, including changes committed by Edit Order, are still available in the Stores Orders APIs and webhooks. However, we highly recommend planning your transition to eCommerce Orders and Edit Order/Draft Orders, as the Stores Orders API will be deprecated in the coming months.\n","sourceRepo":"git@github.com:wix-private/ecom.git","path":"docs/edit_order_notice.md"}],"components":{"schemas":{"wix.orders.api.v2.Order":{"type":"object","properties":{"id":{"description":"Order ID (auto-generated upon order creation).","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"number":{"description":"Order number displayed in the owner's store (auto-generated).","readOnly":true,"title":"number","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"dateCreated":{"description":"Order creation date and time.","readOnly":true,"title":"dateCreated","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"buyerInfo":{"description":"Buyer information.","$ref":"#/components/schemas/wix.orders.api.v2.BuyerInfo","summary":"buyerInfo","x-wix-docs":{"exposure":"PUBLIC"}},"currency":{"description":"Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.","format":"CURRENCY","title":"currency","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"weightUnit":{"description":"Weight unit used in this store.","title":"weightUnit","type":"string","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.WeightUnit","x-wix-docs":{"exposure":"PUBLIC"}},"totals":{"description":"Totals for order's line items.","$ref":"#/components/schemas/wix.orders.api.v2.Totals","summary":"totals","x-wix-docs":{"exposure":"PUBLIC"}},"billingInfo":{"description":"Billing information.","$ref":"#/components/schemas/wix.orders.api.v2.BillingInfo","summary":"billingInfo","x-wix-docs":{"exposure":"PUBLIC"}},"shippingInfo":{"description":"Shipping information.","$ref":"#/components/schemas/wix.orders.api.v2.ShippingInfo","summary":"shippingInfo","x-wix-docs":{"exposure":"PUBLIC"}},"buyerNote":{"description":"A note added by the buyer.","maxLength":1000,"title":"buyerNote","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"read":{"description":"Deprecated.","readOnly":true,"title":"read","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","deprecated":{}}},"archived":{"description":"Whether or not the order was archived.","readOnly":true,"title":"archived","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"paymentStatus":{"description":"Current status of the payment.","title":"paymentStatus","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.PaymentStatus","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillmentStatus":{"description":"Order's current fulfillment status (whether the order received a tracking number or was delivered/picked up).","readOnly":true,"title":"fulfillmentStatus","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentStatus","x-wix-docs":{"exposure":"PUBLIC"}},"lineItems":{"description":"Line items ordered.","minItems":1,"maxItems":300,"title":"lineItems","type":"array","items":{"$ref":"#/components/schemas/wix.orders.api.v2.LineItem"},"x-wix-docs":{"exposure":"PUBLIC"}},"activities":{"description":"Log of updates related to the order.","readOnly":true,"title":"activities","type":"array","items":{"$ref":"#/components/schemas/wix.orders.api.v2.Activity"},"x-wix-docs":{"exposure":"PUBLIC"}},"invoiceInfo":{"description":"Invoice information.","$ref":"#/components/schemas/wix.orders.api.v2.InvoiceInfo","summary":"invoiceInfo","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillments":{"description":"Order fulfillment information.","readOnly":true,"title":"fulfillments","type":"array","items":{"$ref":"#/components/schemas/wix.orders.api.v2.Fulfillment"},"x-wix-docs":{"exposure":"PUBLIC"}},"discount":{"description":"Discount information.","$ref":"#/components/schemas/wix.orders.api.v2.Discount","summary":"discount","x-wix-docs":{"exposure":"PUBLIC"}},"customField":{"description":"Custom field information.","$ref":"#/components/schemas/wix.orders.api.v2.CustomField","summary":"customField","x-wix-docs":{"exposure":"PUBLIC"}},"cartId":{"description":"Shopping cart ID.","format":"GUID","title":"cartId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"buyerLanguage":{"description":"Language for communication with the buyer. Defaults to the site language.\nFor a site that supports multiple languages, this is the language the buyer selected.","maxLength":10,"title":"buyerLanguage","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"channelInfo":{"description":"Information about the sales channel that submitted this order.","$ref":"#/components/schemas/wix.orders.api.v2.ChannelInfo","summary":"channelInfo","x-wix-docs":{"exposure":"PUBLIC"}},"enteredBy":{"description":"Identity of the order's initiator.","readOnly":true,"$ref":"#/components/schemas/wix.orders.api.v2.EnteredBy","summary":"enteredBy","x-wix-docs":{"exposure":"PUBLIC"}},"lastUpdated":{"description":"Date and time of latest update.","readOnly":true,"title":"lastUpdated","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"subscriptionInfo":{"description":"Subscription information.","$ref":"#/components/schemas/wix.orders.api.v2.SubscriptionInfo","summary":"subscriptionInfo","x-wix-docs":{"exposure":"PUBLIC"}},"numericId":{"description":"Order’s unique numeric ID.\nPrimarily used for sorting and filtering when crawling all orders.","readOnly":true,"title":"numericId","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"refunds":{"description":"Refund information.","readOnly":true,"title":"refunds","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecommerce.orders.api.v2.Refund"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Order","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StringValue","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Timestamp","description":""},"wix.orders.api.v2.BuyerInfo":{"type":"object","properties":{"id":{"description":"Wix customer ID","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"type":{"description":"Deprecated (use identityType instead)","readOnly":true,"title":"type","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.IdentityType","x-wix-docs":{"exposure":"PUBLIC","deprecated":{}}},"identityType":{"description":"Customer type","title":"identityType","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.IdentityType","x-wix-docs":{"exposure":"PUBLIC"}},"firstName":{"description":"Customer's first name","readOnly":true,"title":"firstName","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"lastName":{"description":"Customer's last name","readOnly":true,"title":"lastName","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"phone":{"description":"Customer's phone number","readOnly":true,"title":"phone","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"email":{"description":"Customer's email address","readOnly":true,"title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BuyerInfo","description":"Buyer Info"},"wix.orders.api.v2.IdentityType":{"type":"string","description":"","title":"IdentityType","enum":["UNSPECIFIED_IDENTITY_TYPE","MEMBER","CONTACT"]},"com.wix.ecommerce.platform_common.api.WeightUnit":{"type":"string","description":"","title":"WeightUnit","enum":["UNSPECIFIED_WEIGHT_UNIT","KG","LB"]},"wix.orders.api.v2.Totals":{"type":"object","properties":{"subtotal":{"description":"Subtotal of all the line items, before tax.","format":"DECIMAL_VALUE","title":"subtotal","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"shipping":{"description":"Total shipping price, before tax.","format":"DECIMAL_VALUE","title":"shipping","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"tax":{"description":"Total tax.","format":"DECIMAL_VALUE","title":"tax","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"discount":{"description":"Total calculated discount value.","format":"DECIMAL_VALUE","title":"discount","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"total":{"description":"Total price charged.","format":"DECIMAL_VALUE","title":"total","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"weight":{"description":"Total items weight.","readOnly":true,"title":"weight","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"quantity":{"description":"Total number of line items.","minimum":0,"readOnly":true,"title":"quantity","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"refund":{"description":"Total refund.","format":"DECIMAL_VALUE","readOnly":true,"title":"refund","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"giftCard":{"description":"Total calculated gift card value.","format":"DECIMAL_VALUE","title":"giftCard","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Totals","description":""},"wix.orders.api.v2.BillingInfo":{"type":"object","properties":{"paymentMethod":{"description":"Payment method used for this order","maxLength":50,"title":"paymentMethod","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"externalTransactionId":{"description":"Deprecated (use paymentProviderTransactionId instead)","readOnly":true,"title":"externalTransactionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","deprecated":{}}},"paymentProviderTransactionId":{"description":"Transaction ID from payment provider (e.g., PayPal, Square, Stripe) transaction ID","maxLength":100,"title":"paymentProviderTransactionId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"paymentGatewayTransactionId":{"description":"Transaction ID from payment gateway (e.g., Wix Payments)","maxLength":100,"title":"paymentGatewayTransactionId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"address":{"description":"Full billing address","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.Address","summary":"address","x-wix-docs":{"exposure":"PUBLIC"}},"paidDate":{"description":"Payment date","readOnly":true,"title":"paidDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"refundableByPaymentProvider":{"description":"Whether order can be refunded by payment provider (manually or automatic)","title":"refundableByPaymentProvider","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BillingInfo","description":""},"com.wix.ecommerce.commons.api.Address":{"type":"object","properties":{"fullName":{"description":"Addressee name","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.FullName","summary":"fullName","x-wix-docs":{"exposure":"PUBLIC"}},"country":{"description":"Country code (2 letters)","format":"COUNTRY","title":"country","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"subdivision":{"description":"State or district","maxLength":50,"title":"subdivision","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"city":{"description":"City name","maxLength":150,"title":"city","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"zipCode":{"description":"ZIP/postal code","maxLength":200,"title":"zipCode","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"phone":{"description":"Phone number","maxLength":200,"title":"phone","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"company":{"description":"Company name","maxLength":500,"title":"company","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"email":{"description":"Email address","maxLength":500,"title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"addressLine2":{"description":"address line","maxLength":250,"title":"addressLine2","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"vatId":{"description":"Tax information (for Brazil only)","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.VatId","summary":"vatId","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Address","description":"","oneOf":[{"description":"","summary":"addressLine1Options","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.Address.addressLine1Options"}]},"com.wix.ecommerce.commons.api.Address.addressLine1Options":{"type":"object","title":"addressLine1Options","properties":{"addressLine1":{"description":"Address line 1 (free text)","maxLength":1000,"title":"addressLine1","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"street":{"description":"Address line 1 (street)","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.Street","summary":"street","x-wix-docs":{"exposure":"PUBLIC"}}}},"com.wix.ecommerce.commons.api.FullName":{"type":"object","properties":{"firstName":{"description":"Customer's first name","maxLength":1000,"title":"firstName","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"lastName":{"description":"Customer's last name","maxLength":1000,"title":"lastName","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FullName","description":""},"com.wix.ecommerce.commons.api.Street":{"type":"object","properties":{"number":{"description":"Street number","maxLength":500,"title":"number","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"description":"Street name","maxLength":1000,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Street","description":""},"com.wix.ecommerce.commons.api.VatId":{"type":"object","properties":{"number":{"description":"Customer's tax ID.","maxLength":50,"title":"number","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"type":{"description":"Tax type.\n+ `CPF`: For individual tax payers.\n+ `CNPJ`: For corporations.","title":"type","type":"string","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.VatType","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"VatId","description":""},"com.wix.ecommerce.commons.api.VatType":{"type":"string","description":"Brazilian tax info types","title":"VatType","enum":["UNSPECIFIED_TAX_TYPE","CPF","CNPJ"]},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BoolValue","description":""},"wix.orders.api.v2.ShippingInfo":{"type":"object","properties":{"deliveryOption":{"description":"Shipping option name.","maxLength":1000,"title":"deliveryOption","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"estimatedDeliveryTime":{"description":"Shipping option delivery time.","maxLength":500,"title":"estimatedDeliveryTime","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"deliverByDate":{"description":"Deprecated - Latest expected delivery date.","title":"deliverByDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","deprecated":{}}},"shippingRegion":{"description":"Shipping region.","maxLength":100,"title":"shippingRegion","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"code":{"description":"Unique code of provided shipping option. For example, `\"usps_std_overnight\"`.","maxLength":100,"readOnly":true,"title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ShippingInfo","description":"","oneOf":[{"description":"","summary":"details","$ref":"#/components/schemas/wix.orders.api.v2.ShippingInfo.details"}]},"wix.orders.api.v2.ShippingInfo.details":{"type":"object","title":"details","properties":{"shipmentDetails":{"description":"Shipment details (when this object describes shipment).","$ref":"#/components/schemas/wix.orders.api.v2.ShipmentDetails","summary":"shipmentDetails","x-wix-docs":{"exposure":"PUBLIC"}},"pickupDetails":{"description":"Pickup details (when this object describes pickup).","$ref":"#/components/schemas/wix.orders.api.v2.PickupDetails","summary":"pickupDetails","x-wix-docs":{"exposure":"PUBLIC"}}}},"wix.orders.api.v2.ShipmentDetails":{"type":"object","properties":{"address":{"description":"Shipping destination address.","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.Address","summary":"address","x-wix-docs":{"exposure":"PUBLIC"}},"trackingInfo":{"description":"Deprecated (use fulfillments instead).","readOnly":true,"$ref":"#/components/schemas/wix.orders.api.v2.TrackingInfo","summary":"trackingInfo","x-wix-docs":{"exposure":"PUBLIC","deprecated":{}}},"discount":{"description":"Discount applied for shipping.","format":"DECIMAL_VALUE","title":"discount","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"tax":{"description":"Tax applied for shipping.","format":"DECIMAL_VALUE","title":"tax","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"priceData":{"description":"Price data.","$ref":"#/components/schemas/wix.orders.api.v2.ShippingPriceData","summary":"priceData","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ShipmentDetails","description":""},"wix.orders.api.v2.TrackingInfo":{"type":"object","properties":{"trackingNumber":{"description":"Tracking number","maxLength":100,"readOnly":true,"title":"trackingNumber","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"shippingProvider":{"description":"Shipping provider","maxLength":100,"readOnly":true,"title":"shippingProvider","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"trackingLink":{"description":"Tracking link","format":"WEB_URL","readOnly":true,"title":"trackingLink","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"TrackingInfo","description":""},"wix.orders.api.v2.ShippingPriceData":{"type":"object","properties":{"taxIncludedInPrice":{"description":"Whether tax is included in the price.","title":"taxIncludedInPrice","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"price":{"description":"Shipping price.","format":"DECIMAL_VALUE","title":"price","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ShippingPriceData","description":""},"wix.orders.api.v2.PickupDetails":{"type":"object","properties":{"pickupAddress":{"description":"Pickup address.","$ref":"#/components/schemas/wix.orders.api.v2.PickupAddress","summary":"pickupAddress","x-wix-docs":{"exposure":"PUBLIC"}},"buyerDetails":{"description":"Deprecated (use billingInfo instead).","readOnly":true,"$ref":"#/components/schemas/wix.orders.api.v2.BuyerDetails","summary":"buyerDetails","x-wix-docs":{"exposure":"PUBLIC","deprecated":{}}},"pickupInstructions":{"description":"Store owner's pickup instructions.","maxLength":1000,"title":"pickupInstructions","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PickupDetails","description":""},"wix.orders.api.v2.PickupAddress":{"type":"object","properties":{"country":{"description":"Country code (3 letters)","title":"country","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"subdivision":{"description":"State/District","maxLength":50,"title":"subdivision","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"addressLine1":{"description":"Address","maxLength":250,"title":"addressLine1","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"city":{"description":"City","maxLength":100,"title":"city","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"zipCode":{"description":"ZIP/postal code","maxLength":50,"title":"zipCode","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PickupAddress","description":""},"wix.orders.api.v2.BuyerDetails":{"type":"object","properties":{"fullName":{"description":"Addressee name","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.FullName","summary":"fullName","x-wix-docs":{"exposure":"PUBLIC"}},"email":{"description":"Email address","maxLength":100,"format":"EMAIL","title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"phone":{"description":"Phone number","maxLength":30,"format":"PHONE","title":"phone","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BuyerDetails","description":""},"wix.orders.api.v2.PaymentStatus":{"type":"string","description":"This might be extended in the future with pending orders statuses","title":"PaymentStatus","enum":["UNSPECIFIED_PAYMENT_STATUS","PENDING","NOT_PAID","PAID","PARTIALLY_REFUNDED","FULLY_REFUNDED","PARTIALLY_PAID"]},"wix.orders.api.v2.FulfillmentStatus":{"type":"string","description":"","title":"FulfillmentStatus","enum":["NOT_FULFILLED","FULFILLED","CANCELED","PARTIALLY_FULFILLED"]},"wix.orders.api.v2.LineItem":{"type":"object","properties":{"index":{"description":"Line item ID (auto-generated, stable within this order only)","readOnly":true,"title":"index","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"quantity":{"description":"Line item quantity","minimum":1,"maximum":100000,"title":"quantity","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"price":{"description":"Deprecated (use priceData instead)","format":"DECIMAL_VALUE","readOnly":true,"title":"price","type":"string","x-wix-docs":{"exposure":"PUBLIC","deprecated":{}}},"name":{"description":"Line item name","minLength":1,"maxLength":150,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"translatedName":{"description":"Product name, translated into the customer's language","title":"translatedName","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"productId":{"description":"Line item product ID (optional for POS orders)","minLength":1,"title":"productId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"totalPrice":{"description":"Deprecated (use priceData instead)","format":"DECIMAL_VALUE","readOnly":true,"title":"totalPrice","type":"string","x-wix-docs":{"exposure":"PUBLIC","deprecated":{}}},"lineItemType":{"description":"Line item type (may be extended)","title":"lineItemType","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.LineItemType","x-wix-docs":{"exposure":"PUBLIC"}},"options":{"description":"Line item options ordered","maxItems":6,"title":"options","type":"array","items":{"$ref":"#/components/schemas/wix.orders.api.v2.OptionSelection"},"x-wix-docs":{"exposure":"PUBLIC"}},"customTextFields":{"description":"Line item custom text field entry","maxItems":500,"title":"customTextFields","type":"array","items":{"$ref":"#/components/schemas/wix.orders.api.v2.CustomTextFieldSelection"},"x-wix-docs":{"exposure":"PUBLIC"}},"weight":{"description":"Line item weight","format":"DECIMAL_VALUE","title":"weight","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"mediaItem":{"description":"Primary media for preview of the line item","$ref":"#/components/schemas/wix.orders.api.v2.MediaItem","summary":"mediaItem","x-wix-docs":{"exposure":"PUBLIC"}},"sku":{"description":"Line item SKU","maxLength":40,"title":"sku","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"notes":{"description":"Line item notes","maxLength":1000,"title":"notes","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"variantId":{"description":"Line item variantId (from Stores Catalog)","title":"variantId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillerId":{"description":"Line item fulfillerId from stores fulfillers. No value equals self fulfilled","format":"GUID","title":"fulfillerId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"discount":{"description":"Discount applied for this line item","format":"DECIMAL_VALUE","title":"discount","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"tax":{"description":"Tax applied for this line item","format":"DECIMAL_VALUE","title":"tax","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"taxIncludedInPrice":{"description":"Deprecated (use priceData instead)","readOnly":true,"title":"taxIncludedInPrice","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","deprecated":{}}},"taxGroupId":{"description":"Tax group ID","format":"GUID","title":"taxGroupId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"priceData":{"description":"Price data","$ref":"#/components/schemas/wix.orders.api.v2.LineItemPriceData","summary":"priceData","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"LineItem","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Int32Value","description":""},"wix.orders.api.v2.LineItemType":{"type":"string","description":"","title":"LineItemType","enum":["UNSPECIFIED_LINE_ITEM_TYPE","PHYSICAL","DIGITAL","CUSTOM_AMOUNT_ITEM"]},"wix.orders.api.v2.OptionSelection":{"type":"object","properties":{"option":{"description":"Option name","maxLength":1000,"title":"option","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"selection":{"description":"Selected choice for this option","maxLength":16000,"title":"selection","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OptionSelection","description":""},"wix.orders.api.v2.CustomTextFieldSelection":{"type":"object","properties":{"title":{"description":"Custom text field name","maxLength":1000,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"value":{"description":"Custom text field value","maxLength":16000,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CustomTextFieldSelection","description":""},"wix.orders.api.v2.MediaItem":{"type":"object","properties":{"mediaType":{"description":"Media type","readOnly":true,"title":"mediaType","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.MediaItemType","x-wix-docs":{"exposure":"PUBLIC"}},"url":{"description":"Media URL","format":"WEB_URL","readOnly":true,"title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"width":{"description":"Media item width","minimum":0,"readOnly":true,"title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"height":{"description":"Media item height","minimum":0,"readOnly":true,"title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"mediaId":{"description":"Deprecated","title":"mediaId","type":"string","x-wix-docs":{"exposure":"PUBLIC","deprecated":{}}},"id":{"description":"Media ID (for media items previously saved in Wix Media)","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"externalImageUrl":{"description":"Media external URL","title":"externalImageUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"altText":{"description":"Alternative text for presentation when media cannot be displayed","maxLength":256,"title":"altText","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"MediaItem","description":""},"wix.orders.api.v2.MediaItemType":{"type":"string","description":"","title":"MediaItemType","enum":["UNSPECIFIED_MEDIA_TYPE_ITEM","IMAGE"]},"wix.orders.api.v2.LineItemPriceData":{"type":"object","properties":{"taxIncludedInPrice":{"description":"Whether tax is included in the price set for this line item","title":"taxIncludedInPrice","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"price":{"description":"Line item price","format":"DECIMAL_VALUE","title":"price","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"totalPrice":{"description":"Total price charged to the customer (per line item) after computation of quantity and discount","format":"DECIMAL_VALUE","readOnly":true,"title":"totalPrice","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"LineItemPriceData","description":""},"wix.orders.api.v2.DigitalFile":{"type":"object","properties":{"fileId":{"description":"id of the secure file in media","minLength":1,"maxLength":100,"title":"fileId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DigitalFile","description":""},"wix.orders.api.v2.Activity":{"type":"object","properties":{"type":{"description":"Activity item type","readOnly":true,"title":"type","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.ActivityType","x-wix-docs":{"exposure":"PUBLIC"}},"author":{"description":"Activity item author","maxLength":50,"readOnly":true,"title":"author","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"message":{"description":"Comment added to activity item","maxLength":1000,"readOnly":true,"title":"message","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"timestamp":{"description":"Activity item timestamp","readOnly":true,"title":"timestamp","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Activity","description":""},"wix.orders.api.v2.ActivityType":{"type":"string","description":"","title":"ActivityType","enum":["UNSPECIFIED_ORDER_HISTORY_ITEM_TYPE","MERCHANT_COMMENT","ORDER_PLACED","ORDER_PAID","ORDER_FULFILLED","ORDER_NOT_FULFILLED","DOWNLOAD_LINK_SENT","PICKUP_READY_EMAIL_SENT","TRACKING_NUMBER_ADDED","TRACKING_NUMBER_EDITED","TRACKING_LINK_WAS_SET","SHIPPING_CONFIRMATION_EMAIL_SENT","INVOICE_WAS_SET","INVOICE_WAS_REMOVED","INVOICE_WAS_SENT","FULFILLER_EMAIL_SENT","SHIPPING_ADDRESS_EDITED","EMAIL_EDITED","ORDER_PARTIALLY_PAID"]},"wix.orders.api.v2.InvoiceInfo":{"type":"object","properties":{"id":{"description":"Invoice ID","maxLength":100,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"source":{"description":"Invoice source","title":"source","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.InvoiceSource","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"InvoiceInfo","description":""},"wix.orders.api.v2.InvoiceSource":{"type":"string","description":"","title":"InvoiceSource","enum":["UNSPECIFIED_INVOICE_SOURCE","WIX"]},"wix.orders.api.v2.Fulfillment":{"type":"object","properties":{"id":{"description":"Fulfillment ID (auto generated upon fulfillment creation).","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"dateCreated":{"description":"Fulfillment creation date and time.","readOnly":true,"title":"dateCreated","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"lineItems":{"description":"Information about the line items in the fulfilled order.","minItems":1,"maxItems":300,"title":"lineItems","type":"array","items":{"$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentLineItem"},"x-wix-docs":{"exposure":"PUBLIC"}},"trackingInfo":{"description":"Tracking information.","$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentTrackingInfo","summary":"trackingInfo","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Fulfillment","description":""},"wix.orders.api.v2.FulfillmentLineItem":{"type":"object","properties":{"index":{"description":"Line item ID (mirrors the line item index of the order).","minimum":1,"maximum":200,"title":"index","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"quantity":{"description":"Line item quantity.\nOn creation, if this parameter isn't passed, the new fulfillment will automatically include all items of this line item that have not already been linked to a fulfillment.\nIf the order does not have the requested quantity of line items available to add to this fulfillment, the fulfillment will not be created and an error will be returned.\nThis property will always have a value when returned.","minimum":1,"maximum":100000,"title":"quantity","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FulfillmentLineItem","description":""},"wix.orders.api.v2.FulfillmentTrackingInfo":{"type":"object","properties":{"trackingNumber":{"description":"Tracking number.","minLength":1,"maxLength":100,"title":"trackingNumber","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"shippingProvider":{"description":"Shipping provider. Using the following shipping providers will allow for autofilling the tracking link:\n* `fedex`\n* `ups`\n* `usps`\n* `dhl`\n* `canadaPost`","minLength":1,"maxLength":100,"title":"shippingProvider","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"trackingLink":{"description":"Tracking link - autofilled if using a predefined shipping provider, otherwise provided on creation.","minLength":1,"maxLength":2048,"format":"WEB_URL","title":"trackingLink","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FulfillmentTrackingInfo","description":""},"wix.orders.api.v2.Discount":{"type":"object","properties":{"value":{"description":"Deprecated (use Totals.discount instead)","readOnly":true,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","deprecated":{}}},"appliedCoupon":{"description":"Applied coupon","$ref":"#/components/schemas/wix.orders.api.v2.AppliedCoupon","summary":"appliedCoupon","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Discount","description":""},"wix.orders.api.v2.AppliedCoupon":{"type":"object","properties":{"couponId":{"description":"Coupon ID","minLength":1,"maxLength":100,"title":"couponId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"description":"Coupon name","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"code":{"description":"Coupon code","maxLength":100,"title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AppliedCoupon","description":""},"wix.orders.api.v2.CustomField":{"type":"object","properties":{"value":{"description":"Free text that the customer entered in the custom field during the checkout process","maxLength":1000,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"title":{"description":"Title for the custom field","maxLength":1000,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"translatedTitle":{"description":"The title translated according to the buyer language","maxLength":1000,"title":"translatedTitle","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CustomField","description":"Custom field"},"wix.orders.api.v2.ChannelInfo":{"type":"object","properties":{"type":{"description":"Sales channel that submitted the order","title":"type","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.ChannelInfo.ChannelType","x-wix-docs":{"exposure":"PUBLIC"}},"externalOrderId":{"description":"Reference to an order ID from an external system, as defined in channelInfo (e.g., eBay or Amazon)","maxLength":100,"title":"externalOrderId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"externalOrderUrl":{"description":"URL to the order in the external system, as defined in channelInfo (e.g., eBay or Amazon)","maxLength":300,"title":"externalOrderUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ChannelInfo","description":""},"wix.orders.api.v2.ChannelInfo.ChannelType":{"type":"string","description":"","title":"ChannelType","enum":["UNSPECIFIED","WEB","POS","EBAY","AMAZON","OTHER_PLATFORM","WIX_APP_STORE","WIX_INVOICES","BACKOFFICE_MERCHANT","WISH","CLASS_PASS","GLOBAL_E"]},"wix.orders.api.v2.EnteredBy":{"type":"object","properties":{"id":{"description":"","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"identityType":{"description":"","title":"identityType","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.EnteredBy.EnteredByIdentityType","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"EnteredBy","description":""},"wix.orders.api.v2.EnteredBy.EnteredByIdentityType":{"type":"string","description":"","title":"EnteredByIdentityType","enum":["USER","MEMBER","CONTACT","APP"]},"wix.orders.api.v2.SubscriptionInfo":{"type":"object","properties":{"id":{"description":"Subscription ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"cycleNumber":{"description":"Current cycle number. For example, if the subscription is in the 3rd month of a 4-month subscription, the value will be `3`.","minimum":1,"title":"cycleNumber","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"subscriptionSettings":{"description":"Subscription settings.","$ref":"#/components/schemas/wix.ecommerce.subscription.option.api.v1.SubscriptionSettings","summary":"subscriptionSettings","x-wix-docs":{"exposure":"PUBLIC"}},"subscriptionOptionInfo":{"description":"Subscription options info.","$ref":"#/components/schemas/wix.orders.api.v2.SubscriptionOptionInfo","summary":"subscriptionOptionInfo","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SubscriptionInfo","description":""},"wix.ecommerce.subscription.option.api.v1.SubscriptionSettings":{"type":"object","properties":{"frequency":{"description":"Frequency of recurring payment.","title":"frequency","type":"string","$ref":"#/components/schemas/wix.payment.api.pay.v2.SubscriptionFrequency","x-wix-docs":{"exposure":"PUBLIC"}},"autoRenewal":{"description":"Whether subscription is renewed automatically at the end of each period.","title":"autoRenewal","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"billingCycles":{"description":"Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.","minimum":2,"maximum":999,"title":"billingCycles","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SubscriptionSettings","description":""},"wix.payment.api.pay.v2.SubscriptionFrequency":{"type":"string","description":"Frequency unit of recurring payment","title":"SubscriptionFrequency","enum":["UNDEFINED","DAY","WEEK","MONTH","YEAR"]},"wix.orders.api.v2.SubscriptionOptionInfo":{"type":"object","properties":{"title":{"description":"Subscription option title.","minLength":1,"maxLength":20,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"description":{"description":"Subscription option description.","maxLength":60,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SubscriptionOptionInfo","description":""},"com.wix.ecommerce.orders.api.v2.Refund":{"type":"object","properties":{"dateCreated":{"description":"Refund created timestamp.","title":"dateCreated","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"amount":{"description":"Refund amount.","format":"DECIMAL_VALUE","title":"amount","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"reason":{"description":"Reason for refund, given by user (optional).","title":"reason","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"paymentProviderTransactionId":{"description":"Payment provider transaction ID. Used to find refund transaction info on the payment provider's side.","title":"paymentProviderTransactionId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"id":{"description":"Refund ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"externalRefund":{"description":"Whether refund was made externally (on the payment provider's side).","title":"externalRefund","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Refund","description":""},"wix.orders.api.v2.GiftCard":{"type":"object","properties":{"transactionId":{"description":"","format":"GUID","title":"transactionId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"id":{"description":"giftcard internal ID","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"providerId":{"description":"giftcard provider appid","format":"GUID","title":"providerId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"amount":{"description":"giftcard amount","format":"DECIMAL_VALUE","title":"amount","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GiftCard","description":""},"wix.orders.api.v2.OrderAddressUpdated":{"type":"object","properties":{"order":{"description":"Updated order data.","readOnly":true,"$ref":"#/components/schemas/wix.orders.api.v2.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderAddressUpdated","description":""},"wix.orders.api.v2.CreateOrderRequest":{"type":"object","properties":{"order":{"description":"","$ref":"#/components/schemas/wix.orders.api.v2.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateOrderRequest","description":""},"wix.orders.api.v2.AdditionalOrderSettings":{"type":"object","properties":{"lineItemId":{"description":"ID of the line item this setting applies to","title":"lineItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"preorderRequest":{"description":"Whether this line item purchase was made as part of a purchase that includes preorder items.","title":"preorderRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AdditionalOrderSettings","description":""},"wix.orders.api.v2.CreateOrderResponse":{"type":"object","properties":{"order":{"description":"","$ref":"#/components/schemas/wix.orders.api.v2.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateOrderResponse","description":""},"wix.orders.api.v2.BulkFulfillOrdersRequest":{"type":"object","properties":{"filter":{"description":"","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"sendShippingConfirmationEmail":{"description":"when true shipping confirmation email will be sent to the buyer for all orders with shipment delivery","title":"sendShippingConfirmationEmail","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"sendPickupReadyEmail":{"description":"when true pickup ready email will be sent to the buyer for all orders with pickup delivery","title":"sendPickupReadyEmail","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkFulfillOrdersRequest","description":""},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListValue","description":""},"wix.orders.api.v2.BulkFulfillOrdersResponse":{"type":"object","properties":{},"title":"BulkFulfillOrdersResponse","description":""},"wix.orders.api.v2.BulkMarkOrdersAsPaidRequest":{"type":"object","properties":{"filter":{"description":"","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkMarkOrdersAsPaidRequest","description":""},"wix.orders.api.v2.BulkMarkOrdersAsPaidResponse":{"type":"object","properties":{},"title":"BulkMarkOrdersAsPaidResponse","description":""},"wix.orders.api.v2.BulkArchiveOrdersRequest":{"type":"object","properties":{"filter":{"description":"","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkArchiveOrdersRequest","description":""},"wix.orders.api.v2.BulkArchiveOrdersResponse":{"type":"object","properties":{},"title":"BulkArchiveOrdersResponse","description":""},"wix.orders.api.v2.BulkUnarchiveOrdersRequest":{"type":"object","properties":{"filter":{"description":"","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkUnarchiveOrdersRequest","description":""},"wix.orders.api.v2.BulkUnarchiveOrdersResponse":{"type":"object","properties":{},"title":"BulkUnarchiveOrdersResponse","description":""},"wix.orders.api.v2.AddFulfillerEmailWasSentActivityRequest":{"type":"object","properties":{"orderId":{"description":"","format":"GUID","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AddFulfillerEmailWasSentActivityRequest","description":""},"wix.orders.api.v2.AddFulfillerEmailWasSentActivityResponse":{"type":"object","properties":{},"title":"AddFulfillerEmailWasSentActivityResponse","description":""},"wix.orders.api.v2.DeclineOrderRequest":{"type":"object","properties":{"orderId":{"description":"","format":"GUID","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"eventTime":{"description":"","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"reason":{"description":"","maxLength":300,"title":"reason","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DeclineOrderRequest","description":""},"wix.orders.api.v2.DeclineOrderResponse":{"type":"object","properties":{},"title":"DeclineOrderResponse","description":""},"wix.orders.api.v2.UpdateOrderEmailRequest":{"type":"object","properties":{"orderId":{"description":"Order ID.","minLength":1,"maxLength":100,"readOnly":true,"title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"email":{"description":"New email address for billing and shipping info.","maxLength":100,"format":"EMAIL","title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateOrderEmailRequest","description":""},"wix.orders.api.v2.UpdateOrderEmailResponse":{"type":"object","properties":{"order":{"description":"Updated order data.","$ref":"#/components/schemas/wix.orders.api.v2.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateOrderEmailResponse","description":""},"wix.orders.api.v2.UpdateOrderShippingAddressRequest":{"type":"object","properties":{"orderId":{"description":"Order ID.","minLength":1,"maxLength":100,"readOnly":true,"title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"shippingAddress":{"description":"New order shipping address.","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.Address","summary":"shippingAddress","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateOrderShippingAddressRequest","description":""},"wix.orders.api.v2.UpdateOrderShippingAddressResponse":{"type":"object","properties":{"order":{"description":"Updated order data.","$ref":"#/components/schemas/wix.orders.api.v2.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateOrderShippingAddressResponse","description":""},"com.wix.diffmatoky.migration.DiffmatokyPayload":{"type":"object","properties":{"left":{"description":"","title":"left","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"right":{"description":"","title":"right","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"compareChannel":{"description":"","title":"compareChannel","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"entityId":{"description":"","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"errorInformation":{"description":"","$ref":"#/components/schemas/com.wix.diffmatoky.migration.ErrorInformation","summary":"errorInformation","x-wix-docs":{"exposure":"PUBLIC"}},"tags":{"description":"","title":"tags","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DiffmatokyPayload","description":""},"com.wix.diffmatoky.migration.ErrorInformation":{"type":"object","properties":{"stackTrace":{"description":"","title":"stackTrace","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ErrorInformation","description":""},"wix.orders.api.v2.OrderCreated":{"type":"object","properties":{"orderId":{"description":"Order ID (auto generated upon order creation)","format":"GUID","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"number":{"description":"ID displayed in the owner's store (auto generated)","title":"number","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"dateCreated":{"description":"Order creation date","title":"dateCreated","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"buyerInfo":{"description":"Customer information","$ref":"#/components/schemas/wix.orders.api.v2.BuyerInfo","summary":"buyerInfo","x-wix-docs":{"exposure":"PUBLIC"}},"currency":{"description":"Currency used for pricing in this store","maxLength":3,"title":"currency","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"weightUnit":{"description":"Weight unit used in this store","title":"weightUnit","type":"string","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.WeightUnit","x-wix-docs":{"exposure":"PUBLIC"}},"totals":{"description":"Totals for order's line items","$ref":"#/components/schemas/wix.orders.api.v2.Totals","summary":"totals","x-wix-docs":{"exposure":"PUBLIC"}},"read":{"description":"Whether the order was read by the store owner","title":"read","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"archived":{"description":"Order archive status","title":"archived","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"paymentStatus":{"description":"Order payment status","title":"paymentStatus","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.PaymentStatus","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillmentStatus":{"description":"Order fulfillment status","title":"fulfillmentStatus","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentStatus","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderCreated","description":""},"com.wix.ecom.orders.side_effects_migration.api.OrdersExperiments":{"type":"object","properties":{"epCommitTax":{"description":"","title":"epCommitTax","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"moveMerchantEmailToEp":{"description":"","title":"moveMerchantEmailToEp","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"moveBuyerOrderConfirmationEmailToEp":{"description":"","title":"moveBuyerOrderConfirmationEmailToEp","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"producedByEpBridge":{"description":"","title":"producedByEpBridge","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"enableRewrittenSideEffects":{"description":"","title":"enableRewrittenSideEffects","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrdersExperiments","description":""},"com.wix.ecommerce.orders.api.v2.OrderPaid":{"type":"object","properties":{"order":{"description":"Paid order data.","$ref":"#/components/schemas/wix.orders.api.v2.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderPaid","description":""},"wix.orders.api.v2.OrderCancelRefundEvent":{"type":"object","properties":{"isCancel":{"description":"","readOnly":true,"title":"isCancel","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"issueDate":{"description":"date when cancel/refund was issued","readOnly":true,"title":"issueDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"refund":{"description":"will be defined if order was refunded","$ref":"#/components/schemas/com.wix.ecommerce.orders.api.v2.Refund","summary":"refund","x-wix-docs":{"exposure":"PUBLIC"}},"orderData":{"description":"","$ref":"#/components/schemas/wix.orders.api.v2.OrderData","summary":"orderData","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderCancelRefundEvent","description":""},"wix.orders.api.v2.OrderData":{"type":"object","properties":{"orderId":{"description":"Order ID (auto generated upon order creation)","format":"GUID","readOnly":true,"title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"isOffline":{"description":"means that order paid with cash, such orders might be not paid","readOnly":true,"title":"isOffline","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"paymentStatus":{"description":"Order payment status","readOnly":true,"title":"paymentStatus","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.PaymentStatus","x-wix-docs":{"exposure":"PUBLIC"}},"originalTotal":{"description":"Total price charged when order placed, this value isn't affected by refunds","format":"DECIMAL_VALUE","title":"originalTotal","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"dateCreated":{"description":"Order creation date","readOnly":true,"title":"dateCreated","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderData","description":""},"wix.orders.api.v2.OrderCanceled":{"type":"object","properties":{"order":{"description":"Canceled order data.","readOnly":true,"$ref":"#/components/schemas/wix.orders.api.v2.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderCanceled","description":""},"wix.orders.api.v2.OrderRefunded":{"type":"object","properties":{"refundId":{"description":"Refund ID.","readOnly":true,"title":"refundId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"order":{"description":"Refunded order data.","readOnly":true,"$ref":"#/components/schemas/wix.orders.api.v2.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderRefunded","description":""},"wix.orders.api.v2.FulfillmentCreated":{"type":"object","properties":{"orderId":{"description":"Order ID (auto generated upon order creation).","format":"GUID","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillmentId":{"description":"ID of the newly created fulfillment.","format":"GUID","title":"fulfillmentId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"dateCreated":{"description":"Fulfillment creation date and time.","title":"dateCreated","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"buyerInfo":{"description":"Buyer information.","$ref":"#/components/schemas/wix.orders.api.v2.BuyerInfo","summary":"buyerInfo","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillmentStatus":{"description":"Order fulfillment status.","title":"fulfillmentStatus","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentStatus","x-wix-docs":{"exposure":"PUBLIC"}},"trackingInfo":{"description":"Fulfillment tracking information.","$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentTrackingInfo","summary":"trackingInfo","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FulfillmentCreated","description":""},"wix.orders.api.v2.FulfillmentUpdated":{"type":"object","properties":{"orderId":{"description":"Order ID (auto generated upon order creation).","format":"GUID","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillmentId":{"description":"ID of the updated fulfillment.","format":"GUID","title":"fulfillmentId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"trackingInfo":{"description":"Fulfillment tracking information.","$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentTrackingInfo","summary":"trackingInfo","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FulfillmentUpdated","description":""},"wix.orders.api.v2.FulfillmentDeleted":{"type":"object","properties":{"orderId":{"description":"Order ID (auto generated upon order creation).","format":"GUID","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillmentId":{"description":"ID of the deleted fulfillment.","format":"GUID","title":"fulfillmentId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillmentStatus":{"description":"Order fulfillment status.","title":"fulfillmentStatus","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentStatus","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FulfillmentDeleted","description":""},"com.wix.ecommerce.orders.api.v2.OrderDeclined":{"type":"object","properties":{"order":{"description":"","$ref":"#/components/schemas/wix.orders.api.v2.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderDeclined","description":""},"wix.orders.api.v2.GetOrderRequestV2":{"type":"object","properties":{"id":{"description":"Requested order ID","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetOrderRequestV2","description":""},"wix.orders.api.v2.GetOrderResponseV2":{"type":"object","properties":{"order":{"description":"Order data","$ref":"#/components/schemas/wix.orders.api.v2.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetOrderResponseV2","description":""},"wix.orders.api.v2.QueryOrdersRequestV2":{"type":"object","properties":{"query":{"description":"Query","$ref":"#/components/schemas/wix.orders.api.v2.Query","summary":"query","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryOrdersRequestV2","description":""},"wix.orders.api.v2.Query":{"type":"object","properties":{"paging":{"description":"","$ref":"#/components/schemas/wix.orders.api.v2.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC"}},"filter":{"description":"A filter string","title":"filter","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"sort":{"description":"A sort string","title":"sort","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Query","description":""},"wix.orders.api.v2.Paging":{"type":"object","properties":{"limit":{"description":"Number of items to load","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"description":"The offset since the beginning of the collection","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Paging","description":""},"wix.orders.api.v2.QueryOrdersResponseV2":{"type":"object","properties":{"orders":{"description":"Order data","title":"orders","type":"array","items":{"$ref":"#/components/schemas/wix.orders.api.v2.Order"},"x-wix-docs":{"exposure":"PUBLIC"}},"metadata":{"description":"Paging metadata","$ref":"#/components/schemas/wix.orders.api.v2.PagingMetadata","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC"}},"totalResults":{"description":"Total results","title":"totalResults","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryOrdersResponseV2","description":""},"wix.orders.api.v2.PagingMetadata":{"type":"object","properties":{"items":{"description":"Requested number of items to load","title":"items","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"description":"Requested offset since the beginning of the collection","title":"offset","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PagingMetadata","description":""},"wix.orders.api.v2.CreateFulfillmentRequest":{"type":"object","properties":{"orderId":{"description":"Order ID (to which the fulfillment will be related).","format":"GUID","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillment":{"description":"Fulfillment info.","$ref":"#/components/schemas/wix.orders.api.v2.Fulfillment","summary":"fulfillment","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateFulfillmentRequest","description":""},"wix.orders.api.v2.CreateFulfillmentResponse":{"type":"object","properties":{"id":{"description":"Fulfillment ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"order":{"description":"Updated order data.","$ref":"#/components/schemas/wix.orders.api.v2.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateFulfillmentResponse","description":""},"wix.orders.api.v2.UpdateFulfillmentRequest":{"type":"object","properties":{"orderId":{"description":"Order ID.","format":"GUID","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillmentId":{"description":"Fulfillment ID","format":"GUID","title":"fulfillmentId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillmentTrackingInfo":{"description":"Updated tracking info.","$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentTrackingInfo","summary":"fulfillmentTrackingInfo","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateFulfillmentRequest","description":""},"wix.orders.api.v2.UpdateFulfillmentResponse":{"type":"object","properties":{"order":{"description":"Updated order data.","$ref":"#/components/schemas/wix.orders.api.v2.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateFulfillmentResponse","description":""},"wix.orders.api.v2.DeleteFulfillmentRequest":{"type":"object","properties":{"orderId":{"description":"Order ID.","format":"GUID","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillmentId":{"description":"Fulfillment ID.","format":"GUID","title":"fulfillmentId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DeleteFulfillmentRequest","description":""},"wix.orders.api.v2.DeleteFulfillmentResponse":{"type":"object","properties":{"order":{"description":"Updated order data.","$ref":"#/components/schemas/wix.orders.api.v2.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DeleteFulfillmentResponse","description":""},"wix.orders.api.v2.MarkAsPaidRequest":{"type":"object","properties":{"id":{"description":"The order id","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"paymentInfo":{"description":"The payment info","$ref":"#/components/schemas/wix.orders.api.v2.RequestPaymentInfo","summary":"paymentInfo","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"MarkAsPaidRequest","description":""},"wix.orders.api.v2.RequestPaymentInfo":{"type":"object","properties":{"paymentMethod":{"description":"Payment method used for this order","maxLength":50,"title":"paymentMethod","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"externalTransactionId":{"description":"External transaction ID","maxLength":100,"title":"externalTransactionId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"RequestPaymentInfo","description":""},"wix.orders.api.v2.MarkAsPaidResponse":{"type":"object","properties":{},"title":"MarkAsPaidResponse","description":""},"wix.orders.api.v2.SetShippingFulfillmentRequest":{"type":"object","properties":{"id":{"description":"The order id","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"status":{"description":"Shipment fulfillment status","title":"status","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.ShipmentFulfillmentStatus","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SetShippingFulfillmentRequest","description":""},"wix.orders.api.v2.ShipmentFulfillmentStatus":{"type":"string","description":"This may be expanded in the future to include partial fulfillments","title":"ShipmentFulfillmentStatus","enum":["UNSPECIFIED_SHIPMENT_FULFILLMENT_STATUS","SHIPMENT_NOT_FULFILLED","SHIPMENT_FULFILLED"]},"wix.orders.api.v2.SetShippingFulfillmentResponse":{"type":"object","properties":{},"title":"SetShippingFulfillmentResponse","description":""},"wix.orders.api.v2.SendFulfillmentConfirmationRequest":{"type":"object","properties":{"id":{"description":"The order id","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SendFulfillmentConfirmationRequest","description":""},"wix.orders.api.v2.SendFulfillmentConfirmationResponse":{"type":"object","properties":{},"title":"SendFulfillmentConfirmationResponse","description":""},"wix.orders.api.v2.MarkAsReadRequest":{"type":"object","properties":{"id":{"description":"The order id","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"MarkAsReadRequest","description":""},"wix.orders.api.v2.MarkAsReadResponse":{"type":"object","properties":{},"title":"MarkAsReadResponse","description":""},"wix.orders.api.v2.SetArchiveStatusRequest":{"type":"object","properties":{"id":{"description":"The order id","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"archived":{"description":"New archive status","title":"archived","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SetArchiveStatusRequest","description":""},"wix.orders.api.v2.SetArchiveStatusResponse":{"type":"object","properties":{},"title":"SetArchiveStatusResponse","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"eventTime":{"description":"Event timestamp.","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ActionEvent","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Int64Value","description":""}}},"title":"Orders","description":"","fqdn":"wix.stores.v2.orders"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Orders Service\n\n

\n\n__Deprecation Notice:__\n\nStores Orders API has been replaced with\n[eCommerce Orders API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::546b2514-6a71-4148-bccf-1fb8d8604792slug::introduction*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/introduction)\nand will be removed on September 4, 2024.\n\nLearn more about [migrating from Wix Stores to Wix eCommerce](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::546b2514-6a71-4148-bccf-1fb8d8604792slug::order-object-conversion*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion).\n\n

Get Order

Permission Scopes