Table of Contents | ||||
---|---|---|---|---|
|
How to get source doc samples for Pipe17 entities
Actually we can always request for samples via Pipe17 Get API for all Pipe17 entities https://apidoc.pipe17.com/
Sales Order
Code Block |
---|
{ "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
Code Block |
---|
{ "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
Code Block |
---|
{ "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
Code Block |
---|
{ "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
Code Block |
---|
{ "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
Code Block |
---|
{ "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
Code Block |
---|
{ "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
Code Block |
---|
{ "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
Code Block |
---|
{ "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
Code Block |
---|
{ "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
Code Block |
---|
{ "nullFieldList": null, "createdDate": "2021-07-27 14:57:50-07:00", "lastModifiedDate": "2021-07-27 19:39:28-07:00", "purchaseDescription": null, "copyDescription": false, "expenseAccount": null, "dateConvertedToInv": null, "originalItemType": null, "originalItemSubtype": null, "cogsAccount": { "name": "TestCogsAccount", "internalId": "999", "externalId": null, "type": null }, "intercoCogsAccount": null, "salesDescription": null, "fraudRisk": null, "includeChildren": false, "incomeAccount": { "name": "TestIncomeAccount", "internalId": "888", "externalId": null, "type": null }, "intercoIncomeAccount": null, "taxSchedule": { "name": "NonTaxable", "internalId": "2", "externalId": null, "type": null }, "dropshipExpenseAccount": null, "deferRevRec": null, "revenueRecognitionRule": null, "revRecForecastRule": null, "revenueAllocationGroup": null, "createRevenuePlansOn": null, "directRevenuePosting": null, "contingentRevenueHandling": null, "revReclassFXAccount": null, "isTaxable": null, "matrixType": null, "assetAccount": { "name": "TestAsset Account", "internalId": "777", "externalId": null, "type": null }, "matchBillToReceipt": false, "billQtyVarianceAcct": null, "billPriceVarianceAcct": null, "billExchRateVarianceAcct": null, "gainLossAccount": null, "shippingCost": null, "shippingCostUnits": "per EA", "handlingCost": null, "handlingCostUnits": "per EA", "weight": 3.0, "weightUnit": "_lb", "weightUnits": "per EA", "costingMethodDisplay": "FIFO", "unitsType": { "name": "Each", "internalId": "1", "externalId": null, "type": null }, "stockUnit": { "name": "Eaches", "internalId": "1", "externalId": null, "type": null }, "purchaseUnit": { "name": "Eaches", "internalId": "1", "externalId": null, "type": null }, "saleUnit": { "name": "Eaches", "internalId": "1", "externalId": null, "type": null }, "issueProduct": null, "billingSchedule": null, "trackLandedCost": null, "matrixItemNameTemplate": null, "isDropShipItem": false, "isSpecialOrderItem": false, "stockDescription": null, "deferredRevenueAccount": null, "intercoDefRevAccount": null, "producer": null, "manufacturer": null, "revRecSchedule": null, "mpn": null, "multManufactureAddr": null, "manufacturerAddr1": null, "manufacturerCity": null, "manufacturerState": null, "manufacturerZip": null, "countryOfManufacture": null, "roundUpAsComponent": null, "purchaseOrderQuantity": null, "purchaseOrderAmount": null, "purchaseOrderQuantityDiff": null, "receiptQuantity": null, "receiptAmount": null, "receiptQuantityDiff": null, "defaultItemShipMethod": null, "itemCarrier": null, "itemShipMethodList": null, "manufacturerTaxId": null, "scheduleBNumber": null, "scheduleBQuantity": null, "scheduleBCode": null, "manufacturerTariff": null, "preferenceCriterion": null, "minimumQuantity": null, "enforceMinQtyInternally": null, "maximumQuantity": null, "minimumQuantityUnits": "EAS", "softDescriptor": null, "shipPackage": null, "shipIndividually": false, "costCategory": null, "pricesIncludeTax": null, "purchasePriceVarianceAcct": null, "quantityPricingSchedule": null, "reorderPointUnits": null, "useMarginalRates": null, "preferredStockLevelUnits": null, "costEstimateType": "_averageCost", "costEstimate": null, "transferPrice": null, "overallQuantityPricingType": null, "pricingGroup": null, "vsoePrice": null, "vsoeSopGroup": null, "costEstimateUnits": "per EA", "vsoeDeferral": null, "vsoePermitDiscount": null, "vsoeDelivered": null, "itemRevenueCategory": null, "preferredLocation": null, "isStorePickupAllowed": null, "reorderMultiple": null, "cost": 34.5, "lastInvtCountDate": null, "nextInvtCountDate": null, "invtCountInterval": null, "invtClassification": null, "costUnits": "per EA", "totalValue": null, "averageCost": null, "useBins": null, "quantityReorderUnits": "Quantity On Hand", "leadTime": null, "autoLeadTime": null, "lastPurchasePrice": null, "autoPreferredStockLevel": null, "preferredStockLevelDays": null, "safetyStockLevel": null, "safetyStockLevelDays": null, "backwardConsumptionDays": null, "seasonalDemand": null, "safetyStockLevelUnits": null, "demandModifier": null, "distributionNetwork": null, "distributionCategory": null, "autoReorderPoint": null, "storeDisplayName": null, "storeDisplayThumbnail": null, "storeDisplayImage": null, "storeDescription": null, "storeDetailedDescription": null, "storeItemTemplate": null, "pageTitle": null, "metaTagHtml": null, "excludeFromSitemap": null, "sitemapPriority": null, "searchKeywords": null, "isDonationItem": null, "showDefaultDonationAmount": null, "maxDonationAmount": null, "dontShowPrice": null, "noPriceMessage": null, "outOfStockMessage": null, "onSpecial": null, "outOfStockBehavior": null, "relatedItemsDescription": null, "specialsDescription": null, "featuredDescription": null, "shoppingDotComCategory": null, "shopzillaCategoryId": null, "nexTagCategory": null, "urlComponent": null, "customForm": { "name": "Standard Inventory Part Form", "internalId": "-299", "externalId": null, "type": null }, "itemId": "P0001", "upcCode": null, "displayName": "TestProductName01", "vendorName": "TestVendor", "parent": null, "isOnline": false, "isHazmatItem": null, "hazmatId": null, "hazmatShippingName": null, "hazmatHazardClass": null, "hazmatPackingGroup": null, "hazmatItemUnits": null, "hazmatItemUnitsQty": null, "isGcoCompliant": null, "offerSupport": false, "isInactive": false, "availableToPartners": null, "department": { "name": "TestDepartment", "internalId": "2", "externalId": null, "type": null }, "class": { "name": "TestClass", "internalId": "1", "externalId": null, "type": null }, "location": { "name": "TestWarehouse", "internalId": "999", "externalId": null, "type": null }, "costingMethod": null, "currency": "1", "preferredStockLevel": null, "pricingMatrix": null, "hierarchyVersionsList": null, "accountingBookDetailList": null, "purchaseTaxCode": null, "defaultReturnCost": null, "supplyReplenishmentMethod": null, "alternateDemandSourceItem": null, "fixedLotSize": null, "periodicLotSizeType": null, "supplyType": null, "demandTimeFence": null, "supplyTimeFence": null, "rescheduleInDays": null, "rescheduleOutDays": null, "periodicLotSizeDays": null, "supplyLotSizingMethod": null, "forwardConsumptionDays": null, "demandSource": null, "quantityBackOrdered": null, "quantityCommitted": null, "quantityAvailable": null, "quantityOnHand": null, "onHandValueMli": null, "quantityOnOrder": null, "rate": null, "reorderPoint": null, "quantityCommittedUnits": null, "salesTaxCode": null, "quantityAvailableUnits": null, "quantityOnHandUnits": null, "vendor": null, "quantityOnOrderUnits": null, "productFeedList": null, "subsidiaryList": { "recordRef": [ { "name": "TestSubsidiaryName", "internalId": "60", "externalId": null, "type": null } ] }, "itemOptionsList": null, "itemVendorList": { "itemVendor": [ { "vendor": { "name": "TestVendor01", "internalId": "2999", "externalId": null, "type": null }, "vendorCode": null, "vendorCurrencyName": null, "vendorCurrency": null, "purchasePrice": null, "preferredVendor": false, "schedule": null, "subsidiary": { "name": "TestSubsidiaryName", "internalId": "6", "externalId": null, "type": null } } ], "replaceAll": "true" }, "siteCategoryList": null, "translationsList": null, "binNumberList": null, "locationsList": null, "matrixOptionList": null, "presentationItemList": null, "futureHorizon": null, "consumptionUnit": null, "enableCatchWeight": null, "secondaryUnitsType": null, "secondaryBaseUnit": null, "conversionRate": null, "secondaryStockUnit": null, "secondarySaleUnit": null, "secondaryPurchaseUnit": null, "secondaryConsumptionUnit": null, "lowerWarningLimit": null, "upperWarningLimit": null, "customFieldList": { "customField": [ { "value": false, "internalId": "1188", "scriptId": "Testcustitem_1" } ] }, "internalId": "36999", "externalId": null } |
Source doc samples from Shopify
Sales Order
Code Block |
---|
{ "original_data": { "id": 4614099300999, "admin_graphql_api_id": "gid:\/\/shopify\/Order\/4614099300999", "app_id": 129999, "browser_ip": "76.168.97.000", "buyer_accepts_marketing": false, "cancel_reason": null, "cancelled_at": null, "cart_token": null, "checkout_id": 30293463200999, "checkout_token": "b85716a7b3f18eb705e6cbdf0de6e999", "client_details": { "accept_language": "en-US,en;q=0.9", "browser_height": null, "browser_ip": "76.168.97.000", "browser_width": null, "session_hash": null, "user_agent": "Shopify\/7.6.0\/iOS\/15.6.1\/Apple\/iPad (5th generation)\/production" }, "closed_at": "2022-08-23T14:06:37-07:00", "confirmed": true, "contact_email": null, "created_at": "2022-08-23T14:06:36-07:00", "currency": "USD", "current_subtotal_price": "64.00", "current_subtotal_price_set": { "shop_money": { "amount": "64.00", "currency_code": "USD" }, "presentment_money": { "amount": "64.00", "currency_code": "USD" } }, "current_total_discounts": "0.00", "current_total_discounts_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "USD" } }, "current_total_duties_set": null, "current_total_price": "70.08", "current_total_price_set": { "shop_money": { "amount": "70.08", "currency_code": "USD" }, "presentment_money": { "amount": "70.08", "currency_code": "USD" } }, "current_total_tax": "6.08", "current_total_tax_set": { "shop_money": { "amount": "6.08", "currency_code": "USD" }, "presentment_money": { "amount": "6.08", "currency_code": "USD" } }, "customer_locale": "en", "device_id": 3, "discount_codes": [], "email": "", "estimated_taxes": false, "financial_status": "paid", "fulfillment_status": "fulfilled", "gateway": "shopify_payments", "landing_site": "\/admin\/api\/unstable\/checkouts.json", "landing_site_ref": null, "location_id": 67258777749, "name": "#test11599", "note": null, "note_attributes": [], "number": 10599, "order_number": 11599, "order_status_url": "https:\/\/test.myshopify.com\/62110200999\/orders\/1\/authenticate?key=", "original_total_duties_set": null, "payment_gateway_names": [ "shopify_payments" ], "phone": null, "presentment_currency": "USD", "processed_at": "2022-08-23T14:06:35-07:00", "processing_method": "stripe_terminal", "reference": null, "referring_site": null, "source_identifier": "67258777749-9-9999", "source_name": "pos", "source_url": null, "subtotal_price": "96.00", "subtotal_price_set": { "shop_money": { "amount": "96.00", "currency_code": "USD" }, "presentment_money": { "amount": "96.00", "currency_code": "USD" } }, "tags": "", "tax_lines": [ { "price": "6.96", "rate": 0.0725, "title": "California State Tax", "price_set": { "shop_money": { "amount": "6.96", "currency_code": "USD" }, "presentment_money": { "amount": "6.96", "currency_code": "USD" } }, "channel_liable": false }, { "price": "2.16", "rate": 0.0225, "title": "Los Angeles County Tax", "price_set": { "shop_money": { "amount": "2.16", "currency_code": "USD" }, "presentment_money": { "amount": "2.16", "currency_code": "USD" } }, "channel_liable": null } ], "taxes_included": false, "test": false, "token": "1", "total_discounts": "0.00", "total_discounts_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "USD" } }, "total_line_items_price": "96.00", "total_line_items_price_set": { "shop_money": { "amount": "96.00", "currency_code": "USD" }, "presentment_money": { "amount": "96.00", "currency_code": "USD" } }, "total_outstanding": "0.00", "total_price": "105.12", "total_price_set": { "shop_money": { "amount": "105.12", "currency_code": "USD" }, "presentment_money": { "amount": "105.12", "currency_code": "USD" } }, "total_price_usd": "105.12", "total_shipping_price_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "USD" } }, "total_tax": "9.12", "total_tax_set": { "shop_money": { "amount": "9.12", "currency_code": "USD" }, "presentment_money": { "amount": "9.12", "currency_code": "USD" } }, "total_tip_received": "0.00", "total_weight": 362, "updated_at": "2022-08-23T14:30:11-07:00", "user_id": 80943549999, "billing_address": { "first_name": "TestFirstName", "address1": "9999 S Claremont St", "phone": "(999) 554-9999", "city": "San Mateo", "zip": "94402", "province": "CA", "country": "United States", "last_name": "TestLastName", "address2": "", "company": null, "latitude": 38.9639999, "longitude": -95.7409999, "name": "TestName", "country_code": "US", "province_code": "CA" }, "customer": { "id": 6424187769999, "email": "test@pipe17.com", "accepts_marketing": false, "created_at": "2022-08-23T14:06:34-07:00", "updated_at": "2022-08-23T14:06:37-07:00", "first_name": "CustomerFirstName", "last_name": "CustomerLastName", "orders_count": 1, "state": "disabled", "total_spent": "70.08", "last_order_id": 4614099379999, "note": null, "verified_email": true, "multipass_identifier": null, "tax_exempt": false, "tags": "", "last_order_name": "#Test11599", "currency": "USD", "phone": null, "accepts_marketing_updated_at": "2022-08-23T14:06:37-07:00", "marketing_opt_in_level": null, "tax_exemptions": [], "sms_marketing_consent": null, "admin_graphql_api_id": "gid:\/\/shopify\/Customer\/6424187769999", "default_address": { "id": "7634206859999", "customer_id": "6257118249999", "first_name": "CustomerFirstName", "last_name": "CustomerLastName", "company": null, "address1": "9999 S Claremont St", "address2": "", "city": "San Mateo", "province": "CA", "country": "United States", "zip": "94402", "phone": "(999) 554-0999", "name": "Ashley West", "province_code": "CA", "country_code": "US", "country_name": "United States", "default": true } }, "discount_applications": [ { "target_type": "line_item", "type": "discount_code", "value": "1.0", "value_type": "fixed_amount", "allocation_method": "across", "target_selection": "all", "code": "WE10B2Z99999" } ], "fulfillments": [ { "id": 4108059679999, "admin_graphql_api_id": "gid:\/\/shopify\/Fulfillment\/4108059679999", "created_at": "2022-08-23T14:06:37-07:00", "location_id": 67258779999, "name": "##Test11599.1", "order_id": 4614099379999, "origin_address": {}, "receipt": {}, "service": "manual", "shipment_status": null, "status": "success", "tracking_company": "USPS", "tracking_number": "9361289680013547499999", "tracking_numbers": [ "9361289680013547499999" ], "tracking_url": "https:\/\/tools.usps.com\/go\/TrackConfirmAction?tLabels=936", "tracking_urls": [ "https:\/\/tools.usps.com\/go\/TrackConfirmAction?tLabels=936" ], "updated_at": "2022-08-23T14:06:37-07:00", "line_items": [ { "id": 11488176099999, "admin_graphql_api_id": "gid:\/\/shopify\/LineItem\/11488176079999", "fulfillable_quantity": 1, "fulfillment_service": "manual", "fulfillment_status": "fulfilled", "gift_card": false, "grams": 0, "name": "TestProduct001", "origin_location": { "id": 3578979489999, "country_code": "US", "province_code": "CA", "name": "TestName", "address1": "9999 S Claremont St", "address2": "", "city": "Los Angeles", "zip": "90036" }, "pre_tax_price": "32.00", "pre_tax_price_set": { "shop_money": { "amount": "32.00", "currency_code": "USD" }, "presentment_money": { "amount": "32.00", "currency_code": "USD" } }, "price": "32.00", "price_set": { "shop_money": { "amount": "32.00", "currency_code": "USD" }, "presentment_money": { "amount": "32.00", "currency_code": "USD" } }, "product_exists": true, "product_id": 7620515929999, "properties": [], "quantity": 1, "requires_shipping": true, "sku": "P0001", "taxable": true, "title": "TestProduct001", "total_discount": "0.00", "total_discount_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "USD" } }, "variant_id": 42634120265877, "variant_inventory_management": "shopify", "variant_title": "Medium", "vendor": "TestVendor", "tax_lines": [ { "channel_liable": false, "price": "2.32", "price_set": { "shop_money": { "amount": "2.32", "currency_code": "USD" }, "presentment_money": { "amount": "2.32", "currency_code": "USD" } }, "rate": 0.0725, "title": "California State Tax" }, { "channel_liable": false, "price": "0.72", "price_set": { "shop_money": { "amount": "0.72", "currency_code": "USD" }, "presentment_money": { "amount": "0.72", "currency_code": "USD" } }, "rate": 0.0225, "title": "Los Angeles County Tax" } ], "duties": [], "discount_allocations": [] }, { "id": 11488176119999, "admin_graphql_api_id": "gid:\/\/shopify\/LineItem\/11488176119999", "fulfillable_quantity": 0, "fulfillment_service": "manual", "fulfillment_status": "fulfilled", "gift_card": false, "grams": 181, "name": "TestProductName01", "origin_location": { "id": 3578979489999, "country_code": "US", "province_code": "CA", "name": "TestName", "address1": "9999 S Claremont St", "address2": "", "city": "Los Angeles", "zip": "90036" }, "pre_tax_price": "32.00", "pre_tax_price_set": { "shop_money": { "amount": "32.00", "currency_code": "USD" }, "presentment_money": { "amount": "32.00", "currency_code": "USD" } }, "price": "32.00", "price_set": { "shop_money": { "amount": "32.00", "currency_code": "USD" }, "presentment_money": { "amount": "32.00", "currency_code": "USD" } }, "product_exists": true, "product_id": 7557898309999, "properties": [], "quantity": 1, "requires_shipping": true, "sku": "P0001", "taxable": true, "title": "TestProductName01", "total_discount": "0.00", "total_discount_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "USD" } }, "variant_id": 42456373109999, "variant_inventory_management": "shopify", "variant_title": "Large", "vendor": "TestVendor", "tax_lines": [ { "channel_liable": false, "price": "2.32", "price_set": { "shop_money": { "amount": "2.32", "currency_code": "USD" }, "presentment_money": { "amount": "2.32", "currency_code": "USD" } }, "rate": 0.0725, "title": "California State Tax" }, { "channel_liable": false, "price": "0.72", "price_set": { "shop_money": { "amount": "0.72", "currency_code": "USD" }, "presentment_money": { "amount": "0.72", "currency_code": "USD" } }, "rate": 0.0225, "title": "Los Angeles County Tax" } ], "duties": [], "discount_allocations": [] } ] }, { "id": 4108079539999, "admin_graphql_api_id": "gid:\/\/shopify\/Fulfillment\/4108079539999", "created_at": "2022-08-23T14:30:11-07:00", "location_id": 67258779999, "name": "#test11599", "order_id": 4614099379999, "origin_address": {}, "receipt": {}, "service": "manual", "shipment_status": null, "status": "success", "tracking_company": null, "tracking_number": null, "tracking_numbers": [], "tracking_url": null, "tracking_urls": [], "updated_at": "2022-08-23T14:30:11-07:00", "line_items": [ { "id": 11488217179999, "admin_graphql_api_id": "gid:\/\/shopify\/LineItem\/11488217179999", "fulfillable_quantity": 0, "fulfillment_service": "manual", "fulfillment_status": "fulfilled", "gift_card": false, "grams": 181, "name": "TestProductName01", "pre_tax_price": "32.00", "pre_tax_price_set": { "shop_money": { "amount": "32.00", "currency_code": "USD" }, "presentment_money": { "amount": "32.00", "currency_code": "USD" } }, "price": "32.00", "price_set": { "shop_money": { "amount": "32.00", "currency_code": "USD" }, "presentment_money": { "amount": "32.00", "currency_code": "USD" } }, "product_exists": true, "product_id": 7557898309999, "properties": [], "quantity": 1, "requires_shipping": true, "sku": "P0001", "taxable": true, "title": "TestProductName01", "total_discount": "0.00", "total_discount_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "USD" } }, "variant_id": 42456373199999, "variant_inventory_management": "shopify", "variant_title": "XL", "vendor": "TestVendor", "tax_lines": [ { "channel_liable": null, "price": "2.32", "price_set": { "shop_money": { "amount": "2.32", "currency_code": "USD" }, "presentment_money": { "amount": "2.32", "currency_code": "USD" } }, "rate": 0.0725, "title": "California State Tax" }, { "channel_liable": null, "price": "0.72", "price_set": { "shop_money": { "amount": "0.72", "currency_code": "USD" }, "presentment_money": { "amount": "0.72", "currency_code": "USD" } }, "rate": 0.0225, "title": "Los Angeles County Tax" } ], "duties": [], "discount_allocations": [] } ] } ], "line_items": [ { "id": 11488176079999, "admin_graphql_api_id": "gid:\/\/shopify\/LineItem\/11488176079999", "fulfillable_quantity": 0, "fulfillment_service": "manual", "fulfillment_status": "fulfilled", "gift_card": false, "grams": 0, "name": "TestProdcutName01", "origin_location": { "id": 3578979489999, "country_code": "US", "province_code": "CA", "name": "TestName", "address1": "9999 S Claremont St", "address2": "", "city": "Los Angeles", "zip": "90036" }, "pre_tax_price": "32.00", "pre_tax_price_set": { "shop_money": { "amount": "32.00", "currency_code": "USD" }, "presentment_money": { "amount": "32.00", "currency_code": "USD" } }, "price": "32.00", "price_set": { "shop_money": { "amount": "32.00", "currency_code": "USD" }, "presentment_money": { "amount": "32.00", "currency_code": "USD" } }, "product_exists": true, "product_id": 7620515929999, "properties": [], "quantity": 1, "requires_shipping": true, "sku": "P0001", "taxable": true, "title": "TestProductName", "total_discount": "0.00", "total_discount_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "USD" } }, "variant_id": 42634120269999, "variant_inventory_management": "shopify", "variant_title": "Medium", "vendor": "TestVendor", "tax_lines": [ { "channel_liable": false, "price": "2.32", "price_set": { "shop_money": { "amount": "2.32", "currency_code": "USD" }, "presentment_money": { "amount": "2.32", "currency_code": "USD" } }, "rate": 0.0725, "title": "California State Tax" }, { "channel_liable": false, "price": "0.72", "price_set": { "shop_money": { "amount": "0.72", "currency_code": "USD" }, "presentment_money": { "amount": "0.72", "currency_code": "USD" } }, "rate": 0.0225, "title": "Los Angeles County Tax" } ], "duties": [], "discount_allocations": [] }, { "id": 11488176119999, "admin_graphql_api_id": "gid:\/\/shopify\/LineItem\/11488176119999", "fulfillable_quantity": 0, "fulfillment_service": "manual", "fulfillment_status": "fulfilled", "gift_card": false, "grams": 181, "name": "TestProductName01", "origin_location": { "id": 3578979489999, "country_code": "US", "province_code": "CA", "name": "TesName", "address1": "9999 S Claremont St", "address2": "", "city": "Los Angeles", "zip": "90036" }, "pre_tax_price": "32.00", "pre_tax_price_set": { "shop_money": { "amount": "32.00", "currency_code": "USD" }, "presentment_money": { "amount": "32.00", "currency_code": "USD" } }, "price": "32.00", "price_set": { "shop_money": { "amount": "32.00", "currency_code": "USD" }, "presentment_money": { "amount": "32.00", "currency_code": "USD" } }, "product_exists": true, "product_id": 7557898309999, "properties": [], "quantity": 1, "requires_shipping": true, "sku": "P0001", "taxable": true, "title": "TestProductName01", "total_discount": "0.00", "total_discount_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "USD" } }, "variant_id": 42456373109999, "variant_inventory_management": "shopify", "variant_title": "Large", "vendor": "TestVendor", "tax_lines": [ { "channel_liable": false, "price": "2.32", "price_set": { "shop_money": { "amount": "2.32", "currency_code": "USD" }, "presentment_money": { "amount": "2.32", "currency_code": "USD" } }, "rate": 0.0725, "title": "California State Tax" }, { "channel_liable": false, "price": "0.72", "price_set": { "shop_money": { "amount": "0.72", "currency_code": "USD" }, "presentment_money": { "amount": "0.72", "currency_code": "USD" } }, "rate": 0.0225, "title": "Los Angeles County Tax" } ], "duties": [], "discount_allocations": [] }, { "id": 11488217179999, "admin_graphql_api_id": "gid:\/\/shopify\/LineItem\/11488217179999", "fulfillable_quantity": 0, "fulfillment_service": "manual", "fulfillment_status": "fulfilled", "gift_card": false, "grams": 181, "name": "TestProductName01", "pre_tax_price": "32.00", "pre_tax_price_set": { "shop_money": { "amount": "32.00", "currency_code": "USD" }, "presentment_money": { "amount": "32.00", "currency_code": "USD" } }, "price": "32.00", "price_set": { "shop_money": { "amount": "32.00", "currency_code": "USD" }, "presentment_money": { "amount": "32.00", "currency_code": "USD" } }, "product_exists": true, "product_id": 7557898309999, "properties": [], "quantity": 1, "requires_shipping": true, "sku": "P0002", "taxable": true, "title": "TestProductName02", "total_discount": "0.00", "total_discount_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "USD" } }, "variant_id": 42456373199999, "variant_inventory_management": "shopify", "variant_title": "XL", "vendor": "TestVendor", "tax_lines": [ { "channel_liable": null, "price": "2.32", "price_set": { "shop_money": { "amount": "2.32", "currency_code": "USD" }, "presentment_money": { "amount": "2.32", "currency_code": "USD" } }, "rate": 0.0725, "title": "California State Tax" }, { "channel_liable": null, "price": "0.72", "price_set": { "shop_money": { "amount": "0.72", "currency_code": "USD" }, "presentment_money": { "amount": "0.72", "currency_code": "USD" } }, "rate": 0.0225, "title": "Los Angeles County Tax" } ], "duties": [], "discount_allocations": [] } ], "payment_terms": null, "refunds": [ { "id": 846968259999, "admin_graphql_api_id": "gid:\/\/shopify\/Refund\/846968259999", "created_at": "2022-08-23T14:30:10-07:00", "note": null, "order_id": 4614099379999, "processed_at": "2022-08-23T14:30:10-07:00", "restock": true, "total_duties_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "USD" } }, "user_id": 80943549999, "order_adjustments": [], "transactions": [], "refund_line_items": [ { "id": 356464269999, "line_item_id": 11488176119999, "location_id": 67258779999, "quantity": 1, "restock_type": "return", "subtotal": 32.0, "subtotal_set": { "shop_money": { "amount": "32.00", "currency_code": "USD" }, "presentment_money": { "amount": "32.00", "currency_code": "USD" } }, "total_tax": 3.04, "total_tax_set": { "shop_money": { "amount": "3.04", "currency_code": "USD" }, "presentment_money": { "amount": "3.04", "currency_code": "USD" } }, "line_item": { "id": 11488176119999, "admin_graphql_api_id": "gid:\/\/shopify\/LineItem\/11488176119999", "fulfillable_quantity": 0, "fulfillment_service": "manual", "fulfillment_status": "fulfilled", "gift_card": false, "grams": 181, "name": "TestProductName01", "origin_location": { "id": 3578979489999, "country_code": "US", "province_code": "CA", "name": "TestName", "address1": "9999 S Claremont St", "address2": "", "city": "Los Angeles", "zip": "90036" }, "pre_tax_price": "32.00", "pre_tax_price_set": { "shop_money": { "amount": "32.00", "currency_code": "USD" }, "presentment_money": { "amount": "32.00", "currency_code": "USD" } }, "price": "32.00", "price_set": { "shop_money": { "amount": "32.00", "currency_code": "USD" }, "presentment_money": { "amount": "32.00", "currency_code": "USD" } }, "product_exists": true, "product_id": 7557898309999, "properties": [], "quantity": 1, "requires_shipping": true, "sku": "P0002", "taxable": true, "title": "TestProductName02", "total_discount": "0.00", "total_discount_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "USD" } }, "variant_id": 42456373109999, "variant_inventory_management": "shopify", "variant_title": "Large", "vendor": "TestVendor", "tax_lines": [ { "channel_liable": false, "price": "2.32", "price_set": { "shop_money": { "amount": "2.32", "currency_code": "USD" }, "presentment_money": { "amount": "2.32", "currency_code": "USD" } }, "rate": 0.0725, "title": "California State Tax" }, { "channel_liable": false, "price": "0.72", "price_set": { "shop_money": { "amount": "0.72", "currency_code": "USD" }, "presentment_money": { "amount": "0.72", "currency_code": "USD" } }, "rate": 0.0225, "title": "Los Angeles County Tax" } ], "duties": [], "discount_allocations": [] } } ], "duties": [] } ], "shipping_address": { "first_name": "TestFirstName", "address1": "9999 S Claremont St", "phone": "(999) 554-9999", "city": "San Mateo", "zip": "94402", "province": "CA", "country": "United States", "last_name": "TestLastName", "address2": "", "company": null, "latitude": 38.9639999, "longitude": -95.7409999, "name": "TestName", "country_code": "US", "province_code": "CA" }, "shipping_lines": [ { "id": 379875629999, "carrier_identifier": null, "code": "Economy", "delivery_category": null, "discounted_price": "0.00", "discounted_price_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "USD" } }, "phone": null, "price": "0.00", "price_set": { "shop_money": { "amount": "0.00", "currency_code": "USD" }, "presentment_money": { "amount": "0.00", "currency_code": "USD" } }, "requested_fulfillment_service_id": null, "source": "shopify", "title": "Economy", "tax_lines": [], "discount_allocations": [] } ] } } |
Product - note at present we only have very limited support by setting values for the below specified Pipe17 product properties
Code Block { "sku": self.child_sku(variant), "name": self.child_title(variant), "status": self.status(), "description": self.child_description(), "types": types, "extProductId": str(self.variant_ext_product_id(variant)), "upc": variant.get("barcode"), "prices": self.prices(variant), "taxable": variant.get("taxable"), "weight": variant.get("weight"), "weightUnit": variant.get("weight_unit"), "vendor": self.vendor(), "tags": self.tags(), "cost": self.cost(variant), "imageURLs": self.child_images(variant), "parentExtProductId": self.parent_ext_id(), "variantOptions": self.variant_options(variant)iftypes==[ "child" ]else[], "extProductCreatedAt": variant.get("created_at"), "extProductUpdatedAt": variant.get("updated_at"), }
Source doc samples from ShipStation
Sales Order
Code Block | ||
---|---|---|
| ||
{ "orderId": 178875615, "orderNumber": "#46854", "orderKey": "a99c4daf2b70e4ec", "orderDate": "2022-07-20T00:02:29.1800000", "createDate": "2022-07-20T00:02:47.5070000", "modifyDate": "2022-07-20T00:02:48.1300000", "paymentDate": "2022-07-20T00:02:29.1800000", "shipByDate": "2022-07-20T00:02:29.1800000", "orderStatus": "awaiting_shipment", "customerId": 91954226, "customerUsername": "Test Customer", "customerEmail": "test.l.customer@gmail.com", "billTo": { "name": "Test Customer", "company": null, "street1": "123 Swett Road", "street2": null, "street3": null, "city": "Redwood City", "state": "CA", "postalCode": "12345", "country": "US", "phone": "(123) 535-8946", "residential": null, "addressVerified": null }, "shipTo": { "name": "Test Customer", "company": "Test Company", "street1": "252 SWETT RD", "street2": "", "street3": null, "city": "REDWOOD CITY", "state": "CA", "postalCode": "12345-4708", "country": "US", "phone": "(123) 535-8946", "residential": true, "addressVerified": "Address validated successfully" }, "items": [ { "orderItemId": 285511142, "lineItemKey": "12314845577472", "sku": "Balancing Oil", "name": "", "imageUrl": null, "weight": null, "quantity": 1, "unitPrice": 39.00, "taxAmount": 2.12, "shippingAmount": null, "warehouseLocation": null, "options": [], "productId": 15621600, "fulfillmentSku": null, "adjustment": false, "upc": null, "createDate": "2022-07-20T00:02:47.363", "modifyDate": "2022-07-20T00:02:47.363" }, { "orderItemId": 285511143, "lineItemKey": "12314845610240", "sku": "MFB-HCG-10", "name": "", "imageUrl": null, "weight": null, "quantity": 1, "unitPrice": 10.00, "taxAmount": 0.54, "shippingAmount": null, "warehouseLocation": null, "options": [], "productId": 15621602, "fulfillmentSku": null, "adjustment": false, "upc": null, "createDate": "2022-07-20T00:02:47.363", "modifyDate": "2022-07-20T00:02:47.363" }, { "orderItemId": 285511144, "lineItemKey": "12314845643008", "sku": "MFB-LH-30", "name": "", "imageUrl": null, "weight": null, "quantity": 1, "unitPrice": 19.00, "taxAmount": 1.03, "shippingAmount": null, "warehouseLocation": null, "options": [], "productId": 15621603, "fulfillmentSku": null, "adjustment": false, "upc": null, "createDate": "2022-07-20T00:02:47.363", "modifyDate": "2022-07-20T00:02:47.363" }, { "orderItemId": 285511145, "lineItemKey": "12314845675776", "sku": "MFB-02-15-5", "name": "", "imageUrl": null, "weight": null, "quantity": 1, "unitPrice": 39.00, "taxAmount": 2.12, "shippingAmount": null, "warehouseLocation": null, "options": [], "productId": 15621601, "fulfillmentSku": null, "adjustment": false, "upc": null, "createDate": "2022-07-20T00:02:47.363", "modifyDate": "2022-07-20T00:02:47.363" } ], "orderTotal": 112.81, "amountPaid": 86.06, "taxAmount": 5.81, "shippingAmount": 0.00, "customerNotes": "", "internalNotes": null, "gift": false, "giftMessage": "", "paymentMethod": "", "requestedShippingService": "Free USPS Shipping (3-6 Business days)", "carrierCode": null, "serviceCode": null, "packageCode": null, "confirmation": "none", "shipDate": "2022-07-20", "holdUntilDate": null, "weight": { "value": 0.00, "units": "ounces", "WeightUnits": 1 }, "dimensions": null, "insuranceOptions": { "provider": null, "insureShipment": false, "insuredValue": 0.0 }, "internationalOptions": { "contents": "merchandise", "customsItems": null, "nonDelivery": "return_to_sender" }, "advancedOptions": { "warehouseId": 597234, "nonMachinable": false, "saturdayDelivery": false, "containsAlcohol": false, "mergedOrSplit": false, "mergedIds": [], "parentId": null, "storeId": 71329, "customField1": null, "customField2": null, "customField3": null, "source": null, "billToParty": null, "billToAccount": null, "billToPostalCode": null, "billToCountryCode": null, "billToMyOtherAccount": null }, "tagIds": null, "userId": null, "externallyFulfilled": false, "externallyFulfilledBy": null, "externallyFulfilledById": null, "externallyFulfilledByName": null, "labelMessages": null } |
...