{"id":"7fe67a47-45fc-40d1-ad64-dedb03b52bd3","createdDate":"2024-05-28T09:51:00.586Z","updatedDate":"2024-05-28T09:51:00.586Z","resourceId":"12e752bf-af0b-4cf5-ae1e-91e68a073e3d","api":{"schema":{"object":{"displayName":"Order Transactions Object","description":"Manage eCommerce order payments","slug":"order-transactions-object","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.OrderTransactions","legacyExamples":[{"title":"OrderTransactions","content":"{\n \"orderTransactions\": {\n \"orderId\": \"8d009fbe-6600-4c7a-ad23-37e9f0477947\",\n \"payments\": [\n {\n \"id\": \"a335aebd-4688-437e-84c3-ebe947779bc1\",\n \"giftcardPaymentDetails\": {\n \"giftCardPaymentId\": \"ff3c2b57-2dc4-47de-a261-9ae00251a60b\",\n \"giftCardId\": \"\",\n \"appId\": \"d80111c5-a0f4-47a8-b63a-65b54d774a27\",\n \"voided\": false\n },\n \"createdDate\": \"2023-09-01T20:20:26.451Z\",\n \"updatedDate\": \"2023-09-01T20:20:26.451Z\",\n \"amount\": {\n \"amount\": \"25.0\",\n \"formattedAmount\": \"C$25.00\"\n },\n \"refundDisabled\": false\n },\n {\n \"id\": \"62fdfea7-896d-438d-9b88-4d7c1a4674ac\",\n \"regularPaymentDetails\": {\n \"gatewayTransactionId\": \"42a6c722-b27d-49fc-9a18-827115c4bd66\",\n \"paymentMethod\": \"Stripe\",\n \"providerTransactionId\": \"pi_3NmFQZINImlhPEm01iyAurzL\",\n \"offlinePayment\": false,\n \"status\": \"REFUNDED\"\n },\n \"createdDate\": \"2023-09-01T20:21:26.451Z\",\n \"updatedDate\": \"2023-09-03T12:30:12.853Z\",\n \"amount\": {\n \"amount\": \"17.99\",\n \"formattedAmount\": \"C$17,99\"\n },\n \"refundDisabled\": false\n }\n ],\n \"refunds\": [\n {\n \"id\": \"3cfa83af-94fe-4e02-a7c7-3a969557f697\",\n \"transactions\": [\n {\n \"paymentId\": \"62fdfea7-896d-438d-9b88-4d7c1a4674ac\",\n \"amount\": {\n \"amount\": \"17.99\",\n \"formattedAmount\": \"C$17,99\"\n },\n \"refundStatus\": \"SUCCEEDED\",\n \"gatewayRefundId\": \"9656f197-74de-4d9a-bac2-85155614ef5e\",\n \"providerRefundId\": \"re_3NmFQZINImlhPEm011HglMxH\",\n \"externalRefund\": false\n }\n ],\n \"details\": {\n \"items\": [\n {\n \"lineItemId\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"shippingIncluded\": true\n },\n \"createdDate\": \"2023-09-03T12:30:12.853Z\"\n }\n ]\n }\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"methods":[{"summary":"List Transactions For Single Order","description":"Retrieves information about payments and refunds associated with a specified order.","operationId":"com.wix.ecom.orders.payments.v1.Payments.ListTransactionsForSingleOrder","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"orderId","description":"Order ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.ListTransactionsForSingleOrderResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/payments","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/payments","destinationPath":"/v1/payments","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.ecom.orders.payments.v1.Payments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.READ_TRANSACTIONS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read eCommerce - all read permissions","scopeId":"SCOPE.DC-ECOM-MEGA.READ-ECOM"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-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:wix-ecom-orders-payments-api","serviceArtifactId":"com.wixpress.ecom.ep-payments-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.payments.v1.ListTransactionsForSingleOrderRequest","responseMessage":"com.wix.ecom.orders.payments.v1.ListTransactionsForSingleOrderResponse"},"legacyExamples":[{"name":"ListTransactionsForSingleOrder","type":"METHOD","content":{"title":"List Transactions For Single Orders","request":"curl -X GET 'https://www.wixapis.com/ecom/v1/payments/orders/8d009fbe-6600-4c7a-ad23-37e9f0477947' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"orderTransactions\": {\n \"orderId\": \"8d009fbe-6600-4c7a-ad23-37e9f0477947\",\n \"payments\": [\n {\n \"id\": \"a335aebd-4688-437e-84c3-ebe947779bc1\",\n \"giftcardPaymentDetails\": {\n \"giftCardPaymentId\": \"ff3c2b57-2dc4-47de-a261-9ae00251a60b\",\n \"giftCardId\": \"\",\n \"appId\": \"d80111c5-a0f4-47a8-b63a-65b54d774a27\",\n \"voided\": false\n },\n \"createdDate\": \"2023-09-01T20:20:26.451Z\",\n \"updatedDate\": \"2023-09-01T20:20:26.451Z\",\n \"amount\": {\n \"amount\": \"25.0\",\n \"formattedAmount\": \"C$25.00\"\n },\n \"refundDisabled\": false\n },\n {\n \"id\": \"62fdfea7-896d-438d-9b88-4d7c1a4674ac\",\n \"regularPaymentDetails\": {\n \"gatewayTransactionId\": \"42a6c722-b27d-49fc-9a18-827115c4bd66\",\n \"paymentMethod\": \"Stripe\",\n \"providerTransactionId\": \"pi_3NmFQZINImlhPEm01iyAurzL\",\n \"offlinePayment\": false,\n \"status\": \"REFUNDED\"\n },\n \"createdDate\": \"2023-09-01T20:21:26.451Z\",\n \"updatedDate\": \"2023-09-03T12:30:12.853Z\",\n \"amount\": {\n \"amount\": \"17.99\",\n \"formattedAmount\": \"C$17,99\"\n },\n \"refundDisabled\": false\n }\n ],\n \"refunds\": [\n {\n \"id\": \"3cfa83af-94fe-4e02-a7c7-3a969557f697\",\n \"transactions\": [\n {\n \"paymentId\": \"62fdfea7-896d-438d-9b88-4d7c1a4674ac\",\n \"amount\": {\n \"amount\": \"17.99\",\n \"formattedAmount\": \"C$17,99\"\n },\n \"refundStatus\": \"SUCCEEDED\",\n \"gatewayRefundId\": \"9656f197-74de-4d9a-bac2-85155614ef5e\",\n \"providerRefundId\": \"re_3NmFQZINImlhPEm011HglMxH\",\n \"externalRefund\": false\n }\n ],\n \"details\": {\n \"items\": [\n {\n \"lineItemId\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"shippingIncluded\": true\n },\n \"createdDate\": \"2023-09-03T12:30:12.853Z\"\n }\n ]\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v1/payments/orders/{orderId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.ecom.orders.payments.v1.Payments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.READ_TRANSACTIONS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read eCommerce - all read permissions","scopeId":"SCOPE.DC-ECOM-MEGA.READ-ECOM"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-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:wix-ecom-orders-payments-api","serviceArtifactId":"com.wixpress.ecom.ep-payments-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.payments.v1.ListTransactionsForSingleOrderRequest","responseMessage":"com.wix.ecom.orders.payments.v1.ListTransactionsForSingleOrderResponse"},"legacyExamples":[{"name":"ListTransactionsForSingleOrder","type":"METHOD","content":{"title":"List Transactions For Single Orders","request":"curl -X GET 'https://www.wixapis.com/ecom/v1/payments/orders/8d009fbe-6600-4c7a-ad23-37e9f0477947' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"orderTransactions\": {\n \"orderId\": \"8d009fbe-6600-4c7a-ad23-37e9f0477947\",\n \"payments\": [\n {\n \"id\": \"a335aebd-4688-437e-84c3-ebe947779bc1\",\n \"giftcardPaymentDetails\": {\n \"giftCardPaymentId\": \"ff3c2b57-2dc4-47de-a261-9ae00251a60b\",\n \"giftCardId\": \"\",\n \"appId\": \"d80111c5-a0f4-47a8-b63a-65b54d774a27\",\n \"voided\": false\n },\n \"createdDate\": \"2023-09-01T20:20:26.451Z\",\n \"updatedDate\": \"2023-09-01T20:20:26.451Z\",\n \"amount\": {\n \"amount\": \"25.0\",\n \"formattedAmount\": \"C$25.00\"\n },\n \"refundDisabled\": false\n },\n {\n \"id\": \"62fdfea7-896d-438d-9b88-4d7c1a4674ac\",\n \"regularPaymentDetails\": {\n \"gatewayTransactionId\": \"42a6c722-b27d-49fc-9a18-827115c4bd66\",\n \"paymentMethod\": \"Stripe\",\n \"providerTransactionId\": \"pi_3NmFQZINImlhPEm01iyAurzL\",\n \"offlinePayment\": false,\n \"status\": \"REFUNDED\"\n },\n \"createdDate\": \"2023-09-01T20:21:26.451Z\",\n \"updatedDate\": \"2023-09-03T12:30:12.853Z\",\n \"amount\": {\n \"amount\": \"17.99\",\n \"formattedAmount\": \"C$17,99\"\n },\n \"refundDisabled\": false\n }\n ],\n \"refunds\": [\n {\n \"id\": \"3cfa83af-94fe-4e02-a7c7-3a969557f697\",\n \"transactions\": [\n {\n \"paymentId\": \"62fdfea7-896d-438d-9b88-4d7c1a4674ac\",\n \"amount\": {\n \"amount\": \"17.99\",\n \"formattedAmount\": \"C$17,99\"\n },\n \"refundStatus\": \"SUCCEEDED\",\n \"gatewayRefundId\": \"9656f197-74de-4d9a-bac2-85155614ef5e\",\n \"providerRefundId\": \"re_3NmFQZINImlhPEm011HglMxH\",\n \"externalRefund\": false\n }\n ],\n \"details\": {\n \"items\": [\n {\n \"lineItemId\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"shippingIncluded\": true\n },\n \"createdDate\": \"2023-09-03T12:30:12.853Z\"\n }\n ]\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"List Transactions For Single Order","slugifiedName":"list-transactions-for-single-order"}},{"summary":"List Transactions For Multiple Orders","description":"Retrieves information about payments and refunds associated with all specified orders.","operationId":"com.wix.ecom.orders.payments.v1.Payments.ListTransactionsForMultipleOrders","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.ListTransactionsForMultipleOrdersResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/payments","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/payments","destinationPath":"/v1/payments","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ListTransactionsForMultipleOrdersRequest","description":"","properties":{"orderIds":{"description":"Order IDs for which to retrieve transactions.","minItems":1,"maxItems":100,"minLength":1,"maxLength":100,"title":"orderIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["orderIds"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.ecom.orders.payments.v1.Payments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.READ_TRANSACTIONS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read eCommerce - all read permissions","scopeId":"SCOPE.DC-ECOM-MEGA.READ-ECOM"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-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:wix-ecom-orders-payments-api","serviceArtifactId":"com.wixpress.ecom.ep-payments-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.payments.v1.ListTransactionsForMultipleOrdersRequest","responseMessage":"com.wix.ecom.orders.payments.v1.ListTransactionsForMultipleOrdersResponse"},"legacyExamples":[{"name":"ListTransactionsForMultipleOrders","type":"METHOD","content":{"title":"List Transactions For Multiple Orders","description":"Retrieves transactions of the 2 requested order IDs","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/payments/list-by-ids' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"orderIds\": [\n \"4bab5870-7943-4a9e-8d4e-96719b3e4f38\",\n \"6ae38b2e-455b-4e20-b418-01fca82edaa8\"\n ]\n }'","response":"{\n \"orderTransactions\": [\n {\n \"orderId\": \"4bab5870-7943-4a9e-8d4e-96719b3e4f38\",\n \"payments\": [\n {\n \"id\": \"62fdfea7-896d-438d-9b88-4d7c1a4674ac\",\n \"regularPaymentDetails\": {\n \"gatewayTransactionId\": \"42a6c722-b27d-49fc-9a18-827115c4bd66\",\n \"paymentMethod\": \"Stripe\",\n \"providerTransactionId\": \"pi_3NmFQZINImlhPEm01iyAurzL\",\n \"offlinePayment\": false,\n \"status\": \"REFUNDED\"\n },\n \"createdDate\": \"2023-09-03T12:29:21.284Z\",\n \"updatedDate\": \"2023-09-03T12:30:12.853Z\",\n \"amount\": {\n \"amount\": \"17.99\",\n \"formattedAmount\": \"17,99 €\"\n },\n \"refundDisabled\": false\n }\n ],\n \"refunds\": [\n {\n \"id\": \"3cfa83af-94fe-4e02-a7c7-3a969557f697\",\n \"transactions\": [\n {\n \"paymentId\": \"62fdfea7-896d-438d-9b88-4d7c1a4674ac\",\n \"amount\": {\n \"amount\": \"17.99\",\n \"formattedAmount\": \"17,99 €\"\n },\n \"refundStatus\": \"SUCCEEDED\",\n \"gatewayRefundId\": \"9656f197-74de-4d9a-bac2-85155614ef5e\",\n \"providerRefundId\": \"re_3NmFQZINImlhPEm011HglMxH\",\n \"externalRefund\": false\n }\n ],\n \"details\": {\n \"items\": [\n {\n \"lineItemId\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"shippingIncluded\": true\n },\n \"createdDate\": \"2023-09-03T12:30:12.853Z\"\n }\n ]\n },\n {\n \"orderId\": \"6ae38b2e-455b-4e20-b418-01fca82edaa8\",\n \"payments\": [\n {\n \"id\": \"e2f17179-db73-46ef-8d8a-06de7158e43b\",\n \"regularPaymentDetails\": {\n \"gatewayTransactionId\": \"6bba8866-a3af-4404-9522-61be070e4715\",\n \"paymentMethod\": \"Stripe\",\n \"providerTransactionId\": \"pi_3NiMZkLpihTBGDpG0DewjotR\",\n \"offlinePayment\": false,\n \"status\": \"APPROVED\"\n },\n \"createdDate\": \"2023-08-23T19:18:46.135Z\",\n \"updatedDate\": \"2023-08-23T19:18:46.135Z\",\n \"amount\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": \"0,50 €\"\n },\n \"refundDisabled\": false\n }\n ],\n \"refunds\": []\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/payments/list-by-ids","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.ecom.orders.payments.v1.Payments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.READ_TRANSACTIONS"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read eCommerce - all read permissions","scopeId":"SCOPE.DC-ECOM-MEGA.READ-ECOM"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-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:wix-ecom-orders-payments-api","serviceArtifactId":"com.wixpress.ecom.ep-payments-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.payments.v1.ListTransactionsForMultipleOrdersRequest","responseMessage":"com.wix.ecom.orders.payments.v1.ListTransactionsForMultipleOrdersResponse"},"legacyExamples":[{"name":"ListTransactionsForMultipleOrders","type":"METHOD","content":{"title":"List Transactions For Multiple Orders","description":"Retrieves transactions of the 2 requested order IDs","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/payments/list-by-ids' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"orderIds\": [\n \"4bab5870-7943-4a9e-8d4e-96719b3e4f38\",\n \"6ae38b2e-455b-4e20-b418-01fca82edaa8\"\n ]\n }'","response":"{\n \"orderTransactions\": [\n {\n \"orderId\": \"4bab5870-7943-4a9e-8d4e-96719b3e4f38\",\n \"payments\": [\n {\n \"id\": \"62fdfea7-896d-438d-9b88-4d7c1a4674ac\",\n \"regularPaymentDetails\": {\n \"gatewayTransactionId\": \"42a6c722-b27d-49fc-9a18-827115c4bd66\",\n \"paymentMethod\": \"Stripe\",\n \"providerTransactionId\": \"pi_3NmFQZINImlhPEm01iyAurzL\",\n \"offlinePayment\": false,\n \"status\": \"REFUNDED\"\n },\n \"createdDate\": \"2023-09-03T12:29:21.284Z\",\n \"updatedDate\": \"2023-09-03T12:30:12.853Z\",\n \"amount\": {\n \"amount\": \"17.99\",\n \"formattedAmount\": \"17,99 €\"\n },\n \"refundDisabled\": false\n }\n ],\n \"refunds\": [\n {\n \"id\": \"3cfa83af-94fe-4e02-a7c7-3a969557f697\",\n \"transactions\": [\n {\n \"paymentId\": \"62fdfea7-896d-438d-9b88-4d7c1a4674ac\",\n \"amount\": {\n \"amount\": \"17.99\",\n \"formattedAmount\": \"17,99 €\"\n },\n \"refundStatus\": \"SUCCEEDED\",\n \"gatewayRefundId\": \"9656f197-74de-4d9a-bac2-85155614ef5e\",\n \"providerRefundId\": \"re_3NmFQZINImlhPEm011HglMxH\",\n \"externalRefund\": false\n }\n ],\n \"details\": {\n \"items\": [\n {\n \"lineItemId\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"shippingIncluded\": true\n },\n \"createdDate\": \"2023-09-03T12:30:12.853Z\"\n }\n ]\n },\n {\n \"orderId\": \"6ae38b2e-455b-4e20-b418-01fca82edaa8\",\n \"payments\": [\n {\n \"id\": \"e2f17179-db73-46ef-8d8a-06de7158e43b\",\n \"regularPaymentDetails\": {\n \"gatewayTransactionId\": \"6bba8866-a3af-4404-9522-61be070e4715\",\n \"paymentMethod\": \"Stripe\",\n \"providerTransactionId\": \"pi_3NiMZkLpihTBGDpG0DewjotR\",\n \"offlinePayment\": false,\n \"status\": \"APPROVED\"\n },\n \"createdDate\": \"2023-08-23T19:18:46.135Z\",\n \"updatedDate\": \"2023-08-23T19:18:46.135Z\",\n \"amount\": {\n \"amount\": \"0.5\",\n \"formattedAmount\": \"0,50 €\"\n },\n \"refundDisabled\": false\n }\n ],\n \"refunds\": []\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"List Transactions For Multiple Orders","slugifiedName":"list-transactions-for-multiple-orders"}},{"summary":"Add Payments","description":"Adds up to 50 payment records to an order.\n\n> **Note:** This does **NOT** perform the actual charging - the order is only updated with records of the payments.","operationId":"com.wix.ecom.orders.payments.v1.Payments.AddPayments","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"orderId","description":"Order ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.AddPaymentsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/payments","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/payments","destinationPath":"/v1/payments","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"AddPaymentsRequest","description":"","properties":{"payments":{"description":"Payments to be added to order.","minItems":1,"maxItems":50,"title":"payments","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.Payment"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["orderId","payments","payments.amount","payments.paymentDetails","payments.paymentDetails.giftcardPaymentDetails.giftCardPaymentId","payments.paymentDetails.membershipPaymentDetails.membershipId","payments.paymentDetails.membershipPaymentDetails.lineItemId","payments.paymentDetails.membershipPaymentDetails.name","payments.paymentDetails.membershipPaymentDetails.name.original","payments.paymentDetails.membershipPaymentDetails.providerAppId"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Order Transactions Updated","description":"Triggered when a payment or refund is added to an order, or when an existing payment is updated.\n\nThe response contains the ID of the updated order and details of its associated transactions,\nas well as IDs of the updated payments and refunds.","permissions":["ECOM.READ_TRANSACTIONS"],"payload":{"schemaName":"com.wix.ecom.orders.payments.v1.PaymentsUpdated"},"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.order_transactions","serviceName":"com.wix.ecom.orders.payments.v1.Payments","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.ecom.v1.order_transactions_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.payments.v1.Payments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.MODIFY_TRANSACTIONS"],"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:wix-ecom-orders-payments-api","serviceArtifactId":"com.wixpress.ecom.ep-payments-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.payments.v1.AddPaymentsRequest","responseMessage":"com.wix.ecom.orders.payments.v1.AddPaymentsResponse"},"legacyExamples":[{"name":"AddPayments","type":"METHOD","content":{"title":"Add Payments","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/payments/orders/6b51aac3-075c-4b4e-9e92-10c3730130ae/add-payment' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"payments\": [\n {\n \"amount\": {\n \"amount\": \"19.0\"\n },\n \"refundDisabled\": false,\n \"regularPaymentDetails\": {\n \"paymentOrderId\": \"356e3ba8-6ee9-4f30-9ce4-cf726e4fe6f2\",\n \"gatewayTransactionId\": \"93eb1f1e-4c1b-4392-979c-a59d1ccf5912\",\n \"paymentMethod\": \"Stripe\",\n \"providerTransactionId\": \"pi_3Nma8hD7mauJ7ZJt0bKKZkRT\",\n \"offlinePayment\": false,\n \"status\": \"PENDING\"\n }\n },\n {\n \"amount\": {\n \"amount\": \"20.0\"\n },\n \"refundDisabled\": true,\n \"giftcardPaymentDetails\": {\n \"giftCardPaymentId\": \"e38b2b8b-f416-49b2-bbf0-869712fb9a78\",\n \"appId\": \"d80111c5-a0f4-47a8-b63a-65b54d774a27\"\n }\n }\n ]\n }'","response":"{\n \"orderTransactions\": {\n \"orderId\": \"6b51aac3-075c-4b4e-9e92-10c3730130ae\",\n \"payments\": [\n {\n \"id\": \"490fa480-414e-443a-befe-13cbb2772a2f\",\n \"regularPaymentDetails\": {\n \"paymentOrderId\": \"356e3ba8-6ee9-4f30-9ce4-cf726e4fe6f2\",\n \"gatewayTransactionId\": \"93eb1f1e-4c1b-4392-979c-a59d1ccf5912\",\n \"paymentMethod\": \"Stripe\",\n \"providerTransactionId\": \"pi_3Nma8hD7mauJ7ZJt0bKKZkRT\",\n \"offlinePayment\": false,\n \"status\": \"PENDING\"\n },\n \"createdDate\": \"2023-11-21T09:31:07.806Z\",\n \"updatedDate\": \"2023-11-21T09:31:07.806Z\",\n \"amount\": {\n \"amount\": \"19.0\",\n \"formattedAmount\": \"$19.00\"\n },\n \"refundDisabled\": false\n },\n {\n \"id\": \"dc67d010-529a-4cea-b78d-8283f3bd3f7b\",\n \"giftcardPaymentDetails\": {\n \"giftCardPaymentId\": \"e38b2b8b-f416-49b2-bbf0-869712fb9a78\",\n \"giftCardId\": \"\",\n \"appId\": \"d80111c5-a0f4-47a8-b63a-65b54d774a27\",\n \"voided\": false\n },\n \"createdDate\": \"2023-11-21T09:31:07.806Z\",\n \"updatedDate\": \"2023-11-21T09:31:07.806Z\",\n \"amount\": {\n \"amount\": \"20.0\",\n \"formattedAmount\": \"$20.00\"\n },\n \"refundDisabled\": true\n }\n ],\n \"refunds\": []\n },\n \"paymentsIds\": [\n \"490fa480-414e-443a-befe-13cbb2772a2f\",\n \"dc67d010-529a-4cea-b78d-8283f3bd3f7b\"\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/payments/orders/{orderId}/add-payment","rpcOnly":false,"triggeredEvents":[{"title":"Order Transactions Updated","description":"Triggered when a payment or refund is added to an order, or when an existing payment is updated.\n\nThe response contains the ID of the updated order and details of its associated transactions,\nas well as IDs of the updated payments and refunds.","permissions":["ECOM.READ_TRANSACTIONS"],"payload":{"schemaName":"com.wix.ecom.orders.payments.v1.PaymentsUpdated"},"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.order_transactions","serviceName":"com.wix.ecom.orders.payments.v1.Payments","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.ecom.v1.order_transactions_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.payments.v1.Payments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.MODIFY_TRANSACTIONS"],"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:wix-ecom-orders-payments-api","serviceArtifactId":"com.wixpress.ecom.ep-payments-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.payments.v1.AddPaymentsRequest","responseMessage":"com.wix.ecom.orders.payments.v1.AddPaymentsResponse"},"legacyExamples":[{"name":"AddPayments","type":"METHOD","content":{"title":"Add Payments","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/payments/orders/6b51aac3-075c-4b4e-9e92-10c3730130ae/add-payment' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"payments\": [\n {\n \"amount\": {\n \"amount\": \"19.0\"\n },\n \"refundDisabled\": false,\n \"regularPaymentDetails\": {\n \"paymentOrderId\": \"356e3ba8-6ee9-4f30-9ce4-cf726e4fe6f2\",\n \"gatewayTransactionId\": \"93eb1f1e-4c1b-4392-979c-a59d1ccf5912\",\n \"paymentMethod\": \"Stripe\",\n \"providerTransactionId\": \"pi_3Nma8hD7mauJ7ZJt0bKKZkRT\",\n \"offlinePayment\": false,\n \"status\": \"PENDING\"\n }\n },\n {\n \"amount\": {\n \"amount\": \"20.0\"\n },\n \"refundDisabled\": true,\n \"giftcardPaymentDetails\": {\n \"giftCardPaymentId\": \"e38b2b8b-f416-49b2-bbf0-869712fb9a78\",\n \"appId\": \"d80111c5-a0f4-47a8-b63a-65b54d774a27\"\n }\n }\n ]\n }'","response":"{\n \"orderTransactions\": {\n \"orderId\": \"6b51aac3-075c-4b4e-9e92-10c3730130ae\",\n \"payments\": [\n {\n \"id\": \"490fa480-414e-443a-befe-13cbb2772a2f\",\n \"regularPaymentDetails\": {\n \"paymentOrderId\": \"356e3ba8-6ee9-4f30-9ce4-cf726e4fe6f2\",\n \"gatewayTransactionId\": \"93eb1f1e-4c1b-4392-979c-a59d1ccf5912\",\n \"paymentMethod\": \"Stripe\",\n \"providerTransactionId\": \"pi_3Nma8hD7mauJ7ZJt0bKKZkRT\",\n \"offlinePayment\": false,\n \"status\": \"PENDING\"\n },\n \"createdDate\": \"2023-11-21T09:31:07.806Z\",\n \"updatedDate\": \"2023-11-21T09:31:07.806Z\",\n \"amount\": {\n \"amount\": \"19.0\",\n \"formattedAmount\": \"$19.00\"\n },\n \"refundDisabled\": false\n },\n {\n \"id\": \"dc67d010-529a-4cea-b78d-8283f3bd3f7b\",\n \"giftcardPaymentDetails\": {\n \"giftCardPaymentId\": \"e38b2b8b-f416-49b2-bbf0-869712fb9a78\",\n \"giftCardId\": \"\",\n \"appId\": \"d80111c5-a0f4-47a8-b63a-65b54d774a27\",\n \"voided\": false\n },\n \"createdDate\": \"2023-11-21T09:31:07.806Z\",\n \"updatedDate\": \"2023-11-21T09:31:07.806Z\",\n \"amount\": {\n \"amount\": \"20.0\",\n \"formattedAmount\": \"$20.00\"\n },\n \"refundDisabled\": true\n }\n ],\n \"refunds\": []\n },\n \"paymentsIds\": [\n \"490fa480-414e-443a-befe-13cbb2772a2f\",\n \"dc67d010-529a-4cea-b78d-8283f3bd3f7b\"\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Add Payments","slugifiedName":"add-payments"}},{"summary":"Update Payment Status","description":"Updates the status of an order's payment.","operationId":"com.wix.ecom.orders.payments.v1.Payments.UpdatePaymentStatus","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"orderId","description":"Order ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"in":"path","schema":{"type":"string"},"required":true,"name":"paymentId","description":"Payment ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.UpdatePaymentStatusResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/payments","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/payments","destinationPath":"/v1/payments","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdatePaymentStatusRequest","description":"","properties":{"status":{"description":"Payment status.","title":"status","type":"string","$ref":"#/components/schemas/wix.payment.api.pay.v3.Transaction.TransactionStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["orderId","paymentId"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Order Transactions Updated","description":"Triggered when a payment or refund is added to an order, or when an existing payment is updated.\n\nThe response contains the ID of the updated order and details of its associated transactions,\nas well as IDs of the updated payments and refunds.","permissions":["ECOM.READ_TRANSACTIONS"],"payload":{"schemaName":"com.wix.ecom.orders.payments.v1.PaymentsUpdated"},"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.order_transactions","serviceName":"com.wix.ecom.orders.payments.v1.Payments","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.ecom.v1.order_transactions_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.payments.v1.Payments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.MODIFY_TRANSACTIONS"],"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:wix-ecom-orders-payments-api","serviceArtifactId":"com.wixpress.ecom.ep-payments-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.payments.v1.UpdatePaymentStatusRequest","responseMessage":"com.wix.ecom.orders.payments.v1.UpdatePaymentStatusResponse"},"legacyExamples":[{"name":"UpdatePaymentStatus","type":"METHOD","order":1,"content":{"title":"Update Payment Status to APPROVED","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/payments/6ac204b6-d1df-44c7-ae84-aa08197380d8/orders/c7689f97-304f-425e-bbda-2451a32596c9/update-payment-transaction-status' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \t\"status\": \"APPROVED\"\n }'","response":"{\n \"orderTransactions\": {\n \"orderId\": \"c7689f97-304f-425e-bbda-2451a32596c9\",\n \"payments\": [\n {\n \"id\": \"6ac204b6-d1df-44c7-ae84-aa08197380d8\",\n \"regularPaymentDetails\": {\n \"paymentOrderId\": null,\n \"gatewayTransactionId\": \"47303d3c-5a0f-4e6f-87f4-891d89cd8203\",\n \"paymentMethod\": \"WixPayments\",\n \"providerTransactionId\": \"47303d3c-5a0f-4e6f-87f4-891d89cd8203\",\n \"offlinePayment\": false,\n \"status\": \"APPROVED\"\n },\n \"createdDate\": \"2023-11-17T15:00:27.293Z\",\n \"updatedDate\": \"2023-11-17T15:02:10.890Z\",\n \"amount\": {\n \"amount\": \"99.0\",\n \"formattedAmount\": \"$99.00\"\n },\n \"refundDisabled\": false\n }\n ],\n \"refunds\": []\n }\n}"}},{"name":"UpdatePaymentStatus","type":"METHOD","order":2,"content":{"title":"Update Payment Status to VOIDED","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/payments/da08a874-c8d8-4041-ad85-48fbd5284a7a/orders/b4247531-bb4e-44b2-b935-8e4dfabd91a0/update-payment-transaction-status' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \t\"status\": \"VOIDED\"\n }'","response":"{\n \"orderTransactions\": {\n \"orderId\": \"b4247531-bb4e-44b2-b935-8e4dfabd91a0\",\n \"payments\": [\n {\n \"id\": \"da08a874-c8d8-4041-ad85-48fbd5284a7a\",\n \"regularPaymentDetails\": {\n \"gatewayTransactionId\": \"64dfce61-cdad-4f79-be53-5e0c78118fe3\",\n \"paymentMethod\": \"In Person\",\n \"providerTransactionId\": \"\",\n \"offlinePayment\": true,\n \"status\": \"VOIDED\"\n },\n \"createdDate\": \"2023-11-21T09:18:26.627Z\",\n \"updatedDate\": \"2023-11-21T09:19:00.089Z\",\n \"amount\": {\n \"amount\": \"99.0\",\n \"formattedAmount\": \"$99.00\"\n },\n \"refundDisabled\": false\n }\n ],\n \"refunds\": []\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/payments/{paymentId}/orders/{orderId}/update-payment-transaction-status","rpcOnly":false,"triggeredEvents":[{"title":"Order Transactions Updated","description":"Triggered when a payment or refund is added to an order, or when an existing payment is updated.\n\nThe response contains the ID of the updated order and details of its associated transactions,\nas well as IDs of the updated payments and refunds.","permissions":["ECOM.READ_TRANSACTIONS"],"payload":{"schemaName":"com.wix.ecom.orders.payments.v1.PaymentsUpdated"},"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.order_transactions","serviceName":"com.wix.ecom.orders.payments.v1.Payments","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.ecom.v1.order_transactions_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.payments.v1.Payments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.MODIFY_TRANSACTIONS"],"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:wix-ecom-orders-payments-api","serviceArtifactId":"com.wixpress.ecom.ep-payments-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.payments.v1.UpdatePaymentStatusRequest","responseMessage":"com.wix.ecom.orders.payments.v1.UpdatePaymentStatusResponse"},"legacyExamples":[{"name":"UpdatePaymentStatus","type":"METHOD","order":1,"content":{"title":"Update Payment Status to APPROVED","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/payments/6ac204b6-d1df-44c7-ae84-aa08197380d8/orders/c7689f97-304f-425e-bbda-2451a32596c9/update-payment-transaction-status' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \t\"status\": \"APPROVED\"\n }'","response":"{\n \"orderTransactions\": {\n \"orderId\": \"c7689f97-304f-425e-bbda-2451a32596c9\",\n \"payments\": [\n {\n \"id\": \"6ac204b6-d1df-44c7-ae84-aa08197380d8\",\n \"regularPaymentDetails\": {\n \"paymentOrderId\": null,\n \"gatewayTransactionId\": \"47303d3c-5a0f-4e6f-87f4-891d89cd8203\",\n \"paymentMethod\": \"WixPayments\",\n \"providerTransactionId\": \"47303d3c-5a0f-4e6f-87f4-891d89cd8203\",\n \"offlinePayment\": false,\n \"status\": \"APPROVED\"\n },\n \"createdDate\": \"2023-11-17T15:00:27.293Z\",\n \"updatedDate\": \"2023-11-17T15:02:10.890Z\",\n \"amount\": {\n \"amount\": \"99.0\",\n \"formattedAmount\": \"$99.00\"\n },\n \"refundDisabled\": false\n }\n ],\n \"refunds\": []\n }\n}"}},{"name":"UpdatePaymentStatus","type":"METHOD","order":2,"content":{"title":"Update Payment Status to VOIDED","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/payments/da08a874-c8d8-4041-ad85-48fbd5284a7a/orders/b4247531-bb4e-44b2-b935-8e4dfabd91a0/update-payment-transaction-status' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \t\"status\": \"VOIDED\"\n }'","response":"{\n \"orderTransactions\": {\n \"orderId\": \"b4247531-bb4e-44b2-b935-8e4dfabd91a0\",\n \"payments\": [\n {\n \"id\": \"da08a874-c8d8-4041-ad85-48fbd5284a7a\",\n \"regularPaymentDetails\": {\n \"gatewayTransactionId\": \"64dfce61-cdad-4f79-be53-5e0c78118fe3\",\n \"paymentMethod\": \"In Person\",\n \"providerTransactionId\": \"\",\n \"offlinePayment\": true,\n \"status\": \"VOIDED\"\n },\n \"createdDate\": \"2023-11-21T09:18:26.627Z\",\n \"updatedDate\": \"2023-11-21T09:19:00.089Z\",\n \"amount\": {\n \"amount\": \"99.0\",\n \"formattedAmount\": \"$99.00\"\n },\n \"refundDisabled\": false\n }\n ],\n \"refunds\": []\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update Payment Status","slugifiedName":"update-payment-status"}},{"summary":"Bulk Update Payment Statuses","description":"Updates multiple order payments with a specified status.","operationId":"com.wix.ecom.orders.payments.v1.Payments.BulkUpdatePaymentStatuses","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.BulkUpdatePaymentStatusesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/bulk/payments","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/bulk/payments","destinationPath":"/v1/bulk/payments","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkUpdatePaymentStatusesRequest","description":"","properties":{"paymentAndOrderIds":{"description":"Order and payment IDs for which to update payment status.","minItems":1,"maxItems":300,"title":"paymentAndOrderIds","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.PaymentAndOrderId"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnFullEntity":{"description":"Whether to return the full payment entity (`results.item`) in the response.","title":"returnFullEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Payment status.","title":"status","type":"string","$ref":"#/components/schemas/wix.payment.api.pay.v3.Transaction.TransactionStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["paymentAndOrderIds"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Order Transactions Updated","description":"Triggered when a payment or refund is added to an order, or when an existing payment is updated.\n\nThe response contains the ID of the updated order and details of its associated transactions,\nas well as IDs of the updated payments and refunds.","permissions":["ECOM.READ_TRANSACTIONS"],"payload":{"schemaName":"com.wix.ecom.orders.payments.v1.PaymentsUpdated"},"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.order_transactions","serviceName":"com.wix.ecom.orders.payments.v1.Payments","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.ecom.v1.order_transactions_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.payments.v1.Payments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.MODIFY_TRANSACTIONS"],"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:wix-ecom-orders-payments-api","serviceArtifactId":"com.wixpress.ecom.ep-payments-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.payments.v1.BulkUpdatePaymentStatusesRequest","responseMessage":"com.wix.ecom.orders.payments.v1.BulkUpdatePaymentStatusesResponse"},"legacyExamples":[{"name":"BulkUpdatePaymentStatuses","type":"METHOD","order":2,"content":{"title":"Bulk Update Payment Statuses","description":"Update the statuses of multiple orders to APPROVED. Request full entity in response.","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/bulk/payments/update-payment-transaction-status' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"paymentAndOrderIds\": [\n {\n \"orderId\": \"69c598e5-987f-4429-9b61-76aaf47efedc\",\n \"paymentId\": \"770f8669-6ae7-47ed-a3fc-815ada5d86f9\"\n },\n\t\t\t{\n \"orderId\": \"4f0cc39e-bb17-44be-bdbd-8331a5138987\",\n \"paymentId\": \"00000000-0000-0000-0000-000000000000\"\n\t\t\t}\n ],\n \"status\": \"APPROVED\",\n \"returnFullEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"originalIndex\": 1,\n \"success\": false,\n \"error\": {\n \"code\": \"PAYMENT_NOT_FOUND\",\n \"description\": \"Payment is not found\"\n }\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"770f8669-6ae7-47ed-a3fc-815ada5d86f9\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"770f8669-6ae7-47ed-a3fc-815ada5d86f9\",\n \"regularPaymentDetails\": {\n \"gatewayTransactionId\": \"6a82ab27-feb1-44ea-98e3-217f1b9c8e89\",\n \"paymentMethod\": \"In Person\",\n \"providerTransactionId\": \"\",\n \"offlinePayment\": true,\n \"status\": \"APPROVED\"\n },\n \"createdDate\": \"2023-11-14T12:45:56.345Z\",\n \"updatedDate\": \"2023-11-20T09:46:48.081Z\",\n \"amount\": {\n \"amount\": \"330.0\",\n \"formattedAmount\": \"$330.00\"\n },\n \"refundDisabled\": false\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 1,\n \"undetailedFailures\": 0\n }\n}"}},{"name":"BulkUpdatePaymentStatuses","type":"METHOD","order":1,"content":{"title":"Bulk Update Payment Statuses from multiple orders to CANCELED","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/bulk/payments/update-payment-transaction-status' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"paymentAndOrderIds\": [\n {\n \"orderId\": \"69c598e5-987f-4429-9b61-76aaf47efedc\",\n \"paymentId\": \"770f8669-6ae7-47ed-a3fc-815ada5d86f9\"\n },\n {\n \"orderId\": \"4f0cc39e-bb17-44be-bdbd-8331a5138987\",\n \"paymentId\": \"21cc0ff7-7ff5-4931-9ef8-1ee3d84a2215\"\n }\n ],\n \"status\": \"CANCELED\",\n \"returnFullEntity\": false\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"770f8669-6ae7-47ed-a3fc-815ada5d86f9\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"21cc0ff7-7ff5-4931-9ef8-1ee3d84a2215\",\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/bulk/payments/update-payment-transaction-status","rpcOnly":false,"triggeredEvents":[{"title":"Order Transactions Updated","description":"Triggered when a payment or refund is added to an order, or when an existing payment is updated.\n\nThe response contains the ID of the updated order and details of its associated transactions,\nas well as IDs of the updated payments and refunds.","permissions":["ECOM.READ_TRANSACTIONS"],"payload":{"schemaName":"com.wix.ecom.orders.payments.v1.PaymentsUpdated"},"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.order_transactions","serviceName":"com.wix.ecom.orders.payments.v1.Payments","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.ecom.v1.order_transactions_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.payments.v1.Payments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.MODIFY_TRANSACTIONS"],"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:wix-ecom-orders-payments-api","serviceArtifactId":"com.wixpress.ecom.ep-payments-proxy","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.payments.v1.BulkUpdatePaymentStatusesRequest","responseMessage":"com.wix.ecom.orders.payments.v1.BulkUpdatePaymentStatusesResponse"},"legacyExamples":[{"name":"BulkUpdatePaymentStatuses","type":"METHOD","order":2,"content":{"title":"Bulk Update Payment Statuses","description":"Update the statuses of multiple orders to APPROVED. Request full entity in response.","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/bulk/payments/update-payment-transaction-status' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"paymentAndOrderIds\": [\n {\n \"orderId\": \"69c598e5-987f-4429-9b61-76aaf47efedc\",\n \"paymentId\": \"770f8669-6ae7-47ed-a3fc-815ada5d86f9\"\n },\n\t\t\t{\n \"orderId\": \"4f0cc39e-bb17-44be-bdbd-8331a5138987\",\n \"paymentId\": \"00000000-0000-0000-0000-000000000000\"\n\t\t\t}\n ],\n \"status\": \"APPROVED\",\n \"returnFullEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"originalIndex\": 1,\n \"success\": false,\n \"error\": {\n \"code\": \"PAYMENT_NOT_FOUND\",\n \"description\": \"Payment is not found\"\n }\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"770f8669-6ae7-47ed-a3fc-815ada5d86f9\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"770f8669-6ae7-47ed-a3fc-815ada5d86f9\",\n \"regularPaymentDetails\": {\n \"gatewayTransactionId\": \"6a82ab27-feb1-44ea-98e3-217f1b9c8e89\",\n \"paymentMethod\": \"In Person\",\n \"providerTransactionId\": \"\",\n \"offlinePayment\": true,\n \"status\": \"APPROVED\"\n },\n \"createdDate\": \"2023-11-14T12:45:56.345Z\",\n \"updatedDate\": \"2023-11-20T09:46:48.081Z\",\n \"amount\": {\n \"amount\": \"330.0\",\n \"formattedAmount\": \"$330.00\"\n },\n \"refundDisabled\": false\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 1,\n \"undetailedFailures\": 0\n }\n}"}},{"name":"BulkUpdatePaymentStatuses","type":"METHOD","order":1,"content":{"title":"Bulk Update Payment Statuses from multiple orders to CANCELED","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/bulk/payments/update-payment-transaction-status' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"paymentAndOrderIds\": [\n {\n \"orderId\": \"69c598e5-987f-4429-9b61-76aaf47efedc\",\n \"paymentId\": \"770f8669-6ae7-47ed-a3fc-815ada5d86f9\"\n },\n {\n \"orderId\": \"4f0cc39e-bb17-44be-bdbd-8331a5138987\",\n \"paymentId\": \"21cc0ff7-7ff5-4931-9ef8-1ee3d84a2215\"\n }\n ],\n \"status\": \"CANCELED\",\n \"returnFullEntity\": false\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"770f8669-6ae7-47ed-a3fc-815ada5d86f9\",\n \"originalIndex\": 0,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"21cc0ff7-7ff5-4931-9ef8-1ee3d84a2215\",\n \"originalIndex\": 1,\n \"success\": true\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Update Payment Statuses","slugifiedName":"bulk-update-payment-statuses"}}],"webhooks":[{"summary":"Order Transactions Updated","title":"Order Transactions Updated","description":"Triggered when a payment or refund is added to an order, or when an existing payment is updated.\n\nThe response contains the ID of the updated order and details of its associated transactions,\nas well as IDs of the updated payments and refunds.","permissions":["ECOM.READ_TRANSACTIONS"],"payload":{"schemaName":"com.wix.ecom.orders.payments.v1.PaymentsUpdated"},"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.order_transactions","serviceName":"com.wix.ecom.orders.payments.v1.Payments","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read eCommerce - all read permissions","scopeId":"SCOPE.DC-ECOM-MEGA.READ-ECOM"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"wix.ecom.v1.order_transactions_updated","legacyExamples":[{"name":"OrderTransactionsUpdated","eventType":"ACTION","type":"DOMAIN_EVENT","content":"{\n \"id\": \"e883330e-6985-4b2c-b570-98260ffcf972\",\n \"entityFqdn\": \"wix.ecom.v1.order_transactions\",\n \"slug\": \"updated\",\n \"entityId\": \"c759ec55-52e8-45a9-a04a-71670340641d\",\n \"actionEvent\": {\n \"body\": {\n \"orderTransactions\": {\n \"orderId\": \"c759ec55-52e8-45a9-a04a-71670340641d\",\n \"payments\": [\n {\n \"id\": \"1baf0a11-0c05-4bd2-b6b2-56be85c910b1\",\n \"regularPaymentDetails\": {\n \"gatewayTransactionId\": \"e752e841-1f6a-464c-8087-06d290ef250f\",\n \"paymentMethod\": \"WixPayments\",\n \"providerTransactionId\": \"e752e841-1f6a-464c-8087-06d290ef250f\",\n \"offlinePayment\": false,\n \"status\": \"REFUNDED\"\n },\n \"createdDate\": \"2024-01-04T14:46:18.513Z\",\n \"updatedDate\": \"2024-01-04T14:46:38.360Z\",\n \"amount\": {\n \"amount\": \"84.0\",\n \"formattedAmount\": \"$84.00\"\n },\n \"refundDisabled\": false\n }\n ],\n \"refunds\": [\n {\n \"id\": \"961e217b-eede-4ecb-891b-8776da816074\",\n \"transactions\": [\n {\n \"paymentId\": \"1baf0a11-0c05-4bd2-b6b2-56be85c910b1\",\n \"amount\": {\n \"amount\": \"84\",\n \"formattedAmount\": \"$84.00\"\n },\n \"refundStatus\": \"SUCCEEDED\",\n \"gatewayRefundId\": \"74c5a247-f8a4-431c-ba6c-ba7234465ea9\",\n \"providerRefundId\": \"6728744f-6ec8-4533-b1dc-9e95ea2fd2c8\",\n \"externalRefund\": false\n }\n ],\n \"details\": {\n \"items\": [ ],\n \"shippingIncluded\": false\n },\n \"createdDate\": \"2024-01-04T14:46:38.360Z\"\n }\n ]\n },\n \"paymentIds\": [\n \"1baf0a11-0c05-4bd2-b6b2-56be85c910b1\"\n ],\n \"refundIds\": [\n \"961e217b-eede-4ecb-891b-8776da816074\"\n ]\n }\n },\n \"eventTime\": \"2024-01-04T14:46:38.377953757Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.PaymentsUpdated","contentLink":{"displayName":"Order Transactions Updated","slugifiedName":"order-transactions-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Order Transactions API\n\nThe eCommerce Order Transactions API concentrates records and details of payments and refunds associated with eCommerce orders.\n\nWith the Order Transactions API you can:\n\n* Retrieve transactions related to a [single](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::12e752bf-af0b-4cf5-ae1e-91e68a073e3dslug::list-transactions-for-single-order*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/list-transactions-for-single-order) or [multiple](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::12e752bf-af0b-4cf5-ae1e-91e68a073e3dslug::list-transactions-for-multiple-orders*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/list-transactions-for-multiple-orders) orders.\n* [Add payment records](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::12e752bf-af0b-4cf5-ae1e-91e68a073e3dslug::add-payments*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/add-payments) to an order.\n* Listen to events when an order's [transactions are updated](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::12e752bf-af0b-4cf5-ae1e-91e68a073e3dslug::order-transactions-updated*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/order-transactions-updated).\n\n## Terminology\n\n* **Transaction**: Global term for a transfer of funds - can be either a:\n * **Payment**: A transfer of funds from customer to merchant/seller when making a purchase.\n * **Refund** A reimbursing transfer of funds back to the buyer.","sourceRepo":"git@github.com:wix-private/ecom.git","path":"appendices/docs/intro.md"},{"displayName":"Example Flows","slugifyName":"example-flows","content":"# Sample Use Case & Flow: Order Transactions\n\nThis article shares a possible use case your app could support, as well as an example flow. You're certainly not limited to this use case, but it can be a helpful jumping off point as you plan your app's implementation.\n\n## Retrieve transactions related eCommerce orders\n\nYour app can retrieve details about payments and refunds associated with an order. For example, you can check for payments that were made by credit-card, payments made by gift card, or orders that were not successfully refunded.\n\nTo retrieve info about an order's transactions:\n\n1. Call [List Transactions For Single Order](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::12e752bf-af0b-4cf5-ae1e-91e68a073e3dslug::list-transactions-for-single-order*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/list-transactions-for-single-order) with an [eCommerce order ID](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).\n * To retrieve transaction details about more than 1 order, call [List Transactions For Multiple Orders](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::12e752bf-af0b-4cf5-ae1e-91e68a073e3dslug::list-transactions-for-multiple-orders*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/list-transactions-for-multiple-orders) with an array of [eCommerce order IDs](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).\n2. You can use the returned info to check payment and refund details in the relevant provider or gateway systems, pass the details on to your accounting or invoice apps, and more.\n\n## Add payment records to imported orders\n\nIf you are importing orders from other systems, you may want to add payment records to those orders. To add a payment record to an order that is already in the eCommerce system:\n\n1. Once you have the order ID, pass it to the [Add Payments](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::12e752bf-af0b-4cf5-ae1e-91e68a073e3dslug::add-payments*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/add-payments) endpoint.\n2. In the body params, pass payment details like the `createdDate`, `amount`, `paymentMethod`, and any other payment details.\n3. When using [Add Payments](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::12e752bf-af0b-4cf5-ae1e-91e68a073e3dslug::add-payments*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/add-payments) you can add up to 50 payment records to a single order with 1 API call.","sourceRepo":"git@github.com:wix-private/ecom.git","path":"appendices/docs/example_flows.md"}],"components":{"schemas":{"com.wix.ecom.orders.payments.v1.OrderTransactions":{"type":"object","properties":{"orderId":{"description":"Order ID.","format":"GUID","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"payments":{"description":"Record of payments made to the merchant.","maxItems":100,"title":"payments","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.Payment"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"refunds":{"description":"Record of refunds made to the buyer.","maxItems":300,"title":"refunds","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.Refund"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"OrderTransactions","description":""},"com.wix.ecom.orders.payments.v1.Payment":{"type":"object","properties":{"id":{"description":"Payment ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.","title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"amount":{"description":"Payment amount.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.Price","summary":"amount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"refundDisabled":{"description":"Whether refunds for this payment are disabled.\n+ `true`: This payment is not refundable.\n+ `false`: This payment may be refunded. However, this ultimately depends on the payment provider.","title":"refundDisabled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Payment","description":"","oneOf":[{"description":"","summary":"paymentDetails","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.Payment.paymentDetails"}]},"com.wix.ecom.orders.payments.v1.Payment.paymentDetails":{"type":"object","title":"paymentDetails","properties":{"regularPaymentDetails":{"description":"Regular payment details.","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.RegularPaymentDetails","summary":"regularPaymentDetails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"giftcardPaymentDetails":{"description":"Gift card payment details.","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.GiftCardPaymentDetails","summary":"giftcardPaymentDetails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"com.wix.ecom.orders.payments.v1.RegularPaymentDetails":{"type":"object","properties":{"paymentOrderId":{"description":"Wix Payments order ID.","maxLength":100,"title":"paymentOrderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"gatewayTransactionId":{"description":"Payment gateway's transaction ID. This ID can be used with the Wix Payments [Transactions API](https://dev.wix.com/docs/rest/api-reference/wix-payments/transactions/introduction).\nThis field is only returned when the value of `offline_payment` is `false`.","maxLength":100,"title":"gatewayTransactionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paymentMethod":{"description":"Payment method. Non-exhaustive list of supported values:\n+ `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`","maxLength":50,"title":"paymentMethod","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"providerTransactionId":{"description":"Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.","maxLength":100,"title":"providerTransactionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offlinePayment":{"description":"Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager.","title":"offlinePayment","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Payment status.","title":"status","type":"string","$ref":"#/components/schemas/wix.payment.api.pay.v3.Transaction.TransactionStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"savedPaymentMethod":{"description":"Whether there is a payment agreement that allows for future charges.","immutable":true,"title":"savedPaymentMethod","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"BETA"}}},"title":"RegularPaymentDetails","description":""},"wix.payment.api.pay.v3.Transaction.TransactionStatus":{"type":"string","description":"","title":"TransactionStatus","enum":["UNDEFINED","APPROVED","PENDING","PENDING_MERCHANT","CANCELED","DECLINED","REFUNDED","PARTIALLY_REFUNDED","AUTHORIZED","VOIDED"]},"com.wix.ecom.orders.payments.v1.GiftCardPaymentDetails":{"type":"object","properties":{"giftCardPaymentId":{"description":"Gift card payment ID.","format":"GUID","title":"giftCardPaymentId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of the app that created the gift card.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"voided":{"description":"Whether the gift card is voided.","readOnly":true,"title":"voided","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GiftCardPaymentDetails","description":""},"com.wix.ecom.orders.payments.v1.MembershipPaymentDetails":{"type":"object","properties":{"membershipId":{"description":"Membership ID.","minLength":1,"maxLength":100,"title":"membershipId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lineItemId":{"description":"ID of the line item this membership applies to.","minLength":1,"maxLength":100,"title":"lineItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Payment status.","title":"status","type":"string","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.MembershipPaymentStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Membership name.","$ref":"#/components/schemas/com.wix.ecom.memberships_spi.v1.MembershipName","summary":"name","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"externalTransactionId":{"description":"The transaction ID in the membership system. Can be used to void the transaction.","minLength":1,"maxLength":100,"title":"externalTransactionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"voided":{"description":"Whether the membership is voided.","readOnly":true,"title":"voided","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"providerAppId":{"description":"ID of the application providing this payment option.","format":"GUID","title":"providerAppId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MembershipPaymentDetails","description":""},"com.wix.ecom.orders.payments.v1.MembershipPaymentStatus":{"type":"string","description":"","title":"MembershipPaymentStatus","enum":["CHARGED","CHARGE_FAILED"]},"com.wix.ecom.memberships_spi.v1.MembershipName":{"type":"object","properties":{"original":{"description":"The name of this membership","maxLength":100,"title":"original","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"translated":{"description":"Optional - Translated name of this membership. Defaults to `original` when not provided.","maxLength":100,"title":"translated","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MembershipName","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"com.wix.ecommerce.platform_common.api.Price":{"type":"object","properties":{"amount":{"description":"Amount.","title":"amount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gte":"0","lte":"1000000000000000"}}},"formattedAmount":{"description":"Amount formatted with currency symbol.","readOnly":true,"title":"formattedAmount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Price","description":""},"com.wix.ecom.orders.payments.v1.Refund":{"type":"object","properties":{"id":{"description":"Refund ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"transactions":{"description":"List of transactions.","minItems":0,"maxItems":50,"title":"transactions","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.RefundTransaction"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"details":{"description":"Refund business details.","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.RefundDetails","summary":"details","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.","title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Refund","description":""},"com.wix.ecom.orders.payments.v1.RefundTransaction":{"type":"object","properties":{"paymentId":{"description":"ID of the payment associated with this refund.","format":"GUID","title":"paymentId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"amount":{"description":"Refund amount.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.Price","summary":"amount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"refundStatus":{"description":"Refund status.","title":"refundStatus","type":"string","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.RefundStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"gatewayRefundId":{"description":"Payment gateway's refund ID. This ID can be used with the Wix Payments [Transactions API](https://dev.wix.com/docs/rest/api-reference/wix-payments/transactions/introduction).\nThis field is only returned when the value of `external_refund` is `false`.","format":"GUID","title":"gatewayRefundId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"providerRefundId":{"description":"ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds.","title":"providerRefundId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"externalRefund":{"description":"Whether refund was made externally and manually on the payment provider's side.","title":"externalRefund","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RefundTransaction","description":""},"com.wix.ecom.orders.payments.v1.RefundStatus":{"type":"string","description":"","title":"RefundStatus","enum":["PENDING","SUCCEEDED","FAILED"]},"com.wix.ecom.orders.payments.v1.RefundDetails":{"type":"object","properties":{"items":{"description":"Order line item IDs and quantities that were refunded.","minItems":0,"maxItems":300,"title":"items","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.RefundItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"shippingIncluded":{"description":"Whether the shipping fee was also refunded.","title":"shippingIncluded","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reason":{"description":"Reason for the refund, provided by customer (optional).","maxLength":200,"title":"reason","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RefundDetails","description":"Business model of a refund request"},"com.wix.ecom.orders.payments.v1.RefundItem":{"type":"object","properties":{"lineItemId":{"description":"Line item ID the refunded line item.","format":"GUID","title":"lineItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"quantity":{"description":"Line item quantity refunded.","minimum":1,"maximum":100000,"title":"quantity","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RefundItem","description":""},"com.wix.ecom.orders.side_effects_migration.api.SnapshotMessage":{"type":"object","properties":{"id":{"description":"","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"opType":{"description":"","title":"opType","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SnapshotMessage","description":""},"com.wix.ecom.orders.side_effects_migration.api.IndexingMessage":{"type":"object","properties":{"id":{"description":"","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"opType":{"description":"","title":"opType","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"requiredVersions":{"description":"","title":"requiredVersions","type":"array","items":{"type":"integer"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IndexingMessage","description":""},"com.wix.diffmatoky.migration.DiffmatokyPayload":{"type":"object","properties":{"left":{"description":"","title":"left","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"right":{"description":"","title":"right","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"compareChannel":{"description":"","title":"compareChannel","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"errorInformation":{"description":"","$ref":"#/components/schemas/com.wix.diffmatoky.migration.ErrorInformation","summary":"errorInformation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tags":{"description":"","title":"tags","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DiffmatokyPayload","description":""},"com.wix.diffmatoky.migration.ErrorInformation":{"type":"object","properties":{"stackTrace":{"description":"","title":"stackTrace","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ErrorInformation","description":""},"wix.orders.api.v2.OrderRefunded":{"type":"object","properties":{"refundId":{"description":"Refund ID.","readOnly":true,"title":"refundId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Refunded order data.","readOnly":true,"$ref":"#/components/schemas/wix.orders.api.v2.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"OrderRefunded","description":""},"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","maturity":"GA"}},"number":{"description":"Order number displayed in the owner's store (auto-generated).","readOnly":true,"title":"number","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateCreated":{"description":"Order creation date and time.","readOnly":true,"title":"dateCreated","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"buyerInfo":{"description":"Buyer information.","$ref":"#/components/schemas/wix.orders.api.v2.BuyerInfo","summary":"buyerInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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","maturity":"GA"}},"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","maturity":"GA"}},"totals":{"description":"Totals for order's line items.","$ref":"#/components/schemas/wix.orders.api.v2.Totals","summary":"totals","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"billingInfo":{"description":"Billing information.","$ref":"#/components/schemas/wix.orders.api.v2.BillingInfo","summary":"billingInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"shippingInfo":{"description":"Shipping information.","$ref":"#/components/schemas/wix.orders.api.v2.ShippingInfo","summary":"shippingInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"buyerNote":{"description":"A note added by the buyer.","maxLength":1000,"title":"buyerNote","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"read":{"description":"Deprecated.","readOnly":true,"title":"read","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"archived":{"description":"Whether or not the order was archived.","readOnly":true,"title":"archived","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paymentStatus":{"description":"Current status of the payment.","title":"paymentStatus","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.PaymentStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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","maturity":"GA"}},"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","maturity":"GA"}},"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","maturity":"GA"}},"invoiceInfo":{"description":"Invoice information.","$ref":"#/components/schemas/wix.orders.api.v2.InvoiceInfo","summary":"invoiceInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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","maturity":"GA"}},"discount":{"description":"Discount information.","$ref":"#/components/schemas/wix.orders.api.v2.Discount","summary":"discount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"customField":{"description":"Custom field information.","$ref":"#/components/schemas/wix.orders.api.v2.CustomField","summary":"customField","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cartId":{"description":"Shopping cart ID.","format":"GUID","title":"cartId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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","maturity":"GA"}},"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","maturity":"GA"}},"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","maturity":"GA"}},"lastUpdated":{"description":"Date and time of latest update.","readOnly":true,"title":"lastUpdated","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"subscriptionInfo":{"description":"Subscription information.","$ref":"#/components/schemas/wix.orders.api.v2.SubscriptionInfo","summary":"subscriptionInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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","maturity":"GA"}},"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","maturity":"GA"}}},"title":"Order","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","maturity":"GA"}},"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","maturity":"GA","deprecated":{}}},"identityType":{"description":"Customer type","title":"identityType","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.IdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"firstName":{"description":"Customer's first name","readOnly":true,"title":"firstName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lastName":{"description":"Customer's last name","readOnly":true,"title":"lastName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"phone":{"description":"Customer's phone number","readOnly":true,"title":"phone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"email":{"description":"Customer's email address","readOnly":true,"title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"shipping":{"description":"Total shipping price, before tax.","format":"DECIMAL_VALUE","title":"shipping","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tax":{"description":"Total tax.","format":"DECIMAL_VALUE","title":"tax","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"discount":{"description":"Total calculated discount value.","format":"DECIMAL_VALUE","title":"discount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total price charged.","format":"DECIMAL_VALUE","title":"total","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"weight":{"description":"Total items weight.","readOnly":true,"title":"weight","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"quantity":{"description":"Total number of line items.","minimum":0,"readOnly":true,"title":"quantity","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"refund":{"description":"Total refund.","format":"DECIMAL_VALUE","readOnly":true,"title":"refund","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"giftCard":{"description":"Total calculated gift card value.","format":"DECIMAL_VALUE","title":"giftCard","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"externalTransactionId":{"description":"Deprecated (use paymentProviderTransactionId instead)","readOnly":true,"title":"externalTransactionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","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","maturity":"GA"}},"paymentGatewayTransactionId":{"description":"Transaction ID from payment gateway (e.g., Wix Payments)","maxLength":100,"title":"paymentGatewayTransactionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"address":{"description":"Full billing address","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.Address","summary":"address","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paidDate":{"description":"Payment date","readOnly":true,"title":"paidDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"refundableByPaymentProvider":{"description":"Whether order can be refunded by payment provider (manually or automatic)","title":"refundableByPaymentProvider","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"country":{"description":"Country code (2 letters)","format":"COUNTRY","title":"country","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"subdivision":{"description":"State or district","maxLength":50,"title":"subdivision","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"city":{"description":"City name","maxLength":150,"title":"city","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"zipCode":{"description":"ZIP/postal code","maxLength":200,"title":"zipCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"phone":{"description":"Phone number","maxLength":200,"title":"phone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"company":{"description":"Company name","maxLength":500,"title":"company","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"email":{"description":"Email address","maxLength":500,"title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"addressLine2":{"description":"address line","maxLength":250,"title":"addressLine2","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"vatId":{"description":"Tax information (for Brazil only)","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.VatId","summary":"vatId","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"street":{"description":"Address line 1 (street)","$ref":"#/components/schemas/com.wix.ecommerce.commons.api.Street","summary":"street","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"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","maturity":"GA"}},"lastName":{"description":"Customer's last name","maxLength":1000,"title":"lastName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"name":{"description":"Street name","maxLength":1000,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"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","maturity":"GA"}}},"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","maturity":"GA"}}},"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","maturity":"GA"}},"estimatedDeliveryTime":{"description":"Shipping option delivery time.","maxLength":500,"title":"estimatedDeliveryTime","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deliverByDate":{"description":"Deprecated - Latest expected delivery date.","title":"deliverByDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"shippingRegion":{"description":"Shipping region.","maxLength":100,"title":"shippingRegion","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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","maturity":"GA"}}},"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","maturity":"GA"}},"pickupDetails":{"description":"Pickup details (when this object describes pickup).","$ref":"#/components/schemas/wix.orders.api.v2.PickupDetails","summary":"pickupDetails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"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","maturity":"GA"}},"trackingInfo":{"description":"Deprecated (use fulfillments instead).","readOnly":true,"$ref":"#/components/schemas/wix.orders.api.v2.TrackingInfo","summary":"trackingInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"discount":{"description":"Discount applied for shipping.","format":"DECIMAL_VALUE","title":"discount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tax":{"description":"Tax applied for shipping.","format":"DECIMAL_VALUE","title":"tax","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"priceData":{"description":"Price data.","$ref":"#/components/schemas/wix.orders.api.v2.ShippingPriceData","summary":"priceData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"shippingProvider":{"description":"Shipping provider","maxLength":100,"readOnly":true,"title":"shippingProvider","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"trackingLink":{"description":"Tracking link","format":"WEB_URL","readOnly":true,"title":"trackingLink","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"price":{"description":"Shipping price.","format":"DECIMAL_VALUE","title":"price","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"buyerDetails":{"description":"Deprecated (use billingInfo instead).","readOnly":true,"$ref":"#/components/schemas/wix.orders.api.v2.BuyerDetails","summary":"buyerDetails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"pickupInstructions":{"description":"Store owner's pickup instructions.","maxLength":1000,"title":"pickupInstructions","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"subdivision":{"description":"State/District","maxLength":50,"title":"subdivision","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"addressLine1":{"description":"Address","maxLength":250,"title":"addressLine1","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"city":{"description":"City","maxLength":100,"title":"city","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"zipCode":{"description":"ZIP/postal code","maxLength":50,"title":"zipCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"email":{"description":"Email address","maxLength":100,"format":"EMAIL","title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"phone":{"description":"Phone number","maxLength":30,"format":"PHONE","title":"phone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"quantity":{"description":"Line item quantity","minimum":1,"maximum":100000,"title":"quantity","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"price":{"description":"Deprecated (use priceData instead)","format":"DECIMAL_VALUE","readOnly":true,"title":"price","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"name":{"description":"Line item name","minLength":1,"maxLength":150,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"translatedName":{"description":"Product name, translated into the customer's language","title":"translatedName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"productId":{"description":"Line item product ID (optional for POS orders)","minLength":1,"title":"productId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalPrice":{"description":"Deprecated (use priceData instead)","format":"DECIMAL_VALUE","readOnly":true,"title":"totalPrice","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","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","maturity":"GA"}},"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","maturity":"GA"}},"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","maturity":"GA"}},"weight":{"description":"Line item weight","format":"DECIMAL_VALUE","title":"weight","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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","maturity":"GA"}},"sku":{"description":"Line item SKU","maxLength":40,"title":"sku","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"notes":{"description":"Line item notes","maxLength":1000,"title":"notes","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"variantId":{"description":"Line item variantId (from Stores Catalog)","title":"variantId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fulfillerId":{"description":"Line item fulfillerId from stores fulfillers. No value equals self fulfilled","format":"GUID","title":"fulfillerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"discount":{"description":"Discount applied for this line item","format":"DECIMAL_VALUE","title":"discount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tax":{"description":"Tax applied for this line item","format":"DECIMAL_VALUE","title":"tax","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"taxIncludedInPrice":{"description":"Deprecated (use priceData instead)","readOnly":true,"title":"taxIncludedInPrice","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"taxGroupId":{"description":"Tax group ID","format":"GUID","title":"taxGroupId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"priceData":{"description":"Price data","$ref":"#/components/schemas/wix.orders.api.v2.LineItemPriceData","summary":"priceData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LineItem","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"selection":{"description":"Selected choice for this option","maxLength":16000,"title":"selection","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"value":{"description":"Custom text field value","maxLength":16000,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"url":{"description":"Media URL","format":"WEB_URL","readOnly":true,"title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Media item width","minimum":0,"readOnly":true,"title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Media item height","minimum":0,"readOnly":true,"title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mediaId":{"description":"Deprecated","title":"mediaId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"id":{"description":"Media ID (for media items previously saved in Wix Media)","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"externalImageUrl":{"description":"Media external URL","title":"externalImageUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"altText":{"description":"Alternative text for presentation when media cannot be displayed","maxLength":256,"title":"altText","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"price":{"description":"Line item price","format":"DECIMAL_VALUE","title":"price","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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","maturity":"GA"}}},"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","maturity":"GA"}}},"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","maturity":"GA"}},"author":{"description":"Activity item author","maxLength":50,"readOnly":true,"title":"author","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"message":{"description":"Comment added to activity item","maxLength":1000,"readOnly":true,"title":"message","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"timestamp":{"description":"Activity item timestamp","readOnly":true,"title":"timestamp","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"source":{"description":"Invoice source","title":"source","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.InvoiceSource","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"dateCreated":{"description":"Fulfillment creation date and time.","readOnly":true,"title":"dateCreated","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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","maturity":"GA"}},"trackingInfo":{"description":"Tracking information.","$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentTrackingInfo","summary":"trackingInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"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","maturity":"GA"}}},"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","maturity":"GA"}},"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","maturity":"GA"}},"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","maturity":"GA"}}},"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","maturity":"GA","deprecated":{}}},"appliedCoupon":{"description":"Applied coupon","$ref":"#/components/schemas/wix.orders.api.v2.AppliedCoupon","summary":"appliedCoupon","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"name":{"description":"Coupon name","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"code":{"description":"Coupon code","maxLength":100,"title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"title":{"description":"Title for the custom field","maxLength":1000,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"translatedTitle":{"description":"The title translated according to the buyer language","maxLength":1000,"title":"translatedTitle","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"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","maturity":"GA"}},"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","maturity":"GA"}}},"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","FACEBOOK","ETSY","TIKTOK","FAIRE_COM"]},"wix.orders.api.v2.EnteredBy":{"type":"object","properties":{"id":{"description":"","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identityType":{"description":"","title":"identityType","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.EnteredBy.EnteredByIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"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","maturity":"GA"}},"subscriptionSettings":{"description":"Subscription settings.","$ref":"#/components/schemas/wix.ecommerce.subscription.option.api.v1.SubscriptionSettings","summary":"subscriptionSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"subscriptionOptionInfo":{"description":"Subscription options info.","$ref":"#/components/schemas/wix.orders.api.v2.SubscriptionOptionInfo","summary":"subscriptionOptionInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"autoRenewal":{"description":"Whether subscription is renewed automatically at the end of each period.","title":"autoRenewal","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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","maturity":"GA"}}},"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","maturity":"GA"}},"description":{"description":"Subscription option description.","maxLength":60,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}},"amount":{"description":"Refund amount.","format":"DECIMAL_VALUE","title":"amount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reason":{"description":"Reason for refund, given by user (optional).","title":"reason","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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","maturity":"GA"}},"id":{"description":"Refund ID.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"externalRefund":{"description":"Whether refund was made externally (on the payment provider's side).","title":"externalRefund","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Refund","description":""},"wix.orders.api.v2.GiftCard":{"type":"object","properties":{"transactionId":{"description":"","format":"GUID","title":"transactionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"id":{"description":"giftcard internal ID","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"providerId":{"description":"giftcard provider appid","format":"GUID","title":"providerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"amount":{"description":"giftcard amount","format":"DECIMAL_VALUE","title":"amount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GiftCard","description":""},"com.wix.ecom.orders.payments.v1.ListTransactionsForSingleOrderRequest":{"type":"object","properties":{"orderId":{"description":"Order ID.","minLength":1,"maxLength":100,"title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListTransactionsForSingleOrderRequest","description":""},"com.wix.ecom.orders.payments.v1.ListTransactionsForSingleOrderResponse":{"type":"object","properties":{"orderTransactions":{"description":"Order ID and its associated transactions.","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.OrderTransactions","summary":"orderTransactions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListTransactionsForSingleOrderResponse","description":""},"com.wix.ecom.orders.payments.v1.ListTransactionsForMultipleOrdersRequest":{"type":"object","properties":{"orderIds":{"description":"Order IDs for which to retrieve transactions.","minItems":1,"maxItems":100,"minLength":1,"maxLength":100,"title":"orderIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListTransactionsForMultipleOrdersRequest","description":""},"com.wix.ecom.orders.payments.v1.ListTransactionsForMultipleOrdersResponse":{"type":"object","properties":{"orderTransactions":{"description":"List of order IDs and their associated transactions.","title":"orderTransactions","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.OrderTransactions"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListTransactionsForMultipleOrdersResponse","description":""},"com.wix.ecom.orders.payments.v1.AddPaymentsRequest":{"type":"object","properties":{"orderId":{"description":"Order ID.","format":"GUID","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"payments":{"description":"Payments to be added to order.","minItems":1,"maxItems":50,"title":"payments","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.Payment"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AddPaymentsRequest","description":""},"com.wix.ecom.orders.payments.v1.AddPaymentsResponse":{"type":"object","properties":{"orderTransactions":{"description":"Order ID and its associated transactions.","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.OrderTransactions","summary":"orderTransactions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paymentsIds":{"description":"IDs of added order payments.","title":"paymentsIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AddPaymentsResponse","description":""},"com.wix.ecom.orders.payments.v1.PaymentsUpdated":{"type":"object","properties":{"orderTransactions":{"description":"Updated order transactions.","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.OrderTransactions","summary":"orderTransactions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paymentIds":{"description":"List of IDs of the updated payments.","maxItems":100,"title":"paymentIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"refundIds":{"description":"List of IDs of the updated refunds.","maxItems":300,"title":"refundIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PaymentsUpdated","description":"Triggered when a payment is updated."},"com.wix.ecom.orders.payments.v1.AddRefundRequest":{"type":"object","properties":{"orderId":{"description":"Order ID this refunds related to","minLength":1,"maxLength":100,"title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"refund":{"description":"Refund with refund transactions to be added to order.","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.Refund","summary":"refund","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sideEffects":{"description":"Side effect details related to refund","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.RefundSideEffects","summary":"sideEffects","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AddRefundRequest","description":""},"com.wix.ecom.orders.payments.v1.RefundSideEffects":{"type":"object","properties":{"restockInfo":{"description":"Inventory restock details as part of this refund.","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.RestockInfo","summary":"restockInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sendOrderRefundedEmail":{"description":"Whether to send a refund confirmation email to the customer.","title":"sendOrderRefundedEmail","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"customMessage":{"description":"Custom message added to the refund confirmation email.","minLength":1,"maxLength":1000,"title":"customMessage","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RefundSideEffects","description":""},"com.wix.ecom.orders.payments.v1.RestockInfo":{"type":"object","properties":{"type":{"description":"Restock type.","title":"type","type":"string","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.RestockInfo.RestockType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"items":{"description":"Restocked line items and quantities. Only relevant for `{\"type\": \"SOME_ITEMS\"}`.","maxItems":300,"title":"items","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.RestockItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestockInfo","description":""},"com.wix.ecom.orders.payments.v1.RestockInfo.RestockType":{"type":"string","description":"","title":"RestockType","enum":["NO_ITEMS","ALL_ITEMS","SOME_ITEMS"]},"com.wix.ecom.orders.payments.v1.RestockItem":{"type":"object","properties":{"lineItemId":{"description":"ID of the line item being restocked.","format":"GUID","title":"lineItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"quantity":{"description":"Line item quantity being restocked.","minimum":1,"maximum":100000,"title":"quantity","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestockItem","description":""},"com.wix.ecom.orders.payments.v1.AddRefundResponse":{"type":"object","properties":{"orderTransactions":{"description":"Order ID and its associated transactions.","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.OrderTransactions","summary":"orderTransactions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"refundId":{"description":"Created refund ID","title":"refundId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AddRefundResponse","description":""},"com.wix.ecom.orders.payments.v1.RefundCreated":{"type":"object","properties":{"orderTransactions":{"description":"Updated order transactions.","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.OrderTransactions","summary":"orderTransactions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"refundId":{"description":"ID of the created refund.","title":"refundId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restockInfo":{"description":"Inventory restock details as part of this refund..","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.RestockInfo","summary":"restockInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sendOrderRefundedEmail":{"description":"Whether to send a refund confirmation email to the customer.","title":"sendOrderRefundedEmail","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"customMessage":{"description":"Custom message added to the refund confirmation email.","title":"customMessage","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"refundItems":{"description":"Refunded line items and quantities that are part of the created refund.","title":"refundItems","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.RefundItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RefundCreated","description":"Triggered when a refund is created."},"com.wix.ecom.orders.payments.v1.UpdatePaymentStatusRequest":{"type":"object","properties":{"orderId":{"description":"Order ID.","format":"GUID","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paymentId":{"description":"Payment ID.","format":"GUID","title":"paymentId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Payment status.","title":"status","type":"string","$ref":"#/components/schemas/wix.payment.api.pay.v3.Transaction.TransactionStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdatePaymentStatusRequest","description":""},"com.wix.ecom.orders.payments.v1.UpdatePaymentStatusResponse":{"type":"object","properties":{"orderTransactions":{"description":"Order ID and its associated transactions after update.","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.OrderTransactions","summary":"orderTransactions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdatePaymentStatusResponse","description":""},"com.wix.ecom.orders.payments.v1.BulkUpdatePaymentStatusesRequest":{"type":"object","properties":{"paymentAndOrderIds":{"description":"Order and payment IDs for which to update payment status.","minItems":1,"maxItems":300,"title":"paymentAndOrderIds","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.PaymentAndOrderId"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnFullEntity":{"description":"Whether to return the full payment entity (`results.item`) in the response.","title":"returnFullEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Payment status.","title":"status","type":"string","$ref":"#/components/schemas/wix.payment.api.pay.v3.Transaction.TransactionStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdatePaymentStatusesRequest","description":""},"com.wix.ecom.orders.payments.v1.PaymentAndOrderId":{"type":"object","properties":{"orderId":{"description":"Order ID.","format":"GUID","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paymentId":{"description":"Payment ID.\ntodo: remove comment once UI will use BulkMarkOrderAsPaid","title":"paymentId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PaymentAndOrderId","description":""},"com.wix.ecom.orders.payments.v1.BulkUpdatePaymentStatusesResponse":{"type":"object","properties":{"results":{"description":"Bulk operation results.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.BulkPaymentResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk operation metadata.","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdatePaymentStatusesResponse","description":""},"com.wix.ecom.orders.payments.v1.BulkPaymentResult":{"type":"object","properties":{"itemMetadata":{"description":"Item metadata.","$ref":"#/components/schemas/wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"item":{"description":"Updated payment. Returned if `return_full_entity` set to `true`.","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.Payment","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkPaymentResult","description":""},"wix.common.ItemMetadata":{"type":"object","properties":{"id":{"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalIndex":{"description":"Index of the item within the request array. Allows for correlation between request and response items.","title":"originalIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"success":{"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated.","title":"success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Details about the error in case of failure.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemMetadata","description":""},"wix.api.ApplicationError":{"type":"object","properties":{"code":{"description":"Error code.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Description of the error.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Data related to the error.","title":"data","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ApplicationError","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","maturity":"GA"}}},"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","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"wix.common.BulkActionMetadata":{"type":"object","properties":{"totalSuccesses":{"description":"Number of items that were successfully processed.","title":"totalSuccesses","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalFailures":{"description":"Number of items that couldn't be processed.","title":"totalFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"undetailedFailures":{"description":"Number of failures without details because detailed failure threshold was exceeded.","title":"undetailedFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkActionMetadata","description":""},"com.wix.ecom.orders.payments.v1.TriggerRefundRequest":{"type":"object","properties":{"orderId":{"description":"The order this refund related to","minLength":1,"maxLength":100,"title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"payments":{"description":"Refund operations information\nCurrently, only *one* payment refund is supported per request","minItems":1,"maxItems":1,"title":"payments","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.PaymentRefund"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"details":{"description":"Business model of a refund","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.RefundDetails","summary":"details","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restockInfo":{"description":"How to restock items as part of this refund","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.RestockInfo","summary":"restockInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sendOrderRefundedEmail":{"description":"Should send a confirmation mail to the customer","title":"sendOrderRefundedEmail","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"customMessage":{"description":"Personal note added to the email","minLength":1,"maxLength":1000,"title":"customMessage","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TriggerRefundRequest","description":""},"com.wix.ecom.orders.payments.v1.PaymentRefund":{"type":"object","properties":{"paymentId":{"description":"Specific payment within the order to refund","format":"GUID","title":"paymentId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"amount":{"description":"Refund amount. Not relevant for membership refunds.","$ref":"#/components/schemas/com.wix.ecommerce.platform_common.api.Price","summary":"amount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"externalRefund":{"description":"Whether refund is made externally and manually (on the payment provider's side)\nWhen false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.\nWhen true, the payment will only be *marked* as refunded, and no actual refund will be performed.","title":"externalRefund","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PaymentRefund","description":""},"com.wix.ecom.orders.payments.v1.TriggerRefundResponse":{"type":"object","properties":{"orderTransactions":{"description":"All order's transactions after the refunds were added","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.OrderTransactions","summary":"orderTransactions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"refundId":{"description":"Created refund ID","title":"refundId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TriggerRefundResponse","description":""},"com.wix.ecom.orders.payments.v1.CalculateRefundRequest":{"type":"object","properties":{"orderId":{"description":"Order ID","minLength":1,"maxLength":100,"title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"refundItems":{"description":"Refunded line items and quantity","minItems":0,"maxItems":300,"title":"refundItems","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.CalculateRefundItemRequest"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"refundShipping":{"description":"Should include shipping in refund calculation","title":"refundShipping","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CalculateRefundRequest","description":""},"com.wix.ecom.orders.payments.v1.CalculateRefundItemRequest":{"type":"object","properties":{"lineItemId":{"description":"ID of the line item being refunded","format":"GUID","title":"lineItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"quantity":{"description":"How much of that line item is being refunded","minimum":1,"maximum":100000,"title":"quantity","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restock":{"description":"Should this item be restocked (used for validation purposes)","title":"restock","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CalculateRefundItemRequest","description":""},"com.wix.ecom.orders.payments.v1.CalculateRefundResponse":{"type":"object","properties":{"total":{"description":"Total refundable amount","format":"DECIMAL_VALUE","title":"total","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tax":{"description":"Tax cost of the order","format":"DECIMAL_VALUE","title":"tax","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"discount":{"description":"Discount given for this order","format":"DECIMAL_VALUE","title":"discount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"subtotal":{"description":"Total cost of the order (without tax)","format":"DECIMAL_VALUE","title":"subtotal","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"previouslyRefundedAmount":{"description":"Previous refund given on that order","format":"DECIMAL_VALUE","title":"previouslyRefundedAmount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"items":{"description":"The refundable items of that order","title":"items","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.CalculateRefundItemResponse"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CalculateRefundResponse","description":""},"com.wix.ecom.orders.payments.v1.CalculateRefundItemResponse":{"type":"object","properties":{"lineItemId":{"description":"Line item ID","title":"lineItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lineItemPrice":{"description":"The line item's price","title":"lineItemPrice","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CalculateRefundItemResponse","description":""},"com.wix.ecom.orders.payments.v1.GetRefundabilityStatusRequest":{"type":"object","properties":{"orderId":{"description":"Order ID.","minLength":1,"maxLength":100,"title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetRefundabilityStatusRequest","description":""},"com.wix.ecom.orders.payments.v1.GetRefundabilityStatusResponse":{"type":"object","properties":{"refundabilities":{"description":"Refundability details.","minItems":0,"maxItems":1,"title":"refundabilities","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.Refundability"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"refundablePerItem":{"description":"Whether the order supports refunding per item.","title":"refundablePerItem","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetRefundabilityStatusResponse","description":""},"com.wix.ecom.orders.payments.v1.Refundability":{"type":"object","properties":{"paymentId":{"description":"Payment ID.","title":"paymentId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"refundabilityStatus":{"description":"Payment refundability status.","title":"refundabilityStatus","type":"string","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.Refundability.RefundableStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"providerLink":{"description":"Link to payment provider dashboard.","title":"providerLink","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Refundability","description":"","oneOf":[{"description":"","summary":"additionalRefundabilityInfo","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.Refundability.additionalRefundabilityInfo"}]},"com.wix.ecom.orders.payments.v1.Refundability.additionalRefundabilityInfo":{"type":"object","title":"additionalRefundabilityInfo","properties":{"nonRefundableReason":{"description":"Reason why payment is not refundable.","title":"nonRefundableReason","type":"string","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.Refundability.NonRefundableReason","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"manuallyRefundableReason":{"description":"Reason why payment is only refundable manually.","title":"manuallyRefundableReason","type":"string","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.Refundability.ManuallyRefundableReason","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wix.ecom.orders.payments.v1.Refundability.RefundableStatus":{"type":"string","description":"","title":"RefundableStatus","enum":["NOT_REFUNDABLE","MANUAL","REFUNDABLE"]},"com.wix.ecom.orders.payments.v1.Refundability.NonRefundableReason":{"type":"string","description":"","title":"NonRefundableReason","enum":["NONE","ALREADY_REFUNDED","PROVIDER_IS_DOWN","INTERNAL_ERROR","NOT_PAID","ACCESS_DENIED","ZERO_PRICE","DISABLED_BY_PROVIDER","PARTIALLY_PAID","DEPOSIT_ONLINE_ITEM","PENDING_REFUND","FORBIDDEN"]},"com.wix.ecom.orders.payments.v1.Refundability.ManuallyRefundableReason":{"type":"string","description":"","title":"ManuallyRefundableReason","enum":["EXPIRED","NOT_SUPPORTED","NOT_FOUND","OFFLINE"]},"com.wix.ecom.orders.payments.v1.ListInvoicesForSingleOrderRequest":{"type":"object","properties":{"orderId":{"description":"Order ID.","minLength":1,"maxLength":100,"title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListInvoicesForSingleOrderRequest","description":""},"com.wix.ecom.orders.payments.v1.ListInvoicesForSingleOrderResponse":{"type":"object","properties":{"invoices":{"description":"List of invoices.","title":"invoices","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.InvoiceInfo"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListInvoicesForSingleOrderResponse","description":""},"com.wix.ecom.orders.payments.v1.InvoiceInfo":{"type":"object","properties":{"id":{"description":"Invoice ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of the app that set the invoice.","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Invoice URL.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"createdDate":{"description":"Invoice creation date and time.","title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}}},"title":"InvoiceInfo","description":""},"com.wix.ecom.orders.payments.v1.ListInvoicesForMultipleOrdersRequest":{"type":"object","properties":{"orderIds":{"description":"Order IDs for which to retrieve invoices.","minItems":0,"maxItems":300,"minLength":1,"maxLength":100,"title":"orderIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListInvoicesForMultipleOrdersRequest","description":""},"com.wix.ecom.orders.payments.v1.ListInvoicesForMultipleOrdersResponse":{"type":"object","properties":{"invoicesForOrder":{"description":"List of order IDs and their associated invoices.","title":"invoicesForOrder","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.InvoicesForOrder"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListInvoicesForMultipleOrdersResponse","description":""},"com.wix.ecom.orders.payments.v1.InvoicesForOrder":{"type":"object","properties":{"orderId":{"description":"Order ID.","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"invoicesInfo":{"description":"Invoices info.","title":"invoicesInfo","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.InvoiceInfo"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InvoicesForOrder","description":""},"com.wix.ecom.orders.payments.v1.GenerateInvoiceRequest":{"type":"object","properties":{"orderId":{"description":"Order ID.","minLength":1,"maxLength":100,"title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GenerateInvoiceRequest","description":""},"com.wix.ecom.orders.payments.v1.GenerateInvoiceResponse":{"type":"object","properties":{"invoiceId":{"description":"Invoice ID.","title":"invoiceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GenerateInvoiceResponse","description":""},"com.wix.ecom.orders.payments.v1.BulkGenerateInvoicesRequest":{"type":"object","properties":{"orderIds":{"description":"Order IDs.","minItems":1,"maxItems":100,"minLength":1,"maxLength":100,"title":"orderIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkGenerateInvoicesRequest","description":""},"com.wix.ecom.orders.payments.v1.BulkGenerateInvoicesResponse":{"type":"object","properties":{"results":{"description":"","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.BulkInvoiceResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkGenerateInvoicesResponse","description":""},"com.wix.ecom.orders.payments.v1.BulkInvoiceResult":{"type":"object","properties":{"itemMetadata":{"description":"","$ref":"#/components/schemas/wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"item":{"description":"","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.InvoiceForOrder","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkInvoiceResult","description":""},"com.wix.ecom.orders.payments.v1.InvoiceForOrder":{"type":"object","properties":{"orderId":{"description":"Order ID.","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"invoiceId":{"description":"Invoice ID.","title":"invoiceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InvoiceForOrder","description":""},"com.wix.ecom.orders.payments.v1.AddInvoiceToOrderRequest":{"type":"object","properties":{"orderId":{"description":"Order ID.","minLength":1,"maxLength":100,"title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"invoiceInfo":{"description":"Invoice info.","$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.InvoiceInfo","summary":"invoiceInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AddInvoiceToOrderRequest","description":""},"com.wix.ecom.orders.payments.v1.AddInvoiceToOrderResponse":{"type":"object","properties":{"orderInvoices":{"description":"List of order invoices.","title":"orderInvoices","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.payments.v1.InvoiceInfo"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AddInvoiceToOrderResponse","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","maturity":"GA"}},"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","maturity":"GA"}},"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","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp.","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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","maturity":"GA"}}},"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","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","maturity":"GA"}}},"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","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]}}},"title":"Order Transactions","description":"Manage eCommerce order payments","fqdn":"wix.ecom.v1.order_transactions"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Order Transactions API\n\nThe eCommerce Order Transactions API concentrates records and details of payments and refunds associated with eCommerce orders.\n\nWith the Order Transactions API you can:\n\n* Retrieve transactions related to a [single](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::12e752bf-af0b-4cf5-ae1e-91e68a073e3dslug::list-transactions-for-single-order*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/list-transactions-for-single-order) or [multiple](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::12e752bf-af0b-4cf5-ae1e-91e68a073e3dslug::list-transactions-for-multiple-orders*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/list-transactions-for-multiple-orders) orders.\n* [Add payment records](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::12e752bf-af0b-4cf5-ae1e-91e68a073e3dslug::add-payments*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/add-payments) to an order.\n* Listen to events when an order's [transactions are updated](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::12e752bf-af0b-4cf5-ae1e-91e68a073e3dslug::order-transactions-updated*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/order-transactions-updated).\n\n## Terminology\n\n* **Transaction**: Global term for a transfer of funds - can be either a:\n * **Payment**: A transfer of funds from customer to merchant/seller when making a purchase.\n * **Refund** A reimbursing transfer of funds back to the buyer."},{"displayName":"Example Flows","slugifyName":"example-flows","content":"# Sample Use Case & Flow: Order Transactions\n\nThis article shares a possible use case your app could support, as well as an example flow. You're certainly not limited to this use case, but it can be a helpful jumping off point as you plan your app's implementation.\n\n## Retrieve transactions related eCommerce orders\n\nYour app can retrieve details about payments and refunds associated with an order. For example, you can check for payments that were made by credit-card, payments made by gift card, or orders that were not successfully refunded.\n\nTo retrieve info about an order's transactions:\n\n1. Call [List Transactions For Single Order](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::12e752bf-af0b-4cf5-ae1e-91e68a073e3dslug::list-transactions-for-single-order*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/list-transactions-for-single-order) with an [eCommerce order ID](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).\n * To retrieve transaction details about more than 1 order, call [List Transactions For Multiple Orders](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::12e752bf-af0b-4cf5-ae1e-91e68a073e3dslug::list-transactions-for-multiple-orders*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/list-transactions-for-multiple-orders) with an array of [eCommerce order IDs](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).\n2. You can use the returned info to check payment and refund details in the relevant provider or gateway systems, pass the details on to your accounting or invoice apps, and more.\n\n## Add payment records to imported orders\n\nIf you are importing orders from other systems, you may want to add payment records to those orders. To add a payment record to an order that is already in the eCommerce system:\n\n1. Once you have the order ID, pass it to the [Add Payments](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::12e752bf-af0b-4cf5-ae1e-91e68a073e3dslug::add-payments*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/add-payments) endpoint.\n2. In the body params, pass payment details like the `createdDate`, `amount`, `paymentMethod`, and any other payment details.\n3. When using [Add Payments](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::12e752bf-af0b-4cf5-ae1e-91e68a073e3dslug::add-payments*fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/add-payments) you can add up to 50 payment records to a single order with 1 API call."}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

List Transactions For Multiple Orders

Permission Scopes