Close
logo

Fulfillments webhook

Git RepositoryEdit on Github
Last update: 6 months ago by Francesco de LorenziReading time: 2 min

Fulfillment notification updates can also be sent to your custom channel in real time. Although you can listed to new shipments through our regular webhooks, we recommend using the webhook under the custom channel setup page. This webhook will bundle additional details on the shipments, such as more information on the line items which would otherwise take additional API lookups to fetch.

The JSON payload sent to the endpoint is shown below:

{
"instance": {
"labelUris": [],
"packingHeight": 13.3,
"packingWidth": 11.5,
"packingDepth": 2.4,
"trackingCompany": "ABC",
"trackingNumber": "123",
"provider": null,
"serviceLevel": null,
"price": 0,
"grams": 0,
"id": 5824,
"companyId": 18683,
"userId": null,
"purchaseId": 12448,
"saleId": 12806,
"manifestId": null,
"carrierPickupId": null,
"purchaseImportExternalId": null,
"source": "sale",
"importSource": "manual",
"shipmentRouting": "customer",
"inventoryStatus": "shipped",
"channelError": null,
"reference": "10001-01-01",
"externalId": null,
"vendorExternalId": null,
"printedLabel": false,
"printedLabelAt": null,
"requiresShippingApproval": "notRequired",
"distanceUnit": "in",
"weightUnit": "g",
"totalWeight": 0,
"files": null,
"labelFiles": null,
"channelAttempts": 0,
"channelNotification": "trigger",
"labelProblem": null,
"serviceLevelTerms": null,
"days": null,
"durationTerms": null,
"quoteId": null,
"trackingStatus": null,
"trackingStatusDate": null,
"trackingStatusDetails": null,
"shippoLabelIds": null,
"labelUrl": null,
"labelFileFormat": null,
"trackingUrl": null,
"commercialInvoiceUrl": null,
"labelError": null,
"labelRefund": false,
"tags": null,
"aftershipId": null,
"createdAt": "2021-11-04T09:44:48.149Z",
"updatedAt": "2021-11-04T09:44:48.240Z",
"muteError": false,
"adminNotes": null,
"intercomMessageId": null,
"purchase": {
"billingFullName": "",
"externalReference": "10001-01",
"isDropship": false,
"shippingFullName": "",
"displayName": "10001-01",
"total": 0,
"subtotal": 0,
"discounts": 0,
"tax": 0,
"combinedTaxRate": "0.0000",
"id": 12448,
"dropshipProviderId": 17813,
"reference": "10001-01",
"vendorReference": null,
"vendorReceivedStatus": "notSent",
"vendorReceivedId": null,
"vendorReceivedReference": null,
"dropship_provider": {
"name": "17320",
"id": 17813
}
}
},
"fulfillmentItems": [{
"id": 6448,
"companyId": 18683,
"dropshipmentId": 5824,
"saleItemId": 18277,
"purchaseItemId": 23317,
"purchaseImportExternalId": null,
"source": "sale_item",
"quantity": 10,
"createdAt": "2021-11-04T09:44:48.164Z",
"updatedAt": "2021-11-04T09:44:48.164Z",
"sale_item": {
"allocation": 0,
"inventoryStatus": "fulfilled",
"invoiceStatus": "notInvoiced",
"isComponent": false,
"returnStatus": "notReturned",
"displayName": "HACK",
"commercialInvoicePrice": null,
"tax": 0,
"price": 10,
"subtotal": 100,
"id": 18277,
"saleId": 12806,
"dropshipProviderId": null,
"warehouseId": null,
"bundleSaleItemId": null,
"cloneSaleItemId": null,
"externalId": null,
"externalVariantId": null,
"orderRouting": "automated",
"manualRouting": null,
"quantityCancelled": 0,
"quantityRefunded": 0,
"discounts": null,
"discount": null,
"channelPrice": null,
"channelCompareAtPrice": null,
"costPrice": null,
"location": null,
"preventDuplicates": false,
"unallocated": false,
"companyId": 18683,
"variantId": 30265,
"locked": false,
"name": "HACK",
"notes": null,
"quantity": 10,
"taxable": false,
"taxRate": null,
"inventoryProcessed": 10,
"quantityInvoiced": 0,
"quantityReturned": 0,
"bundleQuantity": 0,
"isBundle": false,
"properties": null,
"createdAt": "2021-11-04T09:44:45.099Z",
"updatedAt": "2021-11-04T09:44:48.226Z"
}
}],
"sale": {
"billingFullName": "sale billing-first-name",
"shippingFullName": "sale first-name sale last-name",
"total": 0,
"subtotal": 0,
"discounts": 0,
"tax": 0,
"combinedTaxRate": "0.0000",
"billingName": "sale billing-name",
"billingAddressLineOne": "sale billing-address-line-one",
"billingAddressLineTwo": "sale billing-address-line-two",
"billingCity": "sale billing-city",
"billingState": "sale billing-state",
"billingCountry": "sale billing-country",
"billingZip": "sale billing-zip",
"shippingName": "sale shipping-name",
"shippingAddressLineOne": "sale shipping-address-line-one",
"shippingAddressLineTwo": "sale shipping-address-line-two",
"shippingCity": "Beverly Hills",
"shippingState": "California",
"shippingCountry": "US",
"shippingZip": "90210",
"receiverName": null,
"receiverAddressLineOne": null,
"receiverAddressLineTwo": null,
"receiverCity": null,
"receiverState": null,
"receiverCountry": null,
"receiverZip": null,
"id": 12806,
"companyId": 18683,
"userId": 22197,
"priceListId": 18761,
"channelId": 20579,
"warehouseId": 18852,
"customerId": 12485,
"saleDiscountCodeId": null,
"saleId": null,
"resellerId": null,
"cloneReason": null,
"externalId": "sale-external-id",
"lastPurchaseReference": 1,
"lastSaleReturnReference": 0,
"lastFulfillmentReference": 0,
"status": "pending",
"internalNotes": null,
"inventoryStatus": "fulfilled",
"cancelReason": null,
"channelCancelledAt": null,
"shipstationId": null,
"paid": null,
"dropshipProblems": [],
"resellerStripeChargeId": null,
"resellerPayee": "reseller",
"adjustmentReasonId": null,
"reference": "10001",
"locked": false,
"finalized": true,
"cancelled": false,
"cancelledAt": null,
"dateOrdered": "2021-11-04T09:44:44.762Z",
"taxCalculation": "default",
"taxShipping": true,
"taxIncluded": false,
"weight": 0,
"quantity": 0,
"stateTaxRate": null,
"cityTaxRate": null,
"countyTaxRate": null,
"districtTaxRate": null,
"stateTaxLocation": null,
"cityTaxLocation": null,
"countyTaxLocation": null,
"paymentStatus": "notPaid",
"invoiceStatus": "notInvoiced",
"returnStatus": "notReturned",
"cancellationStatus": "none",
"notes": null,
"customerReference": null,
"tags": ["dropship"],
"billingFirstName": "sale billing-first-name",
"billingLastName": null,
"shippingFirstName": "sale first-name",
"shippingLastName": "sale last-name",
"invalidShippingAddress": false,
"shippingAddressMessage": null,
"invalidBillingAddress": false,
"billingAddressMessage": null,
"createdAt": "2021-11-04T09:44:44.762Z",
"updatedAt": "2021-11-04T09:44:47.940Z",
"muteError": false,
"adminNotes": null,
"intercomMessageId": null,
"channel": {
"hash": "XXXX",
"shipstationUrl": "http://localhost:5000/api/channels/20579/shipstation.xml",
"displayName": "Custom",
"freeShippingThreshold": null,
"id": 20579,
"companyId": 18683,
"priceListId": 18761,
"warehouseId": 18852,
"dropshipProviderId": null,
"purchaseStatusId": null,
"taxRateId": null,
"addressValidationFinalize": false,
"requirePhoneNumber": false,
"name": "Custom",
"parentChannel": "custom",
"warehouseSync": "default",
"imageSync": "bidirectional",
"sendShippingNotification": true,
"orderRouting": "automated",
"manualSaleItemRouting": "ignore",
"dropshipRouting": "default",
"useOrderRoutingEndpoint": false,
"orderRoutingEndpoint": null,
"dropshipTags": [],
"dropshipAllowTags": [],
"dropshipRoutingTags": null,
"skipTags": [],
"skipVariantTags": [],
"skipLineItems": [],
"includeSaleTags": false,
"connectedAt": null,
"automaticallyCancelSales": true,
"importPaymentStatus": "paid",
"salePrefix": null,
"automaticallyFinalizeSales": true,
"unallocatedDropship": "pause",
"purchasePrefix": null,
"syncAddressUpdates": true,
"syncPricing": true,
"syncCostPrices": false,
"inventorySync": "all",
"disableVariantInventorySync": null,
"includeBackorderQuantity": true,
"hideWhenNoCostPrice": null,
"syncImages": true,
"publishProducts": true,
"publishTags": "all",
"publishAdditionalTags": ["jetti"],
"publishMetaFields": null,
"saleCustomFieldsScope": "none",
"saleCustomFields": null,
"automaticallyPublish": true,
"publishProductsWithoutPrice": true,
"unpublishNoInventory": false,
"taxShipping": true,
"taxCalculation": "channel",
"maxShippingCost": null,
"maxShippingCostThreshold": null,
"freeShippingOverride": null,
"freeShippingName": null,
"freeShippingCode": null,
"enableFreeShippingCountries": false,
"freeShippingCountries": null,
"freeShippingScope": "all",
"freeShippingOriginCountries": null,
"taxIncluded": true,
"productsImportedAt": null,
"collectionEndpoint": null,
"addressValidationEndpoint": null,
"syncWeightZero": false,
"weightUnit": "g",
"variantLogging": false,
"saleLogging": false,
"saleLoggingEmail": "none",
"rateLogging": false,
"importFromFeed": null,
"connectToFeed": null,
"forceConnectToFeed": false,
"exportToShipstation": null,
"shipstationUsername": null,
"shipstationPassword": null,
"shipstationTags": null,
"shipstationConnectedAt": null,
"pdfLegal": null,
"importProductsSeconds": null,
"requireVendorName": null,
"checkoutString": null,
"blendedPreference": "inhouse",
"routingPriorityOne": "inStock",
"routingPriorityTwo": "none",
"routingPriorityThree": "none",
"noRatesError": false,
"allocatedShipments": "allow",
"syncQuickbookSalesAutomatically": null,
"unassignedSaleItems": "include",
"splitShipping": "full",
"oversellingPrevention": "disabled",
"allocateDraftSales": "enabled",
"inventoryFeedRemoved": "all",
"inventoryFeedUnpublish": "none",
"aftershipError": "skip",
"saleMetaFields": "none",
"saleMetaFieldFilter": null,
"taxId": null,
"shippingInvoiceTemplate": null,
"phone": null,
"email": null,
"variantImportScope": "product",
"negativeStock": "enabled",
"negativeStockLevel": 0,
"maximumExpectedShipping": "disabled",
"maximumExpectedShippingDuration": 0,
"createdAt": "2021-11-04T09:44:44.437Z",
"updatedAt": "2021-11-04T09:44:44.437Z"
}
}
}
πŸ’» Custom channel β€” Previous
Setup
Next β€” πŸ’» Custom channel
Variant Acknowledgement