How to get source doc samples for Pipe17 entities
Sales Order
{ "billingAddress": { "address1": "9999 S Claremont St", "address2": "", "city": "San Mateo", "company": "Test Do Not Ship", "country": "US", "email": "Test@pipe17.com", "firstName": "TestFirstName", "lastName": "TestLastName", "phone": "", "stateOrProvince": "CA", "zipCodeOrPostalCode": "94402" }, "createdAt": "2022-08-01T08:30:49.767Z", "currency": "USD", "customFields": [ { "name": "TestCustomFieldName", "value": "TestCustomFieldValue" } ], "customer": { "extCustomerId": "2208010830", "firstName": "Pipe17", "lastName": "pipe17", "company": "TestCompany" }, "extOrderApiId": "9988770001", "extOrderCreatedAt": "2022-08-01T08:31:32.000Z", "extOrderId": "TestOrder001", "extOrderUpdatedAt": "2022-08-02T09:41:34.000Z", "extOrderUrl": "https://pipe17.com/orders/9988770001", "integration": "bf5ab205c7g5kc00", "lineItems": [ { "itemDiscount": 0, "itemPrice": 30, "itemTax": 5.69, "name": "TestProduct001", "quantity": 2, "requiresShipping": false, "sku": "P0001", "taxable": true, "uniqueId": "11486016962709" }, { "itemDiscount": 0, "itemPrice": 19, "itemTax": 2.19, "name": "TestProduct002", "quantity": 3, "requiresShipping": false, "sku": "P0002", "taxable": true, "uniqueId": "11486016962899" } ], "locationId": "374a1e1804f29f54", "orderDiscount": 0, "orderId": "abe31280071b0999", "orderSource": "Shopify", "orderSourceType": "sales", "orderTax": 7.8, "orgKey": "6fb28a897a96f1bc", "paymentStatus": "paid", "payments": [ { "method": "cash", "status": "succeeded", "amount": 100, "currency": "USD" }, { "method": "creditCard", "kind": "mastercard", "status": "succeeded", "amount": 24.8, "currency": "USD" } ], "requireShippingLabels": false, "routingStatus": "disabled", "shippingAddress": { "address1": "9999 S Claremont St", "address2": "", "city": "San Mateo", "company": "Test Do Not Ship", "country": "US", "email": "Test@pipe17.com", "firstName": "TestFirstName", "lastName": "TestLastName", "phone": "", "stateOrProvince": "CA", "zipCodeOrPostalCode": "94402" }, "shipByDate": "2022-08-02T07:00:00.000Z", "shippingCarrier": "More", "shippingClass": "USPS First Class Mail", "shippingCode": "", "shippingPrice": 0, "status": "readyForFulfillment", "subTotalPrice": 117, "tags": [ "TestTag" ], "totalPrice": 124.8, "updatedAt": "2022-08-03T10:37:49.767Z", "orderType": "" }
Shipping Request
{ "createdAt": "2022-08-02T11:08:19.862Z", "extOrderId": "TestOrder001", "extShipmentId": "TestOrder001", "fulfillmentIntegrationId": "dc59350801a04660", "giftNote": "", "integration": "bf5ab205c7g5kc00", "lineItems": [ { "itemPrice": 30, "name": "TestProduct001", "quantity": 2, "sku": "P0001", "uniqueId": "11486016962709", "shippedQuantity": 1 } ], "locationId": "374a1e1804f29f54", "orderCreateTime": "2022-08-01T08:30:49.767Z", "orderId": "abe31280071b0999", "orderSource": "Shopify", "orderType": "sales", "orgKey": "f3dd289f45b4aa2b", "sentToFulfillmentAt": "2022-08-02T13:09:28.503Z", "shipByDate": "2022-08-05T07:00:00.000Z", "shipmentId": "f8d12a73bf3dae60", "shippingAddress": { "address1": "9999 S Claremont St", "address2": "", "city": "San Mateo", "company": "Test Do Not Ship", "country": "US", "email": "Test@pipe17.com", "firstName": "TestFirstName", "lastName": "TestLastName", "phone": "", "stateOrProvince": "CA", "zipCodeOrPostalCode": "94402" }, "shippingCarrier": "More", "shippingClass": "USPS First Class Mail", "shippingCode": "", "shippingMethodMapping": false, "shippingNote": "", "status": "fulfilled", "tags": [ "TestTag" ], "updatedAt": "2022-08-03T11:37:20.159Z", "version": 1 }
Product
{ "cost": 11.5, "createdAt": "2022-03-22T02:14:28.081Z", "customFields": [ { "name": "test_custitem_1", "value": "test1" } ], "extProductId": "100245", "hideInStore": false, "integration": "79ced3c030a1999", "name": "TestProduct001", "orgKey": "6fb28a897a96999", "parentExtProductId": "100999", "prices": [ { "currency": "USD", "name": "Base Price (MSRP)", "value": 65 }, { "currency": "USD", "name": "Default", "value": 65 } ], "productId": "a825069ade689999", "published": [ { "integrationId": "c638d09b6d1de009", "status": "published", "bufferInventory": 0 } ], "sku": "P0001", "status": "active", "taxable": true, "types": [ "child" ], "upc": "TestUpcCode001", "updatedAt": "2022-04-06T09:48:21.717Z", "variantOptions": [ { "name": "TestOption01", "value": "01" } ], "vendor": "", "weight": 3, "weightUnit": "lb" }
Inventory
{ "available": 80, "committed": 84, "createdAt": "2022-04-14T00:45:58.439Z", "entityId": "c5d80be7b1fa561e", "entityType": "orders", "event": "virtualCommit", "future": 0, "incoming": 0, "integration": "e3401d02794dca63", "inventoryId": "2f698c63314f0a85", "locationId": "fe3ee3c1afca9829", "onHand": 164, "orderId": "c5d80be7b1fa561e", "orderType": "sales", "orgKey": "6fb28a897a96f1bc", "quantity": -1, "sku": "P0001", "updatedAt": "2022-08-14T00:45:58.439Z" }
Purchase Order
{ "billingAddress": { "address1": "", "address2": "", "city": "", "company": "testCompany", "country": "", "email": "Test@pipe17.com", "phone": "", "stateOrProvince": "", "zipCodeOrPostalCode": "" }, "createdAt": "2022-07-12T09:47:59.015Z", "expectedArrivalDate": "2022-07-12T09:47:39.844Z", "extOrderId": "PO-0001", "lineItems": [ { "name": "TestProduct001", "partId": "", "price": 25.05, "quantity": 1, "sku": "P0001", "uniqueId": "283dc8078d9be8e4" } ], "orgKey": "6fb28a897a96f1bc", "purchaseId": "97409cbe9969d20d", "purchaseNotes": "", "referenceNumber": "", "shipByDate": "2022-07-12T09:47:39.844Z", "shippingNotes": "", "shippingService": "", "status": "received", "subTotalPrice": 0, "toAddress": { "address1": "999 S Claremont St", "address2": "", "city": "San Mateo", "country": "US", "stateOrProvince": "CA", "zipCodeOrPostalCode": "94402" }, "toLocationId": "7092644a40f75ca4", "totalPrice": 25.05, "updatedAt": "2022-07-20T09:16:06.188Z", "vendorAddress": { "address1": "testVendorAddress", "address2": "", "city": "NY", "company": "testSupplier", "country": "US", "email": "", "firstName": "TestVendorFirstName", "lastName": "TestVendorLastName", "phone": "", "stateOrProvince": "", "zipCodeOrPostalCode": "94402" } }
Transfer Order
{ "createdAt": "2022-04-06T09:16:30.951Z", "customFields": [ { "name": "TestCustomFieldName", "value": "TestCustomFieldValue" } ], "employeeName": "TestEmployeeName", "expectedShipDate": "2022-04-06T07:00:00.000Z", "extOrderId": "TO0000999", "fromLocationId": "a9eb72a68e8fd784", "incoterms": "EXW", "integration": "79ced3c030a1688d", "lineItems": [ { "name": "TestProduct002", "quantity": 2, "sku": "P0002", "uniqueId": "79342_1", "upc": "" } ], "orgKey": "6fb28a897a96f1bc", "shippingCarrier": "UPS", "shippingService": "", "status": "received", "toAddress": { "address1": "9999 S Claremont St", "address2": "", "city": "San Mateo", "country": "United States", "firstName": "TestFirstName", "lastName": "TestLastName", "phone": "", "stateOrProvince": "CA", "zipCodeOrPostalCode": "94402" }, "toLocationId": "7092644a40f75ca4", "transferId": "dfb07b394ab1b229", "transferOrderDate": "2022-04-06T07:00:00.000Z", "updatedAt": "2022-04-06T09:36:37.151Z" }
Arrival
{ "arrivalId": "b01a6e18c022e6f6", "createdAt": "2022-04-06T09:31:19.373Z", "extArrivalId": "ASN_TO0000999_SN1", "extOrderId": "TO0000999", "fromLocationId": "a9eb72a68e8fd784", "fulfillmentId": "cb77df2408ff86a8", "incoterms": "EXW", "integration": "db7b1023927e91d8", "lineItems": [ { "sku": "P0001", "quantity": 2, "uniqueId": "79342_2", "name": "TestProduct001", "receivedQuantity": 2 } ], "orgKey": "6fb28a897a96f1bc", "senderName": "unknown", "status": "received", "toLocationId": "7092644a40f75ca4", "totalWeight": "44", "transferId": "dfb07b394ab1b229", "updatedAt": "2022-04-06T09:32:31.097Z", "weightUnit": "lb" }
Receipt
{ "arrivalId": "b01a6e18c022e6f6", "createdAt": "2022-04-06T09:32:30.999Z", "extOrderId": "TO0000999", "lineItems": [ { "sku": "P0002", "quantity": 2, "name": "TestProduct002" } ], "orgKey": "6fb28a897a96f1bc", "receiptId": "23f5d2eb01749d6e", "updatedAt": "2022-04-06T09:32:30.999Z" }
Fulfillment
{ "createdAt": "2022-08-09T06:11:06.489Z", "extOrderId": "TestOrder001", "fulfillmentId": "574910f05abc8dd0", "lineItems": [ { "uniqueId": "84031_1", "quantity": 1, "sku": "P0001", "name": "TestProduct001" } ], "locationId": "7092644a40f75ca4", "orgKey": "6fb28a897a96f1bc", "shipmentId": "4e79b95f35a02a92", "shippingCarrier": "UPS", "shippingCharge": 3.1, "shippingClass": "speed", "trackingNumber": [ "TestTrackingNumber001" ], "updatedAt": "2022-08-09T06:11:06.489Z", "weight": 1.1, "weightUnit": "lb" }
How to get source doc samples for entities from external endpoints
Source doc samples from NetSuite
Sales Order
{ "nullFieldList": null, "createdDate": "2022-08-08 20:41:31-07:00", "customForm": { "name": "Sales Order Form", "internalId": "134", "externalId": null, "type": null }, "entity": { "name": "CUST1999 Test", "internalId": "2112190", "externalId": null, "type": null }, "job": null, "currency": { "name": "USA", "internalId": "1", "externalId": null, "type": null }, "drAccount": null, "fxAccount": null, "tranDate": "2022-08-10 00:00:00-07:00", "tranId": "SO000999", "entityTaxRegNum": null, "source": "Web Services", "createdFrom": null, "orderStatus": "_fullyBilled", "nextBill": null, "opportunity": null, "salesRep": null, "contribPct": null, "partner": null, "salesGroup": null, "syncSalesTeams": false, "leadSource": null, "startDate": null, "endDate": null, "otherRefNum": "#0999-test11", "memo": "TestMemo", "salesEffectiveDate": "2022-08-10 00:00:00-07:00", "excludeCommission": null, "totalCostEstimate": 5.33, "estGrossProfit": 26.67, "estGrossProfitPercent": 83.3438, "exchangeRate": 1.0, "promoCode": null, "currencyName": "USA", "discountItem": null, "discountRate": null, "isTaxable": false, "taxItem": { "name": "-Not Taxable-", "internalId": "-7", "externalId": null, "type": null }, "taxRate": 0.0, "toBePrinted": false, "toBeEmailed": false, "email": "TestEmail@pipe17.com", "toBeFaxed": false, "fax": null, "messageSel": null, "message": null, "paymentOption": null, "inputAuthCode": null, "inputReferenceCode": null, "checkNumber": null, "paymentCardCsc": null, "paymentProcessingProfile": null, "handlingMode": null, "outputAuthCode": null, "outputReferenceCode": null, "paymentOperation": null, "dynamicDescriptor": null, "billingAddress": { "nullFieldList": null, "internalId": null, "country": "_unitedStates", "attention": null, "addressee": "TestAddress", "addrPhone": null, "addr1": "9999 S Claremont St", "addr2": "2nd Floor", "addr3": null, "city": "San Mateo", "state": "CA", "zip": "94402", "addrText": "", "override": false, "customFieldList": null }, "billAddressList": null, "shippingAddress": { "nullFieldList": null, "internalId": null, "country": "_unitedStates", "attention": null, "addressee": "TestAddress", "addrPhone": null, "addr1": "9999 S Claremont St", "addr2": "2nd Floor", "addr3": null, "city": "San Mateo", "state": "CA", "zip": "94402", "addrText": "", "override": false, "customFieldList": null }, "shipIsResidential": false, "shipAddressList": null, "fob": null, "shipDate": "2022-07-07 00:00:00-07:00", "actualShipDate": null, "shipMethod": null, "shippingCost": null, "shippingTax1Rate": null, "isMultiShipTo": null, "shippingTax2Rate": null, "shippingTaxCode": null, "handlingTaxCode": null, "handlingTax1Rate": null, "handlingTax2Rate": null, "handlingCost": null, "trackingNumbers": null, "linkedTrackingNumbers": "TestTrackingNumber001", "shipComplete": false, "paymentMethod": null, "shopperIpAddress": null, "saveOnAuthDecline": true, "canHaveStackable": true, "creditCard": null, "revenueStatus": null, "recognizedRevenue": null, "deferredRevenue": null, "revRecOnRevCommitment": null, "revCommitStatus": null, "ccNumber": null, "ccExpireDate": null, "ccName": null, "ccStreet": null, "ccZipCode": null, "payPalStatus": null, "creditCardProcessor": null, "payPalTranId": null, "ccApproved": false, "getAuth": false, "authCode": null, "ccAvsStreetMatch": null, "ccAvsZipMatch": null, "isRecurringPayment": false, "ccSecurityCodeMatch": null, "altSalesTotal": null, "ignoreAvs": null, "paymentEventResult": null, "paymentEventHoldReason": null, "paymentEventType": null, "paymentEventDate": null, "paymentEventUpdatedBy": null, "subTotal": 32.0, "discountTotal": 0.0, "taxTotal": null, "altShippingCost": null, "altHandlingCost": null, "total": 32.0, "revRecSchedule": null, "revRecStartDate": null, "revRecEndDate": null, "paypalAuthId": null, "balance": 2.85, "paypalProcess": null, "billingSchedule": null, "ccSecurityCode": null, "threeDStatusCode": null, "class": { "name": "TestClass", "internalId": "1", "externalId": null, "type": null }, "department": { "name": "Sales", "internalId": "1", "externalId": null, "type": null }, "subsidiary": { "name": "TestSubsidiary", "internalId": "1", "externalId": null, "type": null }, "intercoTransaction": null, "intercoStatus": null, "debitCardIssueNo": null, "lastModifiedDate": "2022-08-08 20:45:48-07:00", "nexus": null, "subsidiaryTaxRegNum": null, "taxRegOverride": null, "taxPointDate": null, "taxDetailsOverride": null, "location": { "name": "Testlocation", "internalId": "1", "externalId": null, "type": null }, "pnRefNum": null, "status": "Billed", "tax2Total": null, "terms": null, "validFrom": null, "vatRegNum": null, "giftCertApplied": 0.0, "oneTime": null, "recurWeekly": null, "recurMonthly": null, "recurQuarterly": null, "recurAnnually": null, "tranIsVsoeBundle": null, "vsoeAutoCalc": null, "syncPartnerTeams": null, "salesTeamList": null, "partnersList": null, "giftCertRedemptionList": null, "promotionsList": null, "itemList": { "item": [ { "job": null, "subscription": null, "item": { "name": "TestProduct002", "internalId": "84031", "externalId": null, "type": null }, "quantityAvailable": null, "expandItemGroup": false, "lineUniqueKey": 19654004, "quantityOnHand": null, "quantity": 1.0, "units": null, "inventoryDetail": null, "description": "M", "price": { "name": null, "internalId": "1", "externalId": null, "type": null }, "rate": "32.00", "serialNumbers": null, "amount": 32.0, "isTaxable": true, "commitInventory": null, "orderPriority": null, "licenseCode": null, "options": null, "department": null, "class": null, "location": null, "createPo": null, "createdPo": null, "altSalesAmt": null, "createWo": null, "poVendor": null, "poCurrency": null, "poRate": null, "revRecSchedule": null, "revRecStartDate": null, "revRecTermInMonths": null, "revRecEndDate": null, "deferRevRec": null, "isClosed": false, "itemFulfillmentChoice": null, "catchUpPeriod": null, "billingSchedule": null, "fromJob": null, "grossAmt": null, "taxAmount": null, "excludeFromRateRequest": null, "isEstimate": null, "inventoryLocation": null, "inventorySubsidiary": null, "line": 1, "percentComplete": null, "costEstimateType": null, "costEstimate": 5.33, "quantityBackOrdered": 0.0, "quantityBilled": 1.0, "quantityCommitted": 0.0, "quantityFulfilled": 1.0, "quantityPacked": null, "quantityPicked": null, "tax1Amt": null, "taxCode": null, "taxRate1": null, "taxRate2": null, "giftCertFrom": null, "giftCertRecipientName": null, "giftCertRecipientEmail": null, "giftCertMessage": null, "giftCertNumber": null, "shipGroup": null, "itemIsFulfilled": null, "shipAddress": null, "shipMethod": null, "vsoeSopGroup": null, "vsoeIsEstimate": null, "vsoePrice": null, "vsoeAmount": null, "vsoeAllocation": null, "vsoeDeferral": null, "vsoePermitDiscount": null, "vsoeDelivered": null, "expectedShipDate": "2022-07-07 00:00:00-07:00", "noAutoAssignLocation": null, "locationAutoAssigned": null, "taxDetailsReference": null, "chargeType": null, "orderAllocationStrategy": null, "requestedDate": null, "customFieldList": { "customField": [ { "value": { "name": "M", "internalId": "2", "externalId": null, "typeId": "85" }, "internalId": "532", "scriptId": "custcol_product_size" } ] } } ], "replaceAll": "true" }, "shipGroupList": null, "accountingBookDetailList": null, "taxDetailsList": null, "customFieldList": { "customField": [ { "value": false, "internalId": "846", "scriptId": "custbody1" } ] }, "internalId": "6615360", "externalId": "6477a9c6ad2b7676" }
Product
Source doc samples from Shopify
Sales Order
Product
Source doc samples from ShipStation
Sales Order
General
Content
Integrations