Close
logo

Packing Slip Pipe

Git RepositoryEdit on Github
Last update: 2 years ago by luigi mangaReading time: 2 min

Onport is able to dynamically generate invoices and packing slips and makes them available in the UI as well as from the API. However, marketplaces may feel the need to generate custom packing slips, by customizing the content and look&feel.

This is possible with Onport's Packing Slip Pipe, which can be configured via the Setup => Packing Slip section as shown in the screenshot below:

The payload sent by Onport is:

{
"order": {
"billingFullName": "sale billing-first-name",
"shippingFullName": "sale first-name sale last-name",
"total": 0,
"subtotal": 0,
"discounts": 10,
"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": 330,
"companyId": 376,
"userId": 376,
"priceListId": 376,
"channelId": 408,
"warehouseId": 376,
"customerId": 328,
"saleDiscountCodeId": null,
"saleId": null,
"resellerId": null,
"cloneReason": null,
"externalId": null,
"lastPurchaseReference": 0,
"lastSaleReturnReference": 0,
"lastFulfillmentReference": 0,
"status": "pending",
"internalNotes": "Internal notes",
"inventoryStatus": "notFulfilled",
"cancelReason": null,
"channelCancelledAt": null,
"shipstationId": null,
"paid": null,
"dropshipProblems": null,
"resellerStripeChargeId": null,
"resellerPayee": "reseller",
"adjustmentReasonId": null,
"reference": "10001",
"locked": false,
"finalized": true,
"cancelled": false,
"cancelledAt": null,
"dateOrdered": "2021-11-02T09:13:09.755Z",
"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": "Order notes",
"customerReference": null,
"tags": null,
"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-02T09:13:09.756Z",
"updatedAt": "2021-11-02T09:13:09.756Z",
"muteError": false,
"adminNotes": null,
"intercomMessageId": null
},
"lineItems": [{
"price": 10,
"subtotal": 100,
"id": 351,
"companyId": 376,
"saleId": 330,
"variantId": 403,
"quantity": 10,
"properties": null,
"inventoryProcessed": 0,
"quantityInvoiced": 0,
"quantityReturned": 0,
"quantityCancelled": 0,
"variant": {
"imagesMapped": [],
"images": [],
"displayName": "w2dg13eun6r",
"costPrice": 0,
"commissionRate": 0,
"id": 403,
"vendorId": 350,
"dropshipProviderId": null,
"dropshipProviderAddressId": null,
"productId": 363,
"sku": "w2dg13eun6r",
"name": "Default name",
"grams": 1000,
"vendorSku": null,
"tags": null,
"taxable": true,
"barcode": null,
"hsCode": null,
"countryOfOrigin": null,
"product": {
"id": 363,
"name": "My item l7ztltdvio8"
},
"vendor": {
"name": "363",
"id": 350
},
"option_values": []
}
}],
"shippingRates": [{
"price": 10,
"id": 19,
"serviceLevel": "Test"
}]
}

Onport expects the following response:

{"url":"https://www.domain.com/path/to/csv.pdf"}
๐Ÿ” API Pipeline โ€” Previous
Order Splitting Pipe
Next โ€” ๐Ÿ” API Pipeline
Price Uplift Pipe