Versions Compared

Version Old Version 1 New Version 2
Changes made by

Roger Fang

Roger Fang

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

  1. How to get source doc samples for Pipe17 entities

    1. 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": ""
}

    2. Shipping Request

    How to get source doc samples for entities from external endpoints

    1. Source doc samples from NetSuite

    2. Source doc samples from Shopify
      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
}

    3. Product

    4. Inventory

  2. How to get source doc samples for entities from external endpoints

    1. Source doc samples from NetSuite

    2. Source doc samples from Shopify

      1. Sales Order

        Code Block
        {
  "original_data": {
    "id": 4605156589725,
    "admin_graphql_api_id": "gid:\/\/shopify\/Order\/4605156589725",
    "app_id": 580111,
    "browser_ip": "172.58.165.247",
    "buyer_accepts_marketing": true,
    "cancel_reason": null,
    "cancelled_at": null,
    "cart_token": "63530b8a1c2f627e97a13eb1cc3453ab",
    "checkout_id": 23098273202333,
    "checkout_token": "632dbef203a876a9409aeffaecd85580",
    "client_details": {
      "accept_language": "en-US,en;q=0.9",
      "browser_height": 655,
      "browser_ip": "172.58.165.247",
      "browser_width": 390,
      "session_hash": null,
      "user_agent": "Mozilla\/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit\/605.1.15 (KHTML, like Gecko) Mobile\/19F77 [FBAN\/FBIOS;FBDV\/iPhone13,2;FBMD\/iPhone;FBSN\/iOS;FBSV\/15.5;FBSS\/3;FBID\/phone;FBLC\/en_US;FBOP\/5]"
    },
    "closed_at": null,
    "confirmed": true,
    "contact_email": "ashley_west16@yahoo.com",
    "created_at": "2022-08-06T10:19:27-04:00",
    "currency": "USD",
    "current_subtotal_price": "91.55",
    "current_subtotal_price_set": {
      "shop_money": {
        "amount": "91.55",
        "currency_code": "USD"
      },
      "presentment_money": {
        "amount": "91.55",
        "currency_code": "USD"
      }
    },
    "current_total_discounts": "10.00",
    "current_total_discounts_set": {
      "shop_money": {
        "amount": "10.00",
        "currency_code": "USD"
      },
      "presentment_money": {
        "amount": "10.00",
        "currency_code": "USD"
      }
    },
    "current_total_duties_set": null,
    "current_total_price": "91.55",
    "current_total_price_set": {
      "shop_money": {
        "amount": "91.55",
        "currency_code": "USD"
      },
      "presentment_money": {
        "amount": "91.55",
        "currency_code": "USD"
      }
    },
    "current_total_tax": "0.00",
    "current_total_tax_set": {
      "shop_money": {
        "amount": "0.00",
        "currency_code": "USD"
      },
      "presentment_money": {
        "amount": "0.00",
        "currency_code": "USD"
      }
    },
    "customer_locale": "en-US",
    "device_id": null,
    "discount_codes": [
      {
        "code": "WE10B2ZK5TZF",
        "amount": "10.00",
        "type": "fixed_amount"
      }
    ],
    "email": "ashley_west16@yahoo.com",
    "estimated_taxes": false,
    "financial_status": "paid",
    "fulfillment_status": "partial",
    "gateway": "paypal",
    "landing_site": "\/products\/mens-brooks-ghost-13-white-grey-deep-cobalt",
    "landing_site_ref": null,
    "location_id": null,
    "name": "#76339",
    "note": "Tags: sale-items, Amazon MCF, Pacers Arlington, Amazon MCF WH, first-time-customer, ShipStation",
    "note_attributes": [
      {
        "name": "Agreed to the return policy",
        "value": "Sat Aug 06 2022 09:17:43 GMT-0500 (CDT)"
      }
    ],
    "number": 75339,
    "order_number": 76339,
    "order_status_url": "https:\/\/runpacers.com\/52494074013\/orders\/63afb94997d0e4dfbd2e8d434d1dd30e\/authenticate?key=a0f3c8438464d8b10570276b93808ee3",
    "original_total_duties_set": null,
    "payment_gateway_names": [
      "paypal"
    ],
    "phone": null,
    "presentment_currency": "USD",
    "processed_at": "2022-08-06T10:19:20-04:00",
    "processing_method": "express",
    "reference": null,
    "referring_site": "http:\/\/m.facebook.com\/",
    "source_identifier": null,
    "source_name": "web",
    "source_url": null,
    "subtotal_price": "91.55",
    "subtotal_price_set": {
      "shop_money": {
        "amount": "91.55",
        "currency_code": "USD"
      },
      "presentment_money": {
        "amount": "91.55",
        "currency_code": "USD"
      }
    },
    "tags": "Amazon MCF, Amazon MCF WH, first-time-customer, newsletter, Pacers Arlington, sale-items, ShipStation",
    "tax_lines": [],
    "taxes_included": false,
    "test": false,
    "token": "63afb94997d0e4dfbd2e8d434d1dd30e",
    "total_discounts": "10.00",
    "total_discounts_set": {
      "shop_money": {
        "amount": "10.00",
        "currency_code": "USD"
      },
      "presentment_money": {
        "amount": "10.00",
        "currency_code": "USD"
      }
    },
    "total_line_items_price": "101.55",
    "total_line_items_price_set": {
      "shop_money": {
        "amount": "101.55",
        "currency_code": "USD"
      },
      "presentment_money": {
        "amount": "101.55",
        "currency_code": "USD"
      }
    },
    "total_outstanding": "0.00",
    "total_price": "91.55",
    "total_price_set": {
      "shop_money": {
        "amount": "91.55",
        "currency_code": "USD"
      },
      "presentment_money": {
        "amount": "91.55",
        "currency_code": "USD"
      }
    },
    "total_price_usd": "91.55",
    "total_shipping_price_set": {
      "shop_money": {
        "amount": "0.00",
        "currency_code": "USD"
      },
      "presentment_money": {
        "amount": "0.00",
        "currency_code": "USD"
      }
    },
    "total_tax": "0.00",
    "total_tax_set": {
      "shop_money": {
        "amount": "0.00",
        "currency_code": "USD"
      },
      "presentment_money": {
        "amount": "0.00",
        "currency_code": "USD"
      }
    },
    "total_tip_received": "0.00",
    "total_weight": 282,
    "updated_at": "2022-08-10T04:24:36-04:00",
    "user_id": null,
    "billing_address": {
      "first_name": "Ashley",
      "address1": "5710 Sw Fairlawn Dr",
      "phone": "(785) 554-0858",
      "city": "Topeka",
      "zip": "66619",
      "province": "Kansas",
      "country": "United States",
      "last_name": "West",
      "address2": "",
      "company": null,
      "latitude": 38.9634236,
      "longitude": -95.7405216,
      "name": "Ashley West",
      "country_code": "US",
      "province_code": "KS"
    },
    "customer": {
      "id": 6257118249117,
      "email": "ashley_west16@yahoo.com",
      "accepts_marketing": true,
      "created_at": "2022-08-06T10:04:46-04:00",
      "updated_at": "2022-08-06T10:19:28-04:00",
      "first_name": "Ashley",
      "last_name": "West",
      "orders_count": 1,
      "state": "disabled",
      "total_spent": "91.55",
      "last_order_id": 4605156589725,
      "note": null,
      "verified_email": true,
      "multipass_identifier": null,
      "tax_exempt": false,
      "tags": "newsletter",
      "last_order_name": "#76339",
      "currency": "USD",
      "phone": null,
      "accepts_marketing_updated_at": "2022-08-06T10:07:18-04:00",
      "marketing_opt_in_level": "confirmed_opt_in",
      "tax_exemptions": [],
      "sms_marketing_consent": null,
      "admin_graphql_api_id": "gid:\/\/shopify\/Customer\/6257118249117",
      "default_address": {
        "id": 7634206851229,
        "customer_id": 6257118249117,
        "first_name": "Ashley",
        "last_name": "West",
        "company": null,
        "address1": "5710 Sw Fairlawn Dr",
        "address2": "",
        "city": "Topeka",
        "province": "Kansas",
        "country": "United States",
        "zip": "66619",
        "phone": "(785) 554-0858",
        "name": "Ashley West",
        "province_code": "KS",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    },
    "discount_applications": [
      {
        "target_type": "line_item",
        "type": "discount_code",
        "value": "10.0",
        "value_type": "fixed_amount",
        "allocation_method": "across",
        "target_selection": "all",
        "code": "WE10B2ZK5TZF"
      }
    ],
    "fulfillments": [
      {
        "id": 4073809346717,
        "admin_graphql_api_id": "gid:\/\/shopify\/Fulfillment\/4073809346717",
        "created_at": "2022-08-07T18:04:15-04:00",
        "location_id": 65247936669,
        "name": "#76339.1",
        "order_id": 4605156589725,
        "origin_address": {},
        "receipt": {},
        "service": "manual",
        "shipment_status": "confirmed",
        "status": "success",
        "tracking_company": "USPS",
        "tracking_number": "9361289680013547433538",
        "tracking_numbers": [
          "9361289680013547433538"
        ],
        "tracking_url": "https:\/\/tools.usps.com\/go\/TrackConfirmAction?tLabels=9361289680013547433538",
        "tracking_urls": [
          "https:\/\/tools.usps.com\/go\/TrackConfirmAction?tLabels=9361289680013547433538"
        ],
        "updated_at": "2022-08-10T04:24:36-04:00",
        "line_items": [
          {
            "id": 11393127809181,
            "admin_graphql_api_id": "gid:\/\/shopify\/LineItem\/11393127809181",
            "destination_location": {
              "id": 3543005986973,
              "country_code": "US",
              "province_code": "KS",
              "name": "Ashley West",
              "address1": "5710 Sw Fairlawn Dr",
              "address2": "5710 Sw Fairlawn Rd",
              "city": "Topeka",
              "zip": "66619"
            },
            "fulfillable_quantity": 0,
            "fulfillment_service": "manual",
            "fulfillment_status": "fulfilled",
            "gift_card": false,
            "grams": 283,
            "name": "Men's Brooks Ghost 13 - 9.5 \/ White\/Grey\/Deep Cobalt \/ B",
            "origin_location": {
              "id": 2902950248605,
              "country_code": "US",
              "province_code": "VA",
              "name": "Pacers Running",
              "address1": "3100 Clarendon Boulevard",
              "address2": "",
              "city": "Arlington",
              "zip": "22201"
            },
            "price": "99.95",
            "price_set": {
              "shop_money": {
                "amount": "99.95",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "99.95",
                "currency_code": "USD"
              }
            },
            "product_exists": true,
            "product_id": 6631698432157,
            "properties": [],
            "quantity": 1,
            "requires_shipping": true,
            "sku": "110348-161-9.5B",
            "taxable": true,
            "title": "Men's Brooks Ghost 13",
            "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": 39571445350557,
            "variant_inventory_management": "shopify",
            "variant_title": "9.5 \/ White\/Grey\/Deep Cobalt \/ B",
            "vendor": "Brooks",
            "tax_lines": [],
            "duties": [],
            "discount_allocations": [
              {
                "amount": "9.84",
                "amount_set": {
                  "shop_money": {
                    "amount": "9.84",
                    "currency_code": "USD"
                  },
                  "presentment_money": {
                    "amount": "9.84",
                    "currency_code": "USD"
                  }
                },
                "discount_application_index": 0
              }
            ]
          }
        ]
      }
    ],
    "line_items": [
      {
        "id": 11393127776413,
        "admin_graphql_api_id": "gid:\/\/shopify\/LineItem\/11393127776413",
        "destination_location": {
          "id": 3543005986973,
          "country_code": "US",
          "province_code": "KS",
          "name": "Ashley West",
          "address1": "5710 Sw Fairlawn Dr",
          "address2": "5710 Sw Fairlawn Rd",
          "city": "Topeka",
          "zip": "66619"
        },
        "fulfillable_quantity": 1,
        "fulfillment_service": "manual",
        "fulfillment_status": null,
        "gift_card": false,
        "grams": 0,
        "name": "Honey Stinger Energy Gel - Gold",
        "origin_location": {
          "id": 2902950248605,
          "country_code": "US",
          "province_code": "VA",
          "name": "Pacers Running",
          "address1": "3100 Clarendon Boulevard",
          "address2": "",
          "city": "Arlington",
          "zip": "22201"
        },
        "price": "1.60",
        "price_set": {
          "shop_money": {
            "amount": "1.60",
            "currency_code": "USD"
          },
          "presentment_money": {
            "amount": "1.60",
            "currency_code": "USD"
          }
        },
        "product_exists": true,
        "product_id": 6846820286621,
        "properties": [],
        "quantity": 1,
        "requires_shipping": true,
        "sku": "70024",
        "taxable": true,
        "title": "Honey Stinger Energy Gel",
        "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": 40453498568861,
        "variant_inventory_management": "shopify",
        "variant_title": "Gold",
        "vendor": "Honey Stinger",
        "tax_lines": [],
        "duties": [],
        "discount_allocations": [
          {
            "amount": "0.16",
            "amount_set": {
              "shop_money": {
                "amount": "0.16",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "0.16",
                "currency_code": "USD"
              }
            },
            "discount_application_index": 0
          }
        ]
      },
      {
        "id": 11393127809181,
        "admin_graphql_api_id": "gid:\/\/shopify\/LineItem\/11393127809181",
        "destination_location": {
          "id": 3543005986973,
          "country_code": "US",
          "province_code": "KS",
          "name": "Ashley West",
          "address1": "5710 Sw Fairlawn Dr",
          "address2": "5710 Sw Fairlawn Rd",
          "city": "Topeka",
          "zip": "66619"
        },
        "fulfillable_quantity": 0,
        "fulfillment_service": "manual",
        "fulfillment_status": "fulfilled",
        "gift_card": false,
        "grams": 283,
        "name": "Men's Brooks Ghost 13 - 9.5 \/ White\/Grey\/Deep Cobalt \/ B",
        "origin_location": {
          "id": 2902950248605,
          "country_code": "US",
          "province_code": "VA",
          "name": "Pacers Running",
          "address1": "3100 Clarendon Boulevard",
          "address2": "",
          "city": "Arlington",
          "zip": "22201"
        },
        "price": "99.95",
        "price_set": {
          "shop_money": {
            "amount": "99.95",
            "currency_code": "USD"
          },
          "presentment_money": {
            "amount": "99.95",
            "currency_code": "USD"
          }
        },
        "product_exists": true,
        "product_id": 6631698432157,
        "properties": [],
        "quantity": 1,
        "requires_shipping": true,
        "sku": "110348-161-9.5B",
        "taxable": true,
        "title": "Men's Brooks Ghost 13",
        "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": 39571445350557,
        "variant_inventory_management": "shopify",
        "variant_title": "9.5 \/ White\/Grey\/Deep Cobalt \/ B",
        "vendor": "Brooks",
        "tax_lines": [],
        "duties": [],
        "discount_allocations": [
          {
            "amount": "9.84",
            "amount_set": {
              "shop_money": {
                "amount": "9.84",
                "currency_code": "USD"
              },
              "presentment_money": {
                "amount": "9.84",
                "currency_code": "USD"
              }
            },
            "discount_application_index": 0
          }
        ]
      }
    ],
    "payment_terms": null,
    "refunds": [],
    "shipping_address": {
      "first_name": "Ashley",
      "address1": "5710 Sw Fairlawn Dr",
      "phone": "(785) 554-0858",
      "city": "Topeka",
      "zip": "66619",
      "province": "Kansas",
      "country": "United States",
      "last_name": "West",
      "address2": "pipe17 test p.o. box",
      "company": null,
      "latitude": 38.9634236,
      "longitude": -95.7405216,
      "name": "Ashley West",
      "country_code": "US",
      "province_code": "KS"
    },
    "shipping_lines": [
      {
        "id": 3798756294813,
        "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": []
      }
    ]
  }
}

      2. Product