{"id":"32b4175b-c92a-4dc1-8acd-43aaebc263a3","createdDate":"2024-07-30T08:07:54.692Z","updatedDate":"2024-07-30T08:07:54.692Z","resourceId":"ebe24b2e-b153-4401-83bb-6818878c121d","api":{"schema":{"object":{"displayName":"Fulfillments Object","description":"Create and manage eCommerce order fulfillments","slug":"fulfillments-object","$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.OrderWithFulfillments","legacyExamples":[{"title":"OrderWithFulfillments","content":"{\n \"orderWithFulfillments\": {\n \"orderId\": \"58c9a790-27b7-463f-a865-c7cb494f7c29\",\n \"fulfillments\": [\n {\n \"id\": \"0d824fc7-2621-4e97-a5c8-489ec1b43377\",\n \"createdDate\": \"2023-02-22T15:55:47.021Z\",\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"fedex\",\n \"trackingLink\": \"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=12345\"\n }\n }\n ]\n }\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"methods":[{"summary":"List Fulfillments For Single Order","description":"Retrieves fulfillments associated with a specified order.","operationId":"com.wix.ecom.orders.fulfillments.v1.Fulfillments.ListFulfillmentsForSingleOrder","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"orderId","description":"Order ID for which to retrieve fulfillments.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.ListFulfillmentsForSingleOrderResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/fulfillments","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/fulfillments","destinationPath":"/v1/fulfillments","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.READ_FULFILLMENTS"],"applicableIdentities":["APP","MEMBER"],"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 Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.fulfillments.v1.ListFulfillmentsForSingleOrderRequest","responseMessage":"com.wix.ecom.orders.fulfillments.v1.ListFulfillmentsForSingleOrderResponse"},"legacyExamples":[{"name":"ListFulfillmentsForSingleOrder","type":"METHOD","content":{"title":"List Fulfillments For Single Order","request":"curl -X GET 'https://www.wixapis.com/ecom/v1/fulfillments/orders/265c7d98-a7c3-48c4-89cd-bbdc00921eab' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"orderWithFulfillments\": {\n \"orderId\": \"265c7d98-a7c3-48c4-89cd-bbdc00921eab\",\n \"fulfillments\": [\n {\n \"id\": \"80f939c8-cdc4-44fe-a058-b54d506af170\",\n \"createdDate\": \"2021-05-25T13:55:26.458Z\",\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 2\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"ups\",\n \"trackingLink\": \"https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=12345\"\n }\n },\n {\n \"id\": \"eb9138ff-1490-4dbc-b053-743240b9ab8f\",\n \"createdDate\": \"2021-05-25T13:55:47.605Z\",\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000002\",\n \"quantity\": 3\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"ups\",\n \"trackingLink\": \"https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=12345\"\n }\n }\n ]\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v1/fulfillments/orders/{orderId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.READ_FULFILLMENTS"],"applicableIdentities":["APP","MEMBER"],"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 Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.fulfillments.v1.ListFulfillmentsForSingleOrderRequest","responseMessage":"com.wix.ecom.orders.fulfillments.v1.ListFulfillmentsForSingleOrderResponse"},"legacyExamples":[{"name":"ListFulfillmentsForSingleOrder","type":"METHOD","content":{"title":"List Fulfillments For Single Order","request":"curl -X GET 'https://www.wixapis.com/ecom/v1/fulfillments/orders/265c7d98-a7c3-48c4-89cd-bbdc00921eab' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"orderWithFulfillments\": {\n \"orderId\": \"265c7d98-a7c3-48c4-89cd-bbdc00921eab\",\n \"fulfillments\": [\n {\n \"id\": \"80f939c8-cdc4-44fe-a058-b54d506af170\",\n \"createdDate\": \"2021-05-25T13:55:26.458Z\",\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 2\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"ups\",\n \"trackingLink\": \"https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=12345\"\n }\n },\n {\n \"id\": \"eb9138ff-1490-4dbc-b053-743240b9ab8f\",\n \"createdDate\": \"2021-05-25T13:55:47.605Z\",\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000002\",\n \"quantity\": 3\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"ups\",\n \"trackingLink\": \"https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=12345\"\n }\n }\n ]\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"List Fulfillments For Single Order","slugifiedName":"list-fulfillments-for-single-order"},"permissionScopes":[{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"},{"name":"Read eCommerce - all read permissions","scopeId":"SCOPE.DC-ECOM-MEGA.READ-ECOM"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"List Fulfillments For Multiple Orders","description":"Retrieves fulfillments associated with multiple specified orders.","operationId":"com.wix.ecom.orders.fulfillments.v1.Fulfillments.ListFulfillmentsForMultipleOrders","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.ListFulfillmentsForMultipleOrdersResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/fulfillments","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/fulfillments","destinationPath":"/v1/fulfillments","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ListFulfillmentsForMultipleOrdersRequest","description":"","properties":{"orderIds":{"description":"List of order IDs for which to retrieve fulfillments.","minItems":1,"maxItems":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.fulfillments.v1.Fulfillments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.READ_FULFILLMENTS"],"applicableIdentities":["APP","MEMBER"],"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 Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.fulfillments.v1.ListFulfillmentsForMultipleOrdersRequest","responseMessage":"com.wix.ecom.orders.fulfillments.v1.ListFulfillmentsForMultipleOrdersResponse"},"legacyExamples":[{"name":"ListFulfillmentsForMultipleOrders","type":"METHOD","content":{"title":"List Fulfillments For Multiple Orders","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/fulfillments/list-by-ids' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"orderIds\": [\n \"265c7d98-a7c3-48c4-89cd-bbdc00921eab\",\n \"d1748680-7fd5-401e-9f71-cd3b9ea70bdb\"\n ]\n }'","response":"{\n \"ordersWithFulfillments\": [\n {\n \"orderId\": \"265c7d98-a7c3-48c4-89cd-bbdc00921eab\",\n \"fulfillments\": [\n {\n \"id\": \"80f939c8-cdc4-44fe-a058-b54d506af170\",\n \"createdDate\": \"2021-05-25T13:55:26.458Z\",\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 2\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"ups\",\n \"trackingLink\": \"https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=12345\"\n }\n },\n {\n \"id\": \"eb9138ff-1490-4dbc-b053-743240b9ab8f\",\n \"createdDate\": \"2021-05-25T13:55:47.605Z\",\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000002\",\n \"quantity\": 3\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"ups\",\n \"trackingLink\": \"https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=12345\"\n }\n }\n ]\n },\n {\n \"orderId\": \"d1748680-7fd5-401e-9f71-cd3b9ea70bdb\",\n \"fulfillments\": [\n {\n \"id\": \"9f6ff4c4-1fb2-4b0a-b433-32956052316c\",\n \"createdDate\": \"2021-07-04T13:40:15.860Z\",\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"102030\",\n \"shippingProvider\": \"dhl\",\n \"trackingLink\": \"https://www.logistics.dhl/global-en/home/tracking.html?tracking-id=102030\"\n }\n }\n ]\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/fulfillments/list-by-ids","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.READ_FULFILLMENTS"],"applicableIdentities":["APP","MEMBER"],"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 Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.fulfillments.v1.ListFulfillmentsForMultipleOrdersRequest","responseMessage":"com.wix.ecom.orders.fulfillments.v1.ListFulfillmentsForMultipleOrdersResponse"},"legacyExamples":[{"name":"ListFulfillmentsForMultipleOrders","type":"METHOD","content":{"title":"List Fulfillments For Multiple Orders","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/fulfillments/list-by-ids' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"orderIds\": [\n \"265c7d98-a7c3-48c4-89cd-bbdc00921eab\",\n \"d1748680-7fd5-401e-9f71-cd3b9ea70bdb\"\n ]\n }'","response":"{\n \"ordersWithFulfillments\": [\n {\n \"orderId\": \"265c7d98-a7c3-48c4-89cd-bbdc00921eab\",\n \"fulfillments\": [\n {\n \"id\": \"80f939c8-cdc4-44fe-a058-b54d506af170\",\n \"createdDate\": \"2021-05-25T13:55:26.458Z\",\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 2\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"ups\",\n \"trackingLink\": \"https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=12345\"\n }\n },\n {\n \"id\": \"eb9138ff-1490-4dbc-b053-743240b9ab8f\",\n \"createdDate\": \"2021-05-25T13:55:47.605Z\",\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000002\",\n \"quantity\": 3\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"ups\",\n \"trackingLink\": \"https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=12345\"\n }\n }\n ]\n },\n {\n \"orderId\": \"d1748680-7fd5-401e-9f71-cd3b9ea70bdb\",\n \"fulfillments\": [\n {\n \"id\": \"9f6ff4c4-1fb2-4b0a-b433-32956052316c\",\n \"createdDate\": \"2021-07-04T13:40:15.860Z\",\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"102030\",\n \"shippingProvider\": \"dhl\",\n \"trackingLink\": \"https://www.logistics.dhl/global-en/home/tracking.html?tracking-id=102030\"\n }\n }\n ]\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"List Fulfillments For Multiple Orders","slugifiedName":"list-fulfillments-for-multiple-orders"},"permissionScopes":[{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"},{"name":"Read eCommerce - all read permissions","scopeId":"SCOPE.DC-ECOM-MEGA.READ-ECOM"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Create Fulfillment","description":"Creates an order fulfillment.","operationId":"com.wix.ecom.orders.fulfillments.v1.Fulfillments.CreateFulfillment","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.fulfillments.v1.CreateFulfillmentResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/fulfillments","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/fulfillments","destinationPath":"/v1/fulfillments","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateFulfillmentRequest","description":"","properties":{"fulfillment":{"description":"Fulfillment info.","$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.Fulfillment","summary":"fulfillment","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["orderId","fulfillment","fulfillment.lineItems","fulfillment.lineItems.id"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Fulfillments Updated","description":"Triggered when one or more of an order's fulfillments are created, updated, or deleted.\n\nThe response contains the order's ID and details about all of its fulfillments following the change.","permissions":["ECOM.READ_FULFILLMENTS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.fulfillments","serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.ecom.v1.fulfillments_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.MODIFY_FULFILLMENTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.fulfillments.v1.CreateFulfillmentRequest","responseMessage":"com.wix.ecom.orders.fulfillments.v1.CreateFulfillmentResponse"},"legacyExamples":[{"name":"CreateFulfillment","type":"METHOD","content":{"title":"Create Fulfillment","description":"Passing a shipping provider that supports auto-filling the `trackingLink` in the response.","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/fulfillments/orders/58c9a790-27b7-463f-a865-c7cb494f7c29/create-fulfillment' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"fulfillment\": {\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"fedex\"\n }\n }\n }'","response":"{\n \"orderWithFulfillments\": {\n \"orderId\": \"58c9a790-27b7-463f-a865-c7cb494f7c29\",\n \"fulfillments\": [\n {\n \"id\": \"0d824fc7-2621-4e97-a5c8-489ec1b43377\",\n \"createdDate\": \"2023-02-22T15:55:47.021Z\",\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"fedex\",\n \"trackingLink\": \"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=12345\"\n }\n }\n ]\n },\n \"fulfillmentId\": \"0d824fc7-2621-4e97-a5c8-489ec1b43377\"\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v1/fulfillments/orders/{orderId}/create-fulfillment","rpcOnly":false,"triggeredEvents":[{"title":"Fulfillments Updated","description":"Triggered when one or more of an order's fulfillments are created, updated, or deleted.\n\nThe response contains the order's ID and details about all of its fulfillments following the change.","permissions":["ECOM.READ_FULFILLMENTS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.fulfillments","serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.ecom.v1.fulfillments_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.MODIFY_FULFILLMENTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.fulfillments.v1.CreateFulfillmentRequest","responseMessage":"com.wix.ecom.orders.fulfillments.v1.CreateFulfillmentResponse"},"legacyExamples":[{"name":"CreateFulfillment","type":"METHOD","content":{"title":"Create Fulfillment","description":"Passing a shipping provider that supports auto-filling the `trackingLink` in the response.","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/fulfillments/orders/58c9a790-27b7-463f-a865-c7cb494f7c29/create-fulfillment' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"fulfillment\": {\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"fedex\"\n }\n }\n }'","response":"{\n \"orderWithFulfillments\": {\n \"orderId\": \"58c9a790-27b7-463f-a865-c7cb494f7c29\",\n \"fulfillments\": [\n {\n \"id\": \"0d824fc7-2621-4e97-a5c8-489ec1b43377\",\n \"createdDate\": \"2023-02-22T15:55:47.021Z\",\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"fedex\",\n \"trackingLink\": \"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=12345\"\n }\n }\n ]\n },\n \"fulfillmentId\": \"0d824fc7-2621-4e97-a5c8-489ec1b43377\"\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Create Fulfillment","slugifiedName":"create-fulfillment"},"permissionScopes":[{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Update Fulfillment","description":"Updates a fulfillment's properties.\n\nTo update a field's value, include the new value in the `fulfillment` field in the body params.\nTo remove a field's value, pass `null`.","operationId":"com.wix.ecom.orders.fulfillments.v1.Fulfillments.UpdateFulfillment","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"fulfillment.id","description":"Fulfillment ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.UpdateFulfillmentResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/fulfillments","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/fulfillments","destinationPath":"/v1/fulfillments","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateFulfillmentRequest","description":"","properties":{"orderId":{"description":"Order ID.","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fulfillment":{"description":"Fulfillment info to update.","$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.Fulfillment","summary":"fulfillment","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["orderId","fulfillment.id"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Fulfillments Updated","description":"","permissions":["ECOM.READ_FULFILLMENTS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.fulfillments","serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.ecom.v1.fulfillments_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.MODIFY_FULFILLMENTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.fulfillments.v1.UpdateFulfillmentRequest","responseMessage":"com.wix.ecom.orders.fulfillments.v1.UpdateFulfillmentResponse"},"legacyExamples":[{"name":"UpdateFulfillment","type":"METHOD","content":{"title":"Update Fulfillment","description":"Updating a fulfillment's tracking number and tracking link.","request":"curl -X PATCH \\\n 'https://www.wixapis.com/ecom/v1/fulfillments/1d93cd8e-0de5-469b-b802-88bcd76cb222/orders/eb4b91d3-51f3-494d-94df-479ff2c6eb08' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"fulfillment\": {\n \"trackingInfo\": {\n \"trackingNumber\": \"45782\",\n \"trackingLink\": \"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=45782\"\n }\n }\n }'","response":"{\n \"orderWithFulfillments\": {\n \"orderId\": \"eb4b91d3-51f3-494d-94df-479ff2c6eb08\",\n \"fulfillments\": [\n {\n \"id\": \"1d93cd8e-0de5-469b-b802-88bcd76cb222\",\n \"createdDate\": \"2023-02-27T11:42:48.021Z\",\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"45782\",\n \"shippingProvider\": \"fedex\",\n \"trackingLink\": \"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=45782\"\n }\n }\n ]\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"patch","path":"/v1/fulfillments/{fulfillment.id}/orders/{orderId}","rpcOnly":false,"triggeredEvents":[{"title":"Fulfillments Updated","description":"","permissions":["ECOM.READ_FULFILLMENTS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.fulfillments","serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.ecom.v1.fulfillments_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.MODIFY_FULFILLMENTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.fulfillments.v1.UpdateFulfillmentRequest","responseMessage":"com.wix.ecom.orders.fulfillments.v1.UpdateFulfillmentResponse"},"legacyExamples":[{"name":"UpdateFulfillment","type":"METHOD","content":{"title":"Update Fulfillment","description":"Updating a fulfillment's tracking number and tracking link.","request":"curl -X PATCH \\\n 'https://www.wixapis.com/ecom/v1/fulfillments/1d93cd8e-0de5-469b-b802-88bcd76cb222/orders/eb4b91d3-51f3-494d-94df-479ff2c6eb08' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"fulfillment\": {\n \"trackingInfo\": {\n \"trackingNumber\": \"45782\",\n \"trackingLink\": \"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=45782\"\n }\n }\n }'","response":"{\n \"orderWithFulfillments\": {\n \"orderId\": \"eb4b91d3-51f3-494d-94df-479ff2c6eb08\",\n \"fulfillments\": [\n {\n \"id\": \"1d93cd8e-0de5-469b-b802-88bcd76cb222\",\n \"createdDate\": \"2023-02-27T11:42:48.021Z\",\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"45782\",\n \"shippingProvider\": \"fedex\",\n \"trackingLink\": \"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=45782\"\n }\n }\n ]\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update Fulfillment","slugifiedName":"update-fulfillment"},"permissionScopes":[{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Delete Fulfillment","description":"Deletes an existing order fulfillment.","operationId":"com.wix.ecom.orders.fulfillments.v1.Fulfillments.DeleteFulfillment","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":"fulfillmentId","description":"ID of the fulfillment to delete.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.DeleteFulfillmentResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/fulfillments","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/fulfillments","destinationPath":"/v1/fulfillments","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Fulfillments Updated","description":"Triggered when one or more of an order's fulfillments are created, updated, or deleted.\n\nThe response contains the order's ID and details about all of its fulfillments following the change.","permissions":["ECOM.READ_FULFILLMENTS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.fulfillments","serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.ecom.v1.fulfillments_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.MODIFY_FULFILLMENTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.fulfillments.v1.DeleteFulfillmentRequest","responseMessage":"com.wix.ecom.orders.fulfillments.v1.DeleteFulfillmentResponse"},"legacyExamples":[{"name":"DeleteFulfillment","type":"METHOD","content":{"title":"Delete Fulfillment","request":"curl -X DELETE \\\n 'https://www.wixapis.com/ecom/v1/fulfillments/0d824fc7-2621-4e97-a5c8-489ec1b43377/orders/4c51c360-399f-4276-96b1-d85f0963dbfd' \\\n -H 'Authorization: '","response":"{\n \"orderWithFulfillments\": {\n \"orderId\": \"4c51c360-399f-4276-96b1-d85f0963dbfd\",\n \"fulfillments\": []\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"delete","path":"/v1/fulfillments/{fulfillmentId}/orders/{orderId}","rpcOnly":false,"triggeredEvents":[{"title":"Fulfillments Updated","description":"Triggered when one or more of an order's fulfillments are created, updated, or deleted.\n\nThe response contains the order's ID and details about all of its fulfillments following the change.","permissions":["ECOM.READ_FULFILLMENTS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.fulfillments","serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.ecom.v1.fulfillments_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.MODIFY_FULFILLMENTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.fulfillments.v1.DeleteFulfillmentRequest","responseMessage":"com.wix.ecom.orders.fulfillments.v1.DeleteFulfillmentResponse"},"legacyExamples":[{"name":"DeleteFulfillment","type":"METHOD","content":{"title":"Delete Fulfillment","request":"curl -X DELETE \\\n 'https://www.wixapis.com/ecom/v1/fulfillments/0d824fc7-2621-4e97-a5c8-489ec1b43377/orders/4c51c360-399f-4276-96b1-d85f0963dbfd' \\\n -H 'Authorization: '","response":"{\n \"orderWithFulfillments\": {\n \"orderId\": \"4c51c360-399f-4276-96b1-d85f0963dbfd\",\n \"fulfillments\": []\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Delete Fulfillment","slugifiedName":"delete-fulfillment"},"permissionScopes":[{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Bulk Create Fulfillments","description":"Creates multiple fulfillments for one or more orders.","operationId":"com.wix.ecom.orders.fulfillments.v1.Fulfillments.BulkCreateFulfillment","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.BulkCreateFulfillmentResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/ecom/v1/fulfillments","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/ecom/v1/fulfillments","destinationPath":"/v1/fulfillments","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkCreateFulfillmentRequest","description":"","properties":{"ordersWithFulfillments":{"description":"List of order IDs and their associated fulfillments.","minItems":1,"maxItems":100,"title":"ordersWithFulfillments","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.BulkCreateOrderWithFulfillments"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["ordersWithFulfillments","ordersWithFulfillments.orderId","ordersWithFulfillments.fulfillments","ordersWithFulfillments.fulfillments.lineItems","ordersWithFulfillments.fulfillments.lineItems.id"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Fulfillments Updated","description":"Triggered when one or more of an order's fulfillments are created, updated, or deleted.\n\nThe response contains the order's ID and details about all of its fulfillments following the change.","permissions":["ECOM.READ_FULFILLMENTS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.fulfillments","serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.ecom.v1.fulfillments_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.MODIFY_FULFILLMENTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.fulfillments.v1.BulkCreateFulfillmentRequest","responseMessage":"com.wix.ecom.orders.fulfillments.v1.BulkCreateFulfillmentResponse"},"legacyExamples":[{"name":"BulkCreateFulfillment","type":"METHOD","content":{"title":"Bulk Create Fulfillments","description":"Creates a different fulfillment for two separate orders","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/fulfillments/orders/bulk/create-fulfillments' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"ordersWithFulfillments\": [\n {\n \"orderId\": \"eb4b91d3-51f3-494d-94df-479ff2c6eb08\",\n \"fulfillments\": [\n {\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"fedex\"\n }\n }\n ]\n },\n {\n \"orderId\": \"719f96d3-80c7-45c2-b4c1-f15eb610f8a8\",\n \"fulfillments\": [\n {\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"67890\",\n \"shippingProvider\": \"usps\"\n }\n }\n ]\n }\n ]\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"eb4b91d3-51f3-494d-94df-479ff2c6eb08\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"ordersWithFulfillments\": {\n \"orderId\": \"eb4b91d3-51f3-494d-94df-479ff2c6eb08\",\n \"fulfillments\": [\n {\n \"id\": \"1d93cd8e-0de5-469b-b802-88bcd76cb222\",\n \"createdDate\": \"2023-02-27T11:42:48.021Z\",\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"fedex\",\n \"trackingLink\": \"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=12345\"\n }\n }\n ]\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"719f96d3-80c7-45c2-b4c1-f15eb610f8a8\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"ordersWithFulfillments\": {\n \"orderId\": \"719f96d3-80c7-45c2-b4c1-f15eb610f8a8\",\n \"fulfillments\": [\n {\n \"id\": \"09876985-7d10-4098-8b93-acb6023ac1f8\",\n \"createdDate\": \"2023-02-27T11:42:48.021Z\",\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"67890\",\n \"shippingProvider\": \"usps\",\n \"trackingLink\": \"https://tools.usps.com/go/TrackConfirmAction.action?tLabels=67890\"\n }\n }\n ]\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/fulfillments/orders/bulk/create-fulfillments","rpcOnly":false,"triggeredEvents":[{"title":"Fulfillments Updated","description":"Triggered when one or more of an order's fulfillments are created, updated, or deleted.\n\nThe response contains the order's ID and details about all of its fulfillments following the change.","permissions":["ECOM.READ_FULFILLMENTS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.fulfillments","serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.ecom.v1.fulfillments_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["ECOM.MODIFY_FULFILLMENTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.ecom.orders.fulfillments.v1.BulkCreateFulfillmentRequest","responseMessage":"com.wix.ecom.orders.fulfillments.v1.BulkCreateFulfillmentResponse"},"legacyExamples":[{"name":"BulkCreateFulfillment","type":"METHOD","content":{"title":"Bulk Create Fulfillments","description":"Creates a different fulfillment for two separate orders","request":"curl -X POST \\\n 'https://www.wixapis.com/ecom/v1/fulfillments/orders/bulk/create-fulfillments' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"ordersWithFulfillments\": [\n {\n \"orderId\": \"eb4b91d3-51f3-494d-94df-479ff2c6eb08\",\n \"fulfillments\": [\n {\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"fedex\"\n }\n }\n ]\n },\n {\n \"orderId\": \"719f96d3-80c7-45c2-b4c1-f15eb610f8a8\",\n \"fulfillments\": [\n {\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"67890\",\n \"shippingProvider\": \"usps\"\n }\n }\n ]\n }\n ]\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"eb4b91d3-51f3-494d-94df-479ff2c6eb08\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"ordersWithFulfillments\": {\n \"orderId\": \"eb4b91d3-51f3-494d-94df-479ff2c6eb08\",\n \"fulfillments\": [\n {\n \"id\": \"1d93cd8e-0de5-469b-b802-88bcd76cb222\",\n \"createdDate\": \"2023-02-27T11:42:48.021Z\",\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"fedex\",\n \"trackingLink\": \"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=12345\"\n }\n }\n ]\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"719f96d3-80c7-45c2-b4c1-f15eb610f8a8\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"ordersWithFulfillments\": {\n \"orderId\": \"719f96d3-80c7-45c2-b4c1-f15eb610f8a8\",\n \"fulfillments\": [\n {\n \"id\": \"09876985-7d10-4098-8b93-acb6023ac1f8\",\n \"createdDate\": \"2023-02-27T11:42:48.021Z\",\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"67890\",\n \"shippingProvider\": \"usps\",\n \"trackingLink\": \"https://tools.usps.com/go/TrackConfirmAction.action?tLabels=67890\"\n }\n }\n ]\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 Create Fulfillments","slugifiedName":"bulk-create-fulfillments"},"permissionScopes":[{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]}],"webhooks":[{"summary":"Order With Fulfillments Updated","title":"Fulfillments Updated","description":"Triggered when one or more of an order's fulfillments are created, updated, or deleted.\n\nThe response contains the order's ID and details about all of its fulfillments following the change.","permissions":["ECOM.READ_FULFILLMENTS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.fulfillments","serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","domainEvent":"UPDATED","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 Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"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.fulfillments_updated","legacyExamples":[{"name":"FulfillmentsUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"entityId\": \"1241d17c-82e1-4a6d-9fae-bd6d2a8073e5\",\n \"slug\": \"updated\",\n \"id\": \"6e03a96a-3870-4ad7-b814-1f8119310bf4\",\n \"entityFqdn\": \"wix.ecom.v1.fulfillments\",\n \"updatedEvent\": {\n \"currentEntity\": {\n \"orderId\": \"1241d17c-82e1-4a6d-9fae-bd6d2a8073e5\",\n \"fulfillments\": [\n {\n \"id\": \"e110b73a-6896-4327-b5dd-87b4a2e7eaf3\",\n \"createdDate\": \"2023-01-25T13:45:20.753Z\",\n \"lineItems\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"quantity\": 1\n }\n ],\n \"trackingInfo\": {\n \"trackingNumber\": \"12345\",\n \"shippingProvider\": \"ups\",\n \"trackingLink\": \"https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=12345\"\n }\n }\n ]\n }\n },\n \"eventTime\": \"2023-01-25T13:45:21.129908Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.OrderWithFulfillments","contentLink":{"displayName":"Order With Fulfillments Updated","slugifiedName":"order-with-fulfillments-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"},{"name":"Read eCommerce - all read permissions","scopeId":"SCOPE.DC-ECOM-MEGA.READ-ECOM"},{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Read Orders","scopeId":"SCOPE.DC-STORES.READ-ORDERS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Order Fulfillments\n\nAn order fulfillment refers to the process of preparing and delivering orders to customers. This process usually involves receiving orders, picking the products from inventory, packing them securely, providing tracking information, and shipping them to the customer's address.\n\nA fulfillment object contains information about an order's shipping provider, tracking details, and the line items associated with the fulfillment.\n\nWith the Order Fulfillments API you can:\n\n* Create fulfillments for [some or all items in an order](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ebe24b2e-b153-4401-83bb-6818878c121dslug::create-fulfillment*fallback::https://dev.wix.com/api/rest/wix-ecommerce/order-fulfillments/create-fulfillment).\n* Create fulfillments for [multiple orders at once](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ebe24b2e-b153-4401-83bb-6818878c121dslug::bulk-create-fulfillments*fallback::https://dev.wix.com/api/rest/wix-ecommerce/order-fulfillments/bulk-create-fulfillments).\n* Retrieve fulfillments associated with [one](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ebe24b2e-b153-4401-83bb-6818878c121dslug::list-fulfillments-for-single-order*fallback::https://dev.wix.com/api/rest/wix-ecommerce/order-fulfillments/list-fulfillments-for-single-order) or [many](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ebe24b2e-b153-4401-83bb-6818878c121dslug::list-fulfillments-for-multiple-orders*fallback::https://dev.wix.com/api/rest/wix-ecommerce/order-fulfillments/list-fulfillments-for-multiple-orders) orders.\n* Listen for [changes made to orders' fulfillments](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ebe24b2e-b153-4401-83bb-6818878c121dslug::order-with-fulfillments-updated*fallback::https://dev.wix.com/api/rest/wix-ecommerce/order-fulfillments/order-with-fulfillments-updated-webhook).","sourceRepo":"git@github.com:wix-private/ecom.git","path":"appendices/docs/intro.md"},{"displayName":"Sample Flow","slugifyName":"sample-flow","content":"# Order Fulfillments: Sample Use Cases & Flows\n\nThis article shares a possible use case your app could support, as well as\na sample flow that could support the use case. This can be a helpful jumping\noff point as you plan your app's implementation.\n\n## Create a fulfillment for a new order\n\nYou can use webhooks to listen for when an order is placed, and then create a fulfillment for the new order.\n\n1. Use the [Order Approved Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::546b2514-6a71-4148-bccf-1fb8d8604792slug::order-approved*fallback::https://dev.wix.com/api/rest/wix-ecommerce/orders/order-approved-webhook) to listen for incoming approved orders.\n2. When a new order comes in, save the order ID. This can be found as the value of the `entityId` or `actionEvent.body.order.id` fields in the [Order Approved Webhook's](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::546b2514-6a71-4148-bccf-1fb8d8604792slug::order-approved*fallback::https://dev.wix.com/api/rest/wix-ecommerce/orders/order-approved-webhook) payload.\n\n3. Pass the new order ID and the new fulfillment info to the [Create Fulfillment](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ebe24b2e-b153-4401-83bb-6818878c121dslug::create-fulfillment*fallback::https://dev.wix.com/api/rest/wix-ecommerce/order-fulfillments/create-fulfillment) endpoint.\nThe response holds information about the newly created fulfillment and the ID of its associated order.\n","sourceRepo":"git@github.com:wix-private/ecom.git","path":"appendices/docs/example_flows.md"}],"components":{"schemas":{"com.wix.ecom.orders.fulfillments.v1.OrderWithFulfillments":{"type":"object","properties":{"orderId":{"description":"Order ID.","minLength":1,"maxLength":100,"title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fulfillments":{"description":"Fulfillments associated with the order.","title":"fulfillments","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.Fulfillment"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"OrderWithFulfillments","description":""},"com.wix.ecom.orders.fulfillments.v1.Fulfillment":{"type":"object","properties":{"id":{"description":"Fulfillment ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Fulfillment creation date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lineItems":{"description":"Line items being fulfilled.","minItems":0,"maxItems":300,"title":"lineItems","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.FulfillmentLineItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Fulfillment status.\n\nSupported values:\n+ `\"Pending\"`\n+ `\"Accepted\"`\n+ `\"Ready\"`\n+ `\"In_Delivery\"`\n+ `\"Fulfilled\"`","minLength":1,"maxLength":100,"title":"status","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"completed":{"description":"Fulfillment handling complete.","title":"completed","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Fulfillment","description":"for now, this is a sub-object of Orders, so can refer to order line items by id.","oneOf":[{"description":"","summary":"FulfillmentInfo","$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.Fulfillment.FulfillmentInfo"}]},"com.wix.ecom.orders.fulfillments.v1.Fulfillment.FulfillmentInfo":{"type":"object","title":"FulfillmentInfo","properties":{"trackingInfo":{"description":"Tracking info.","$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.FulfillmentTrackingInfo","summary":"trackingInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"customInfo":{"description":"Custom fulfillment info.","$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.CustomFulfillmentInfo","summary":"customInfo","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":""},"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.ecom.orders.fulfillments.v1.FulfillmentLineItem":{"type":"object","properties":{"id":{"description":"Line item ID (mirrors the ID of the order line item).","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"quantity":{"description":"Line item quantity.\n* If this property isn't passed on creation, it defaults to the number of items not already linked to a fulfillment.\n* If 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 is returned.\n\nMin: `1`\nMax: `100000`","minimum":1,"maximum":100000,"title":"quantity","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FulfillmentLineItem","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"com.wix.ecom.orders.fulfillments.v1.FulfillmentTrackingInfo":{"type":"object","properties":{"trackingNumber":{"description":"Shipping/delivery tracking number.","minLength":1,"maxLength":100,"title":"trackingNumber","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"shippingProvider":{"description":"Shipping provider. Using one of the following shipping providers will allow for auto-filling 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. Auto-filled if a predefined shipping provider is used, 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":""},"com.wix.ecom.orders.fulfillments.v1.CustomFulfillmentInfo":{"type":"object","properties":{"fieldsData":{"description":"Custom fulfillment info in key:value form.","minItems":0,"maxItems":100,"title":"fieldsData","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"type":"string"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CustomFulfillmentInfo","description":""},"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.FulfillmentCreated":{"type":"object","properties":{"orderId":{"description":"Order ID (auto generated upon order creation).","format":"GUID","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fulfillmentId":{"description":"ID of the newly created fulfillment.","format":"GUID","title":"fulfillmentId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateCreated":{"description":"Fulfillment creation date and time.","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"}},"fulfillmentStatus":{"description":"Order fulfillment status.","title":"fulfillmentStatus","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"trackingInfo":{"description":"Fulfillment tracking information.","$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentTrackingInfo","summary":"trackingInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FulfillmentCreated","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"]},"wix.orders.api.v2.FulfillmentStatus":{"type":"string","description":"","title":"FulfillmentStatus","enum":["NOT_FULFILLED","FULFILLED","CANCELED","PARTIALLY_FULFILLED"]},"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.FulfillmentUpdated":{"type":"object","properties":{"orderId":{"description":"Order ID (auto generated upon order creation).","format":"GUID","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fulfillmentId":{"description":"ID of the updated fulfillment.","format":"GUID","title":"fulfillmentId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"trackingInfo":{"description":"Fulfillment tracking information.","$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentTrackingInfo","summary":"trackingInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FulfillmentUpdated","description":""},"wix.orders.api.v2.FulfillmentDeleted":{"type":"object","properties":{"orderId":{"description":"Order ID (auto generated upon order creation).","format":"GUID","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fulfillmentId":{"description":"ID of the deleted fulfillment.","format":"GUID","title":"fulfillmentId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fulfillmentStatus":{"description":"Order fulfillment status.","title":"fulfillmentStatus","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FulfillmentDeleted","description":""},"com.wix.ecom.orders.fulfillments.v1.ListFulfillmentsForSingleOrderRequest":{"type":"object","properties":{"orderId":{"description":"Order ID for which to retrieve fulfillments.","minLength":1,"maxLength":100,"title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListFulfillmentsForSingleOrderRequest","description":""},"com.wix.ecom.orders.fulfillments.v1.ListFulfillmentsForSingleOrderResponse":{"type":"object","properties":{"orderWithFulfillments":{"description":"List of fulfillments associated with the order.","$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.OrderWithFulfillments","summary":"orderWithFulfillments","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListFulfillmentsForSingleOrderResponse","description":""},"com.wix.ecom.orders.fulfillments.v1.ListFulfillmentsForMultipleOrdersRequest":{"type":"object","properties":{"orderIds":{"description":"List of order IDs for which to retrieve fulfillments.","minItems":1,"maxItems":100,"title":"orderIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListFulfillmentsForMultipleOrdersRequest","description":""},"com.wix.ecom.orders.fulfillments.v1.ListFulfillmentsForMultipleOrdersResponse":{"type":"object","properties":{"ordersWithFulfillments":{"description":"List of order IDs and their associated fulfillments.","title":"ordersWithFulfillments","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.OrderWithFulfillments"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListFulfillmentsForMultipleOrdersResponse","description":""},"com.wix.ecom.orders.fulfillments.v1.CreateFulfillmentRequest":{"type":"object","properties":{"orderId":{"description":"Order ID.","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fulfillment":{"description":"Fulfillment info.","$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.Fulfillment","summary":"fulfillment","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateFulfillmentRequest","description":""},"com.wix.ecom.orders.fulfillments.v1.CreateFulfillmentResponse":{"type":"object","properties":{"orderWithFulfillments":{"description":"Order ID and the orders' fulfillments.","$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.OrderWithFulfillments","summary":"orderWithFulfillments","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fulfillmentId":{"description":"ID of created fulfillment.","title":"fulfillmentId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateFulfillmentResponse","description":""},"com.wix.ecom.orders.fulfillments.v1.UpdateFulfillmentRequest":{"type":"object","properties":{"orderId":{"description":"Order ID.","title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fulfillment":{"description":"Fulfillment info to update.","$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.Fulfillment","summary":"fulfillment","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateFulfillmentRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"description":"","title":"paths","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FieldMask","description":""},"com.wix.ecom.orders.fulfillments.v1.UpdateFulfillmentResponse":{"type":"object","properties":{"orderWithFulfillments":{"description":"Order ID and the orders' associated fulfillments after update.","$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.OrderWithFulfillments","summary":"orderWithFulfillments","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateFulfillmentResponse","description":""},"com.wix.ecom.orders.fulfillments.v1.DeleteFulfillmentRequest":{"type":"object","properties":{"orderId":{"description":"Order ID.","minLength":1,"maxLength":100,"title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fulfillmentId":{"description":"ID of the fulfillment to delete.","format":"GUID","title":"fulfillmentId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteFulfillmentRequest","description":""},"com.wix.ecom.orders.fulfillments.v1.DeleteFulfillmentResponse":{"type":"object","properties":{"orderWithFulfillments":{"description":"Order ID and the order's associated fulfillments after deletion.","$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.OrderWithFulfillments","summary":"orderWithFulfillments","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteFulfillmentResponse","description":""},"com.wix.ecom.orders.fulfillments.v1.BulkCreateFulfillmentRequest":{"type":"object","properties":{"ordersWithFulfillments":{"description":"List of order IDs and their associated fulfillments.","minItems":1,"maxItems":100,"title":"ordersWithFulfillments","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.BulkCreateOrderWithFulfillments"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateFulfillmentRequest","description":""},"com.wix.ecom.orders.fulfillments.v1.BulkCreateOrderWithFulfillments":{"type":"object","properties":{"orderId":{"description":"Order ID.","minLength":1,"maxLength":100,"title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fulfillments":{"description":"Fulfillments associated with the order.","minItems":1,"title":"fulfillments","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.Fulfillment"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateOrderWithFulfillments","description":""},"com.wix.ecom.orders.fulfillments.v1.BulkCreateFulfillmentResponse":{"type":"object","properties":{"results":{"description":"Items updated by bulk action.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.BulkOrderFulfillmentsResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateFulfillmentResponse","description":""},"com.wix.ecom.orders.fulfillments.v1.BulkOrderFulfillmentsResult":{"type":"object","properties":{"itemMetadata":{"description":"Item metadata.","$ref":"#/components/schemas/wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ordersWithFulfillments":{"description":"","$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.OrderWithFulfillments","summary":"ordersWithFulfillments","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkOrderFulfillmentsResult","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":""},"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 in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z","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"}},"restoreInfo":{"description":"Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity","$ref":"#/components/schemas/wix.common.domainevents.RestoreInfo","summary":"restoreInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.RestoreInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreInfo","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":"Fulfillments","description":"Create and manage eCommerce order fulfillments","fqdn":"wix.ecom.v1.fulfillments"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Order Fulfillments\n\nAn order fulfillment refers to the process of preparing and delivering orders to customers. This process usually involves receiving orders, picking the products from inventory, packing them securely, providing tracking information, and shipping them to the customer's address.\n\nA fulfillment object contains information about an order's shipping provider, tracking details, and the line items associated with the fulfillment.\n\nWith the Order Fulfillments API you can:\n\n* Create fulfillments for [some or all items in an order](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ebe24b2e-b153-4401-83bb-6818878c121dslug::create-fulfillment*fallback::https://dev.wix.com/api/rest/wix-ecommerce/order-fulfillments/create-fulfillment).\n* Create fulfillments for [multiple orders at once](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ebe24b2e-b153-4401-83bb-6818878c121dslug::bulk-create-fulfillments*fallback::https://dev.wix.com/api/rest/wix-ecommerce/order-fulfillments/bulk-create-fulfillments).\n* Retrieve fulfillments associated with [one](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ebe24b2e-b153-4401-83bb-6818878c121dslug::list-fulfillments-for-single-order*fallback::https://dev.wix.com/api/rest/wix-ecommerce/order-fulfillments/list-fulfillments-for-single-order) or [many](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ebe24b2e-b153-4401-83bb-6818878c121dslug::list-fulfillments-for-multiple-orders*fallback::https://dev.wix.com/api/rest/wix-ecommerce/order-fulfillments/list-fulfillments-for-multiple-orders) orders.\n* Listen for [changes made to orders' fulfillments](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ebe24b2e-b153-4401-83bb-6818878c121dslug::order-with-fulfillments-updated*fallback::https://dev.wix.com/api/rest/wix-ecommerce/order-fulfillments/order-with-fulfillments-updated-webhook)."},{"displayName":"Sample Flow","slugifyName":"sample-flow","content":"# Order Fulfillments: Sample Use Cases & Flows\n\nThis article shares a possible use case your app could support, as well as\na sample flow that could support the use case. This can be a helpful jumping\noff point as you plan your app's implementation.\n\n## Create a fulfillment for a new order\n\nYou can use webhooks to listen for when an order is placed, and then create a fulfillment for the new order.\n\n1. Use the [Order Approved Webhook](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::546b2514-6a71-4148-bccf-1fb8d8604792slug::order-approved*fallback::https://dev.wix.com/api/rest/wix-ecommerce/orders/order-approved-webhook) to listen for incoming approved orders.\n2. When a new order comes in, save the order ID. This can be found as the value of the `entityId` or `actionEvent.body.order.id` fields in the [Order Approved Webhook's](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::546b2514-6a71-4148-bccf-1fb8d8604792slug::order-approved*fallback::https://dev.wix.com/api/rest/wix-ecommerce/orders/order-approved-webhook) payload.\n\n3. Pass the new order ID and the new fulfillment info to the [Create Fulfillment](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ebe24b2e-b153-4401-83bb-6818878c121dslug::create-fulfillment*fallback::https://dev.wix.com/api/rest/wix-ecommerce/order-fulfillments/create-fulfillment) endpoint.\nThe response holds information about the newly created fulfillment and the ID of its associated order.\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

Bulk Create Fulfillments

Permission Scopes