{"id":"efaa54ba-3e8c-4938-9277-f3c2533571e4","createdDate":"2024-01-17T09:53:12.105Z","updatedDate":"2024-01-17T09:53:12.105Z","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"}}],"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","permissions":["ECOM.READ_FULFILLMENTS"],"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"BETA"},{"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","permissions":["ECOM.READ_FULFILLMENTS"],"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"BETA"},{"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"}},{"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":{"title":"orderIds","description":"List of order IDs for which to retrieve fulfillments.","minItems":1,"maxItems":100,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["orderIds"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","errors":[],"exposure":"PUBLIC","permissions":["ECOM.READ_FULFILLMENTS"],"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"BETA"},{"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","permissions":["ECOM.READ_FULFILLMENTS"],"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"BETA"},{"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"}},{"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"}}],"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":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.Fulfillment","summary":"fulfillment","description":"Fulfillment info.","x-wix-docs":{"exposure":"PUBLIC"}}},"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":"BETA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.fulfillments","serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","domainEvent":"UPDATED","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","errors":[],"exposure":"PUBLIC","permissions":["ECOM.MODIFY_FULFILLMENTS"],"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"BETA"},{"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":"BETA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.fulfillments","serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","domainEvent":"UPDATED","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","errors":[],"exposure":"PUBLIC","permissions":["ECOM.MODIFY_FULFILLMENTS"],"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"BETA"},{"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"}},{"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`.\n\n> **Note:** Updating line item IDs or fulfilled quantities is not allowed. To update line item IDs or quantities, delete the fulfillment and create it again.","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"}}],"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":{"title":"orderId","description":"Order ID.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillment":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.Fulfillment","summary":"fulfillment","description":"Fulfillment info to update.","x-wix-docs":{"exposure":"PUBLIC"}},"fieldMask":{"title":"fieldMask","description":"Set of fields to update. Fields that aren't included in `fieldMask.paths` are ignored.","$ref":"#/components/schemas/google.protobuf.FieldMask","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["orderId","fulfillment.id"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Fulfillments Updated","description":"","permissions":["ECOM.READ_FULFILLMENTS"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.fulfillments","serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","domainEvent":"UPDATED","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","errors":[],"exposure":"PUBLIC","permissions":["ECOM.MODIFY_FULFILLMENTS"],"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"BETA"},{"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":"BETA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.fulfillments","serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","domainEvent":"UPDATED","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","errors":[],"exposure":"PUBLIC","permissions":["ECOM.MODIFY_FULFILLMENTS"],"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"BETA"},{"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"}},{"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"}},{"in":"path","schema":{"type":"string"},"required":true,"name":"fulfillmentId","description":"ID of the fulfillment to delete.","x-wix-docs":{"exposure":"PUBLIC"}}],"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":"BETA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.fulfillments","serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","domainEvent":"UPDATED","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","errors":[],"exposure":"PUBLIC","permissions":["ECOM.MODIFY_FULFILLMENTS"],"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"BETA"},{"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":"BETA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.fulfillments","serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","domainEvent":"UPDATED","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","errors":[],"exposure":"PUBLIC","permissions":["ECOM.MODIFY_FULFILLMENTS"],"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"BETA"},{"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"}},{"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":{"title":"ordersWithFulfillments","description":"List of order IDs and their associated fulfillments.","minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.BulkCreateOrderWithFulfillments"},"x-wix-docs":{"exposure":"PUBLIC"}}},"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":"BETA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.fulfillments","serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","domainEvent":"UPDATED","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","errors":[],"exposure":"PUBLIC","permissions":["ECOM.MODIFY_FULFILLMENTS"],"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"BETA"},{"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":"BETA","slug":"updated","eventTopic":"domain_events_wix.ecom.v1.fulfillments","serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","domainEvent":"UPDATED","externalPermissionScopes":[],"sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.ecom.orders.fulfillments.v1.Fulfillments","errors":[],"exposure":"PUBLIC","permissions":["ECOM.MODIFY_FULFILLMENTS"],"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-fulfillments-api","serviceArtifactId":"com.wixpress.ecom.order-fulfillments","labels":[{"identifier":"BETA"},{"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"}}],"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":"BETA","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 eCommerce - all permissions","scopeId":"SCOPE.DC-ECOM-MEGA.MANAGE-ECOM"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"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":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]}],"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":{"title":"orderId","description":"Order ID.","minLength":1,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillments":{"title":"fulfillments","description":"Fulfillments associated with the order.","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.Fulfillment"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OrderWithFulfillments","description":""},"com.wix.ecom.orders.fulfillments.v1.Fulfillment":{"type":"object","properties":{"id":{"title":"id","description":"Fulfillment ID.","format":"GUID","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"createdDate":{"title":"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,"type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"lineItems":{"title":"lineItems","description":"Line items being fulfilled.","minItems":0,"maxItems":300,"immutable":true,"type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.FulfillmentLineItem"},"x-wix-docs":{"exposure":"PUBLIC"}},"status":{"title":"status","description":"Fulfillment status.\n\nSupported values:\n+ `\"Pending\"`\n+ `\"Accepted\"`\n+ `\"Ready\"`\n+ `\"In_Delivery\"`\n+ `\"Fulfilled\"`","minLength":1,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"completed":{"title":"completed","description":"Fulfillment handling complete.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"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":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.FulfillmentTrackingInfo","summary":"trackingInfo","description":"Tracking info.","x-wix-docs":{"exposure":"PUBLIC"}},"customInfo":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.CustomFulfillmentInfo","summary":"customInfo","description":"Custom fulfillment info.","x-wix-docs":{"exposure":"PUBLIC"}}}},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StringValue","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"title":"seconds","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"nanos":{"title":"nanos","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Timestamp","description":""},"com.wix.ecom.orders.fulfillments.v1.FulfillmentLineItem":{"type":"object","properties":{"id":{"title":"id","description":"Line item ID (mirrors the ID of the order line item).","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"quantity":{"title":"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,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FulfillmentLineItem","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"title":"value","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Int32Value","description":""},"com.wix.ecom.orders.fulfillments.v1.FulfillmentTrackingInfo":{"type":"object","properties":{"trackingNumber":{"title":"trackingNumber","description":"Shipping/delivery tracking number.","minLength":1,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"shippingProvider":{"title":"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,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"trackingLink":{"title":"trackingLink","description":"Tracking link. Auto-filled if a predefined shipping provider is used, otherwise provided on creation.","minLength":1,"maxLength":2048,"format":"WEB_URL","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FulfillmentTrackingInfo","description":""},"com.wix.ecom.orders.fulfillments.v1.CustomFulfillmentInfo":{"type":"object","properties":{"fieldsData":{"title":"fieldsData","description":"Custom fulfillment info in key:value form.","minItems":0,"maxItems":100,"type":"object","format":"map","properties":{"key:value":{"type":"string","description":"\"key\" of type string, \"value\" of type string","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CustomFulfillmentInfo","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BoolValue","description":""},"com.wix.ecom.orders.side_effects_migration.api.SnapshotMessage":{"type":"object","properties":{"id":{"title":"id","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"opType":{"title":"opType","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SnapshotMessage","description":""},"com.wix.ecom.orders.side_effects_migration.api.IndexingMessage":{"type":"object","properties":{"id":{"title":"id","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"opType":{"title":"opType","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"requiredVersions":{"title":"requiredVersions","description":"","type":"array","items":{"type":"integer"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"IndexingMessage","description":""},"wix.orders.api.v2.FulfillmentCreated":{"type":"object","properties":{"orderId":{"title":"orderId","description":"Order ID (auto generated upon order creation).","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillmentId":{"title":"fulfillmentId","description":"ID of the newly created fulfillment.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"dateCreated":{"title":"dateCreated","description":"Fulfillment creation date and time.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"buyerInfo":{"$ref":"#/components/schemas/wix.orders.api.v2.BuyerInfo","summary":"buyerInfo","description":"Buyer information.","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillmentStatus":{"title":"fulfillmentStatus","description":"Order fulfillment status.","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentStatus","x-wix-docs":{"exposure":"PUBLIC"}},"trackingInfo":{"$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentTrackingInfo","summary":"trackingInfo","description":"Fulfillment tracking information.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FulfillmentCreated","description":""},"wix.orders.api.v2.BuyerInfo":{"type":"object","properties":{"id":{"title":"id","description":"Wix customer ID","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"type":{"title":"type","description":"Deprecated (use identityType instead)","readOnly":true,"type":"string","$ref":"#/components/schemas/wix.orders.api.v2.IdentityType","x-wix-docs":{"exposure":"PUBLIC","deprecated":{}}},"identityType":{"title":"identityType","description":"Customer type","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.IdentityType","x-wix-docs":{"exposure":"PUBLIC"}},"firstName":{"title":"firstName","description":"Customer's first name","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"lastName":{"title":"lastName","description":"Customer's last name","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"phone":{"title":"phone","description":"Customer's phone number","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"email":{"title":"email","description":"Customer's email address","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BuyerInfo","description":"Buyer Info"},"wix.orders.api.v2.IdentityType":{"type":"string","description":"","title":"IdentityType","enum":["UNSPECIFIED_IDENTITY_TYPE","MEMBER","CONTACT"]},"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":{"title":"trackingNumber","description":"Tracking number.","minLength":1,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"shippingProvider":{"title":"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,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"trackingLink":{"title":"trackingLink","description":"Tracking link - autofilled if using a predefined shipping provider, otherwise provided on creation.","minLength":1,"maxLength":2048,"format":"URI","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FulfillmentTrackingInfo","description":""},"wix.orders.api.v2.FulfillmentUpdated":{"type":"object","properties":{"orderId":{"title":"orderId","description":"Order ID (auto generated upon order creation).","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillmentId":{"title":"fulfillmentId","description":"ID of the updated fulfillment.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"trackingInfo":{"$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentTrackingInfo","summary":"trackingInfo","description":"Fulfillment tracking information.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FulfillmentUpdated","description":""},"wix.orders.api.v2.FulfillmentDeleted":{"type":"object","properties":{"orderId":{"title":"orderId","description":"Order ID (auto generated upon order creation).","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillmentId":{"title":"fulfillmentId","description":"ID of the deleted fulfillment.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillmentStatus":{"title":"fulfillmentStatus","description":"Order fulfillment status.","type":"string","$ref":"#/components/schemas/wix.orders.api.v2.FulfillmentStatus","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FulfillmentDeleted","description":""},"com.wix.ecom.orders.fulfillments.v1.ListFulfillmentsForSingleOrderRequest":{"type":"object","properties":{"orderId":{"title":"orderId","description":"Order ID for which to retrieve fulfillments.","minLength":1,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListFulfillmentsForSingleOrderRequest","description":""},"com.wix.ecom.orders.fulfillments.v1.ListFulfillmentsForSingleOrderResponse":{"type":"object","properties":{"orderWithFulfillments":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.OrderWithFulfillments","summary":"orderWithFulfillments","description":"List of fulfillments associated with the order.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListFulfillmentsForSingleOrderResponse","description":""},"com.wix.ecom.orders.fulfillments.v1.ListFulfillmentsForMultipleOrdersRequest":{"type":"object","properties":{"orderIds":{"title":"orderIds","description":"List of order IDs for which to retrieve fulfillments.","minItems":1,"maxItems":100,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListFulfillmentsForMultipleOrdersRequest","description":""},"com.wix.ecom.orders.fulfillments.v1.ListFulfillmentsForMultipleOrdersResponse":{"type":"object","properties":{"ordersWithFulfillments":{"title":"ordersWithFulfillments","description":"List of order IDs and their associated fulfillments.","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.OrderWithFulfillments"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListFulfillmentsForMultipleOrdersResponse","description":""},"com.wix.ecom.orders.fulfillments.v1.CreateFulfillmentRequest":{"type":"object","properties":{"orderId":{"title":"orderId","description":"Order ID.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillment":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.Fulfillment","summary":"fulfillment","description":"Fulfillment info.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateFulfillmentRequest","description":""},"com.wix.ecom.orders.fulfillments.v1.CreateFulfillmentResponse":{"type":"object","properties":{"orderWithFulfillments":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.OrderWithFulfillments","summary":"orderWithFulfillments","description":"Order ID and the orders' fulfillments.","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillmentId":{"title":"fulfillmentId","description":"ID of created fulfillment.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateFulfillmentResponse","description":""},"com.wix.ecom.orders.fulfillments.v1.UpdateFulfillmentRequest":{"type":"object","properties":{"orderId":{"title":"orderId","description":"Order ID.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillment":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.Fulfillment","summary":"fulfillment","description":"Fulfillment info to update.","x-wix-docs":{"exposure":"PUBLIC"}},"fieldMask":{"title":"fieldMask","description":"Set of fields to update. Fields that aren't included in `fieldMask.paths` are ignored.","$ref":"#/components/schemas/google.protobuf.FieldMask","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateFulfillmentRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"title":"paths","description":"","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FieldMask","description":""},"com.wix.ecom.orders.fulfillments.v1.UpdateFulfillmentResponse":{"type":"object","properties":{"orderWithFulfillments":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.OrderWithFulfillments","summary":"orderWithFulfillments","description":"Order ID and the orders' associated fulfillments after update.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateFulfillmentResponse","description":""},"com.wix.ecom.orders.fulfillments.v1.DeleteFulfillmentRequest":{"type":"object","properties":{"orderId":{"title":"orderId","description":"Order ID.","minLength":1,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillmentId":{"title":"fulfillmentId","description":"ID of the fulfillment to delete.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DeleteFulfillmentRequest","description":""},"com.wix.ecom.orders.fulfillments.v1.DeleteFulfillmentResponse":{"type":"object","properties":{"orderWithFulfillments":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.OrderWithFulfillments","summary":"orderWithFulfillments","description":"Order ID and the order's associated fulfillments after deletion.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DeleteFulfillmentResponse","description":""},"com.wix.ecom.orders.fulfillments.v1.BulkCreateFulfillmentRequest":{"type":"object","properties":{"ordersWithFulfillments":{"title":"ordersWithFulfillments","description":"List of order IDs and their associated fulfillments.","minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.BulkCreateOrderWithFulfillments"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkCreateFulfillmentRequest","description":""},"com.wix.ecom.orders.fulfillments.v1.BulkCreateOrderWithFulfillments":{"type":"object","properties":{"orderId":{"title":"orderId","description":"Order ID.","minLength":1,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillments":{"title":"fulfillments","description":"Fulfillments associated with the order.","minItems":1,"type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.Fulfillment"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkCreateOrderWithFulfillments","description":""},"com.wix.ecom.orders.fulfillments.v1.BulkCreateFulfillmentResponse":{"type":"object","properties":{"results":{"title":"results","description":"Items updated by bulk action.","type":"array","items":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.BulkOrderFulfillmentsResult"},"x-wix-docs":{"exposure":"PUBLIC"}},"bulkActionMetadata":{"$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","description":"Bulk action metadata.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkCreateFulfillmentResponse","description":""},"com.wix.ecom.orders.fulfillments.v1.BulkOrderFulfillmentsResult":{"type":"object","properties":{"itemMetadata":{"$ref":"#/components/schemas/wix.common.ItemMetadata","summary":"itemMetadata","description":"Item metadata.","x-wix-docs":{"exposure":"PUBLIC"}},"ordersWithFulfillments":{"$ref":"#/components/schemas/com.wix.ecom.orders.fulfillments.v1.OrderWithFulfillments","summary":"ordersWithFulfillments","description":"","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkOrderFulfillmentsResult","description":""},"wix.common.ItemMetadata":{"type":"object","properties":{"id":{"title":"id","description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"originalIndex":{"title":"originalIndex","description":"Index of the item within the request array. Allows for correlation between request and response items.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"success":{"title":"success","description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"error":{"$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","description":"Details about the error in case of failure.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ItemMetadata","description":""},"wix.api.ApplicationError":{"type":"object","properties":{"code":{"title":"code","description":"Error code.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"description":{"title":"description","description":"Description of the error.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"data":{"title":"data","description":"Data related to the error.","type":"object","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ApplicationError","description":""},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"title":"fields","description":"","type":"object","format":"map","properties":{"key:value":{"type":"object","description":"\"key\" of type string, \"value\" of type object","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"title":"nullValue","description":"","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC"}},"numberValue":{"title":"numberValue","description":"","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"stringValue":{"title":"stringValue","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"boolValue":{"title":"boolValue","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"structValue":{"title":"structValue","description":"","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"listValue":{"title":"listValue","description":"","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"title":"values","description":"","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListValue","description":""},"wix.common.BulkActionMetadata":{"type":"object","properties":{"totalSuccesses":{"title":"totalSuccesses","description":"Number of items that were successfully processed.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"totalFailures":{"title":"totalFailures","description":"Number of items that couldn't be processed.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"undetailedFailures":{"title":"undetailedFailures","description":"Number of failures without details because detailed failure threshold was exceeded.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkActionMetadata","description":""}}},"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}

List Fulfillments For Single Order

Permission Scopes