Close
logo

Vendor Order Data Pipe

Git RepositoryEdit on Github
Last update: 7 days ago by Francesco de LorenziReading time: 2 min

Jetti, as a marketplace automation platform, drives the creation of purchase orders in the vendor ecommerce stores. There may be instances in which payloads sent to the vendor systems need to be manipulated programmatically by systems owned by the marketplace.

Changes may include modifiying the order reference, adding or removing tags, manipulating dropship provider platform actions or setting a different price for line items and shipping rates.

This can be accomplished with the Vendor Order Data Pipeline available for all Dropship Providers.

The Vendor Order Data Pipeline configuration is available in the Dropship Provider settings page, under the Orders tab.

After ticking the Vendor Order Data Pipeline, you will be able to enter the URL.

Jetti will send a payload containing data related to the current Purchase Order such as:

{
"documents": [],
"dropshipProvider": {
"companyId": 123123,
"externalPaymentStatus": "ignore",
"generatePayloadEndpoint": "https://obfuscated",
"includeCustomerEmail": "companyUnique",
"includeCustomerInvoice": "none",
"includeCustomerPhone": false,
"includePackingSlip": true,
"orderPlatform": "shopify",
"orderStatusCode": null,
"paymentCode": null,
"paymentModule": "enabled",
"platformCustomerExternalId": "",
"platformInvoiceAddress": "customer",
"platformNotes": null,
"platformNotification": "default",
"platformPrice": "purchase",
"platformProducts": "connected",
"platformProperties": "default",
"platformShippingCode": null,
"platformShippingMapping": "default",
"platformShippingPrice": true,
"platformShippingProvider": null,
"platformShippingServiceLevel": null,
"platformStateCode": "none",
"platformTags": [],
"platformTax": "default",
"platformTaxRateId": null,
"setMerchantReference": null,
"shippingType": "customRates",
"useGeneratePayloadEndpoint": true,
"platform_currency": null,
"platform_tax_rate": null,
"users": [
{
"token": "OBFUSCATED"
},
{
"token": "OBFUSCATED"
},
{
"token": "OBFUSCATED"
}
]
},
"invoiceAddress": {
"isCompany": false,
"firstName": "Francesco",
"lastName": "de Lorenzi",
"name": null,
"addressLineOne": "Via AAA 123",
"addressLineTwo": "",
"city": "Bari",
"state": "Bari",
"country": "IT",
"zip": "70127"
},
"sale": {
"billingName": null,
"billingAddressLineOne": "Via AAA 123",
"billingAddressLineTwo": "",
"billingCity": "Bari",
"billingState": "Bari",
"billingCountry": "IT",
"billingZip": "70127",
"id": 123123,
"companyId": 123123,
"warehouseId": 123123,
"channelId": 123123,
"reference": "10023",
"externalId": null,
"dateOrdered": "2022-02-28T13:50:38.963Z",
"tags": [
"dropship",
"cloned"
],
"stateTaxLocation": null,
"countyTaxLocation": null,
"cityTaxLocation": null,
"billingFirstName": "Francesco",
"billingLastName": "de Lorenzi",
"taxIncluded": true,
"taxShipping": true,
"stateTaxRate": null,
"cityTaxRate": null,
"countyTaxRate": null,
"districtTaxRate": null,
"customer": {
"email": "francesco@example.com",
"firstName": "Francesco",
"lastName": "de Lorenzi",
"id": 1770315,
"companyId": 123123,
"phone": null
},
"channel": {
"id": 123123,
"priceListId": 3172,
"companyId": 123123,
"dropshipTags": [],
"includeSaleTags": false,
"purchasePrefix": null,
"price_list": {
"id": 3172,
"currencyId": 3106,
"currency": {
"id": 3106,
"iso": "USD",
"exchangeRate": 1,
"roundUp": false
}
}
}
},
"shippingAddress": {
"firstName": "Francesco1635",
"lastName": "de Lorenzi",
"name": null,
"addressLineOne": "Via AAAAAAA, 13/E",
"addressLineTwo": "",
"city": "Bari S.Spirito",
"state": "Bari",
"country": "IT",
"zip": "70127"
},
"reference": "#PO10023-03",
"tags": [
"dropship",
"#PO10023-03",
"Shopi-Inter"
],
"actions": [
{
"name": "marketplace",
"uri": "test123"
},
{
"name": "order_language",
"uri": "PT"
}
],
"mappedItems": [
{
"price": 0,
"subtotal": 0,
"id": 2684937,
"companyId": 123123,
"variantId": 13370870,
"saleItemId": null,
"name": "Shoes",
"quantity": 1,
"inventoryProcessed": 0,
"quantityInvoiced": 0,
"properties": null,
"taxable": false,
"sale_item": null,
"variant": {
"images": [],
"id": 13370870,
"companyId": 123123,
"sku": "shoes123-41010541396174",
"barcode": null,
"vendorSku": null,
"grams": 0,
"taxable": true,
"inventory_feed_variants": [
{
"images": [],
"costPrice": 0,
"retailPrice": 0,
"compareAtPrice": 0,
"id": 731299550,
"companyId": 123123,
"variantId": 13370870,
"externalId": "41010541396174",
"externalGroupId": "6967039099086",
"options": [
{
"name": "Title",
"value": "Default Title",
"position": 1
}
],
"vendorSku": "shoes123",
"originalSku": "shoes123",
"inventory_feed": {
"id": 12814,
"companyId": 123123,
"dropshipProviderId": 18453,
"purpose": "publishing",
"resourceType": "shopify"
}
}
],
"option_values": [
{
"id": 40048061,
"variantValue": "Large",
"option": {
"id": 5546147,
"name": "Title"
}
}
]
},
"inventoryFeedVariant": {
"images": [],
"costPrice": 0,
"retailPrice": 0,
"compareAtPrice": 0,
"id": 731299550,
"companyId": 123123,
"variantId": 13370870,
"externalId": "41010541396174",
"externalGroupId": "6967039099086",
"options": [
{
"name": "Title",
"value": "Default Title",
"position": 1
}
],
"vendorSku": "shoes123",
"originalSku": "shoes123",
"inventory_feed": {
"id": 12814,
"companyId": 123123,
"dropshipProviderId": 18453,
"purpose": "publishing",
"resourceType": "shopify"
}
},
"vendorSku": "shoes123",
"platformPrice": {
"price": 0,
"subtotal": 0
},
"platformOptionValues": [
{
"name": "Title",
"value": "Large"
}
],
"taxLines": {
"stateTaxRate": {
"title": "State tax rate",
"price": 0,
"rate": 0
},
"cityTaxRate": {
"title": "City tax rate",
"price": 0,
"rate": 0
},
"countyTaxRate": {
"title": "County tax rate",
"price": 0,
"rate": 0
},
"districtTaxRate": {
"title": "District tax rate",
"price": 0,
"rate": 0
}
}
},
{
"price": 9,
"subtotal": 9,
"id": 2684936,
"companyId": 123123,
"variantId": 9126263,
"saleItemId": 8222450,
"name": "TShirt",
"quantity": 1,
"inventoryProcessed": 0,
"quantityInvoiced": 0,
"properties": [],
"taxable": true,
"sale_item": {
"price": 15,
"subtotal": 15,
"id": 8222450,
"companyId": 123123,
"quantity": 1,
"taxable": true
},
"variant": {
"images": [
"https://cdn.shopify.com/path/to/image.jpg"
],
"id": 9126263,
"companyId": 123123,
"sku": "39429534351566",
"barcode": "",
"vendorSku": null,
"grams": 453.59,
"taxable": true,
"inventory_feed_variants": [
{
"images": [],
"costPrice": 0,
"retailPrice": 0,
"compareAtPrice": 0,
"id": 628554428,
"companyId": 123123,
"variantId": 9126263,
"externalId": "39429534351566",
"externalGroupId": "6583357407438",
"options": [
{
"name": "Title",
"value": "Default Title",
"position": 1
}
],
"vendorSku": "asd123",
"originalSku": "asd123",
"inventory_feed": {
"id": 12814,
"companyId": 123123,
"dropshipProviderId": 18453,
"purpose": "publishing",
"resourceType": "shopify"
}
}
],
"option_values": [
{
"id": 32929546,
"variantValue": "Default Title",
"option": {
"id": 3263231,
"name": "Title"
}
}
]
},
"inventoryFeedVariant": {
"images": [],
"costPrice": 0,
"retailPrice": 0,
"compareAtPrice": 0,
"id": 628554428,
"companyId": 123123,
"variantId": 9126263,
"externalId": "39429534351566",
"externalGroupId": "6583357407438",
"options": [
{
"name": "Title",
"value": "Default Title",
"position": 1
}
],
"vendorSku": "asd123",
"originalSku": "asd123",
"inventory_feed": {
"id": 12814,
"companyId": 123123,
"dropshipProviderId": 18453,
"purpose": "publishing",
"resourceType": "shopify"
}
},
"vendorSku": "asd123",
"platformPrice": {
"price": 9,
"subtotal": 9
},
"platformOptionValues": [
{
"name": "Title",
"value": "Default Title"
}
],
"taxLines": {
"stateTaxRate": {
"title": "State tax rate",
"price": 0,
"rate": 0
},
"cityTaxRate": {
"title": "City tax rate",
"price": 0,
"rate": 0
},
"countyTaxRate": {
"title": "County tax rate",
"price": 0,
"rate": 0
},
"districtTaxRate": {
"title": "District tax rate",
"price": 0,
"rate": 0
}
}
}
],
"mappedRates": [
{
"provider": "STANDARD",
"serviceLevel": "STD",
"code": "FIXED10",
"mappedRates": 10,
"price": 10,
"tax": {
"stateTaxRate": {
"title": "State tax rate",
"price": 0,
"rate": 0
},
"cityTaxRate": {
"title": "City tax rate",
"price": 0,
"rate": 0
},
"countyTaxRate": {
"title": "County tax rate",
"price": 0,
"rate": 0
},
"districtTaxRate": {
"title": "District tax rate",
"price": 0,
"rate": 0
}
},
"title": "STANDARD - STD"
}
]
}

Jetti expects to receive a response body similar to the JSON object shown below

{
"reference": "12345",
"tags": ["new-tag"],
"actions": [{
"name": "account-id",
"uri": "my-account-id"
}],
"mappedItems": [{
"id": 2123123,
"platformPrice": {
"price": 20,
"subtotal": 200
}
}],
"mappedRates": [{
"title": "title",
"provider": "provider",
"serviceLevel": "serviceLevel",
"code": "code",
"price": 10,
"tax": {
"stateTaxRate": {
"title": "State tax rate",
"price": 0,
"rate": 0
},
"cityTaxRate": {
"title": "State tax rate",
"price": 0,
"rate": 0
},
"countyTaxRate": {
"title": "State tax rate",
"price": 0,
"rate": 0
},
"districtTaxRate": {
"title": "State tax rate",
"price": 0,
"rate": 0
}
}
}]
}
πŸ” API Pipeline β€” Previous
Shipping Service Levels Pipe
Next β€” πŸ”ƒ 3PL
Marketplace Based 3PL