Shopify Order JSON Activity ‐ Backorder Regular BOPIS - Sandesh3003/foundation GitHub Wiki
Backorder + Regular BOPIS order JSON
{
"order": {
"id": 5525047083261,
"admin_graphql_api_id": "gid://shopify/Order/5525047083261",
"app_id": 580111,
"browser_ip": "111.118.250.178",
"buyer_accepts_marketing": false,
"cancel_reason": null,
"cancelled_at": null,
"cart_token": "",
"checkout_id": 34879337103613,
"checkout_token": "",
"client_details": {
"accept_language": "en-US",
"browser_height": null,
"browser_ip": "111.118.250.178",
"browser_width": null,
"session_hash": null,
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36"
},
"closed_at": null,
"company": null,
"confirmed": true,
"contact_email": "[email protected]",
"created_at": "2024-02-13T00:25:12-05:00",
"currency": "USD",
"current_subtotal_price": "89.00",
"current_subtotal_price_set": {
"shop_money": {
"amount": "89.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "89.00",
"currency_code": "USD"
}
},
"current_total_additional_fees_set": null,
"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": "89.00",
"current_total_price_set": {
"shop_money": {
"amount": "89.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "89.00",
"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": [],
"email": "[email protected]",
"estimated_taxes": false,
"financial_status": "authorized",
"fulfillment_status": null,
"landing_site": "/",
"landing_site_ref": null,
"location_id": null,
"merchant_of_record_app_id": null,
"name": "#2017",
"note": null,
"note_attributes": [],
"number": 1017,
"order_number": 2017,
"order_status_url": "https://hc-sandbox.myshopify.com/",
"original_total_additional_fees_set": null,
"original_total_duties_set": null,
"payment_gateway_names": [
"shopify_payments"
],
"phone": null,
"presentment_currency": "USD",
"processed_at": "2024-02-13T00:25:07-05:00",
"reference": "f375690acf9bde2294736a9565fa454a",
"referring_site": "",
"source_identifier": "f375690acf9bde2294736a9565fa454a",
"source_name": "web",
"source_url": null,
"subtotal_price": "89.00",
"subtotal_price_set": {
"shop_money": {
"amount": "89.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "89.00",
"currency_code": "USD"
}
},
"tags": "",
"tax_lines": [],
"taxes_included": false,
"test": true,
"token": "",
"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": "89.00",
"total_line_items_price_set": {
"shop_money": {
"amount": "89.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "89.00",
"currency_code": "USD"
}
},
"total_outstanding": "0.00",
"total_price": "89.00",
"total_price_set": {
"shop_money": {
"amount": "89.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "89.00",
"currency_code": "USD"
}
},
"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": 350,
"updated_at": "2024-02-13T00:25:18-05:00",
"user_id": null,
"billing_address": {
"first_name": "Muskan",
"address1": "123 NY-59",
"phone": null,
"city": "Nanuet",
"zip": "10954",
"province": "New York",
"country": "United States",
"last_name": "Pahwa",
"address2": null,
"company": null,
"latitude": 41.0944461,
"longitude": -74.0058562,
"name": "Muskan Pahwa",
"country_code": "US",
"province_code": "NY"
},
"customer": {
"id": 7133450502397,
"email": "[email protected]",
"created_at": "2024-01-19T04:06:05-05:00",
"updated_at": "2024-02-13T00:25:13-05:00",
"first_name": "Muskan",
"last_name": "Pahwa",
"state": "disabled",
"note": null,
"verified_email": true,
"multipass_identifier": null,
"tax_exempt": false,
"phone": null,
"email_marketing_consent": {
"state": "not_subscribed",
"opt_in_level": "single_opt_in",
"consent_updated_at": null
},
"sms_marketing_consent": null,
"tags": "",
"currency": "USD",
"accepts_marketing": false,
"accepts_marketing_updated_at": "2024-01-19T04:06:05-05:00",
"marketing_opt_in_level": null,
"tax_exemptions": [],
"admin_graphql_api_id": "gid://shopify/Customer/7133450502397",
"default_address": {
"id": 8768055804157,
"customer_id": 7133450502397,
"first_name": "Muskan",
"last_name": "Pahwa",
"company": null,
"address1": "123 NY-59",
"address2": null,
"city": "Nanuet",
"province": "New York",
"country": "United States",
"zip": "10954",
"phone": null,
"name": "Muskan Pahwa",
"province_code": "NY",
"country_code": "US",
"country_name": "United States",
"default": true
}
},
"discount_applications": [],
"fulfillments": [],
"line_items": [
{
"id": 13666994159869,
"admin_graphql_api_id": "gid://shopify/LineItem/13666994159869",
"fulfillable_quantity": 1,
"fulfillment_service": "manual",
"fulfillment_status": null,
"gift_card": false,
"grams": 50,
"name": "Inter Miami Messi Away Jersey",
"price": "50.00",
"price_set": {
"shop_money": {
"amount": "50.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "50.00",
"currency_code": "USD"
}
},
"product_exists": true,
"product_id": 8279602168061,
"properties": [],
"quantity": 1,
"requires_shipping": true,
"sku": "123456789",
"taxable": true,
"title": "Inter Miami Messi Away Jersey",
"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": 44502451716349,
"variant_inventory_management": "shopify",
"variant_title": null,
"vendor": "HC Demo",
"tax_lines": [],
"duties": [],
"discount_allocations": []
},
{
"id": 13666994192637,
"admin_graphql_api_id": "gid://shopify/LineItem/13666994192637",
"fulfillable_quantity": 1,
"fulfillment_service": "manual",
"fulfillment_status": null,
"gift_card": false,
"grams": 300,
"name": "Ariel Roll Sleeve Sweatshirt - XS / Green",
"price": "39.00",
"price_set": {
"shop_money": {
"amount": "39.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "39.00",
"currency_code": "USD"
}
},
"product_exists": true,
"product_id": 8074458366205,
"properties": [
{
"name": "Note",
"value": "Back Order"
},
{
"name": "PROMISE_DATE",
"value": "Usually ships in 2-3 weeks"
}
],
"quantity": 1,
"requires_shipping": true,
"sku": "WH09-XS-Green",
"taxable": true,
"title": "Ariel Roll Sleeve Sweatshirt",
"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": 43899530313981,
"variant_inventory_management": "shopify",
"variant_title": "XS / Green",
"vendor": "HotWax",
"tax_lines": [],
"duties": [],
"discount_allocations": []
}
],
"payment_terms": null,
"refunds": [],
"shipping_address": {
"first_name": "Muskan",
"address1": "123 NY-59",
"phone": null,
"city": "Nanuet",
"zip": "10954",
"province": "New York",
"country": "United States",
"last_name": "Pahwa",
"address2": null,
"company": null,
"latitude": null,
"longitude": null,
"name": "Muskan Pahwa",
"country_code": "US",
"province_code": "NY"
},
"shipping_lines": [
{
"id": 4547143958781,
"carrier_identifier": "650f1a14fa979ec5c74d063e968411d4",
"code": "Store Pickup",
"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": "Store Pickup",
"tax_lines": [],
"discount_allocations": []
}
]
}
}
Brief about the JSON Data :
This JSON data about order represents a BOPIS order with two order items representing :
- Backorder order
- Regular BOPIS
This JSON provides various information related to order:
- Customer Details
- Products ordered
- Order adjustments (Discount and Taxes)
- Payment Method
- Shipment Details
- Vendor Details
- Price Details
Mapping JSON Data:
Let's understand and map this JSON data with this graph:
XML Mapping
Creating Party
<Party partyId="CSTMR1000"
partyTypeId="PERSON"
externalId="7133450502397"
statusId="PARTY_DISABLED"
createdDate="2024-01-19 04:06:05.000"
preferredCurrencyUomId="USD"
/>
<Person partyId="CSTMR1000"
firstName="Muskan"
lastName="Pahwa"
createdDate="2024-01-19 04:06:05.000"
/>
Creating contact mechanisms for the created party -->
<ContactMech contactMechId="CSCTM1000A"
contactMechTypeId="EMAIL_ADDRESS"
parentTypeId="ELECTRONIC_ADDRESS"
infoString="[email protected]"
/>
<ContactMech contactMechId="CSCTM1000B"
contactMechTypeId="POSTAL_ADDRESS"
/>
<PostalAddress contactMechId="CSCTM1000B"
toName="Muskan Pahwa"
address1="123 NY-59"
city="Nanuet"
postalCode="10954"
stateProvinceGeoId="NY"
countryGeoId="US"
latitude="41.0944461"
longitude="-74.0058562"
/>
<PartyContactMech partyId="CSTMR1000"
contactMechId="CSCTM1000A"
roleTypeId="CUSTOMER"
fromDate="2024-01-19 04:06:05.000"
/>
<PartyContactMech partyId="CSTMR1000"
contactMechId="CSCTM1000B"
roleTypeId="CUSTOMER"
fromDate="2024-01-19 04:06:05.000"
/>
<PartyContactMechPurpose partyId="CSTMR1000"
contactMechId="CSTR1000B"
contactMechPurposeTypeId="PRIMARY_LOCATION"
fromDate="2024-01-19 04:06:05.000"
/>
<PartyContactMechPurpose partyId="CSTMR1000"
contactMechId="CSTR1000B"
contactMechPurposeTypeId="BILLING_LOCATION"
fromDate="2024-01-19 04:06:05.000"
/>
<PartyContactMechPurpose partyId="CSTMR1000"
contactMechId="CSTR1000B"
contactMechPurposeTypeId="SHIPPING_LOCATION"
fromDate="2024-01-19 04:06:05.000"
/>
Creating Product
<!-- Main Product 1 -->
<Product productId="DMP1000"
productName="Inter Miami Messi Away Jersey"
productTypeId="FINISHED_GOOD"
isVirtual="Y"
taxable="Y"
weightUomId="WT_g"
productWeight="50.00"
createdByUserLogin="admin"
primaryProductCategoryId="DS01"
/>
<ProductPrice productId="DMP1000"
productPriceTypeId="LIST_PRICE"
productPricePurposeId="PURCHASE"
currencyUomId="USD"
price="50.00"
createdByUserLogin="admin"
/>
<!-- Variant Product of main product 1 -->
<Product productId="DMP1000A"
productName="Inter Miami Messi Away Jersey"
productTypeId="FINISHED_GOOD"
isVariant="Y"
taxable="Y"
weightUomId="WT_g"
productWeight="50.00"
createdByUserLogin="admin"
primaryProductCategoryId="DS01"
/>
<ProductPrice productId="DMP1000A"
productPriceTypeId="LIST_PRICE"
productPricePurposeId="PURCHASE"
currencyUomId="USD"
price="50.00"
createdByUserLogin="admin"
/>
<!-- Associating Main Product with its variant -->
<ProductAssoc productId="DMP1000"
productIdTo="DMP1000A"
productAssocTypeId="PRODUCT_VARIANT"
fromDate="2024-01-19 04:06:05.000"
/>
<!-- Product Identification -->
<GoodIdentificationType goodIdentificationTypeId="SHOPIFY_PROD_ID"
hasTable="N"
description="Shopify Product ID"
/>
<GoodIdentificationType goodIdentificationTypeId="SHOPIFY_PROD_SKU"
hasTable="N"
description="Shopify Product SKU"
/>
<GoodIdentification goodIdentificationTypeId="SHOPIFY_PROD_ID"
productId="DMP1000"
idValue=" 8279602168061"
/>
<GoodIdentification goodIdentificationTypeId="SHOPIFY_PROD_ID"
productId="DMP1000A"
idValue="123456789"
/>
<GoodIdentification goodIdentificationTypeId="SHOPIFY_PROD_SKU"
productId="DMP1000"
idValue="WH09-XS-Green"
/>
<!-- Main Product 2-->
<Product productId="DMP1001"
productName="Ariel Roll Sleeve Sweatshirt"
productTypeId="FINISHED_GOOD"
isVirtual="Y"
virtualVariantMethodEnum="VV_VARIANTTREE"
taxable="Y"
weightUomId="WT_g"
productWeight="300.00"
createdByUserLogin="admin"
primaryProductCategoryId="DS01"
/>
<ProductPrice productId="DMP1001"
productPriceTypeId="LIST_PRICE"
productPricePurposeId="PURCHASE"
currencyUomId="USD"
price="39.00"
createdByUserLogin="admin"
/>
<ProductFeatureAppl productFeatureApplTypeId="SELECTABLE_FEATURE"
productFeatureId="10000"
productId="DMP1001"
/>
<ProductFeatureAppl productFeatureApplTypeId="SELECTABLE_FEATURE"
productFeatureId="10010"
productId="DMP1001"
/>
<!-- Product Variants of main product 2-->
<Product productId="DMP1001A"
productName="Ariel Roll Sleeve Sweatshirt - XS/Green"
productTypeId="FINISHED_GOOD"
isVariant="Y"
taxable="Y"
weightUomId="WT_g"
productWeight="300.00"
createdByUserLogin="admin"
primaryProductCategoryId="DS01"
/>
<ProductPrice productId="DMP1001"
productPriceTypeId="LIST_PRICE"
productPricePurposeId="PURCHASE"
currencyUomId="USD"
price="39.00"
createdByUserLogin="admin"
/>
<ProductFeatureAppl productFeatureApplTypeId="STANDARD_FEATURE"
productFeatureId="10000"
productId="DMP1001A"
/>
<ProductFeatureAppl productFeatureApplTypeId="STANDARD_FEATURE"
productFeatureId="10010"
productId="DMP1001A"
/>
<!-- Association of virtual product with its variant product -->
<ProductAssoc productId="DMP1001"
productIdTo="DMP1001A"
productAssocTypeId="PRODUCT_VARIANT"
fromDate="2024-01-19 04:06:05.000"
/>
<GoodIdentification goodIdentificationTypeId="SHOPIFY_PROD_ID"
productId="DMP1001"
idValue="8074458366205"
/>
<GoodIdentification goodIdentificationTypeId="SHOPIFY_PROD_ID"
productId="DMP1001A"
idValue="43899530313981"
/>
<GoodIdentification goodIdentificationTypeId="SHOPIFY_PROD_SKU"
productId="DMP1001A"
idValue="WH09-XS-Green"
/>
Creating facility for backorder parking
<FacilityType facilityTypeId="VIRTUAL_FACILITY"/>
<FacilityType facilityTypeId="BACKORDER"
parentTypeId="VIRTUAL_FACILITY"
/>
<Facility facilityId="BACKORDER_PARKING"
facilityTypeId="BACKORDER"
facilityName="Backorder Parking"
description="Backorder Parking"
/>
<!-- Adjusting facility for BOPIS Products -->
<ProductFacility productId="DMP1000A"
facilityId="MyRetailStore"
minimumStock="2.00"
reorderQuantity="10.0000"
allowBopis="Y"
allowPickup="Y"
/>
Creating Shipment method Store pickup
<ShipmentMethodType shipmentMethodTypeId="STOREPICKUP"
description="Store Pickup"
/>
Ordering
<OrderHeader createdBy="[email protected]"
currencyUom="USD"
entryDate="2024-02-13 00:25:12.0000"
grandTotal="89.00"
invoicePerShipment="Y"
orderDate="2024-02-13 00:25:07.0000"
orderId="HWCDEMO2017"
orderName="#2017"
externalId="5525047083261"
orderTypeId="SALES_ORDER"
originFacilityId="MyRetailStore"
priority="2"
productStoreId="9100"
remainingSubTotal="0.00"
salesChannelEnumId="WEB_SALES_CHANNEL"
statusId="ORDER_CREATED"
webSiteId="WebStore"
/>
<OrderStatus orderId="HWCDEMO2017"
orderStatusId="HWCDEMO2017S0"
statusId="ORDER_CREATED"
statusDateTime="2024-02-13 00:25:12.0000"
statusUserLogin="[email protected]"
/>
<OrderRole orderId="HMCDEMO2017"
partyId="CSTMR1000"
roleTypeId="PLACING_CUSTOMER"/>
<OrderRole orderId="HMCDEMO2017"
partyId="CSTMR1000"
roleTypeId="BILL_TO_CUSTOMER"/>
<OrderContactMech orderId="HMCDEMO2017"
contactMechPurposeTypeId="BILLING_LOCATION"
contactMechId="CSCTM1000B"
/>
<OrderContactMech orderId="HMCDEMO2017"
contactMechPurposeTypeId="SHIPPING_LOCATION"
contactMechId="CSCTM1000B"
/>
<OrderContactMech orderId="HMCDEMO2017"
contactMechPurposeTypeId="ORDER_EMAIL"
contactMechId="CSCTM1000A"
/>
<OrderItem changeByUserLoginId="[email protected]"
isModifiedPrice="N"
isPromo="N"
itemDescription="Inter Miami Messi Away Jersey"
orderId="HWCDEMO2017"
orderItemSeqId="00001"
externalId="13666994159869"
orderItemTypeId="PRODUCT_ORDER_ITEM"
prodCatalogId="ANIME01"
productCategoryId="DS01"
productId="DMP1000A"
quantity="1.000000"
selectedAmount="0.000000"
statusId="ITEM_CREATED"
unitListPrice="50.000"
unitPrice="50.000"
/>
<OrderStatus orderId="HWCDEMO2017"
orderItemSeqId ="00001"
orderStatusId="HWCDEMO2017S0I0"
statusId="ITEM_CREATED"
statusDateTime="2024-02-13 00:25:12.0000"
statusUserLogin="[email protected]"
/>
<OrderItem changeByUserLoginId="[email protected]"
isModifiedPrice="N"
isPromo="N"
itemDescription="Ariel Roll Sleeve Sweatshirt - XS / Green"
orderId="HWCDEMO2017"
orderItemSeqId="00002"
externalId="13666994192637"
orderItemTypeId="PRODUCT_ORDER_ITEM"
prodCatalogId="ANIME01"
productCategoryId="DS01"
productId="DMP1000B"
quantity="1.000000"
selectedAmount="0.000000"
statusId="ITEM_CREATED"
unitListPrice="39.000"
unitPrice="39.000"
/>
<OrderStatus orderId="HWCDEMO2017"
orderItemSeqId ="00002"
orderStatusId="HWCDEMO2017S0I0"
statusId="ITEM_CREATED"
statusDateTime="2024-02-13 00:25:12.0000"
statusUserLogin="[email protected]"
/>
<!-- Back order tag -->
<OrderItemAttribute orderId="HWCDEMO2017"
orderItemSeqId="00002"
attrName="NOTE"
attrValue="BACK_ORDER"
/>
<OrderItemAttribute orderId="HWCDEMO2017"
orderItemSeqId="00002"
attrName="PROMISE_DATE"
attrValue="Usually ships in 2-3 weeks"
/>
<!-- Shipping Lines or ship group -->
<OrderItemShipGroup shipmentMethodTypeId="STOREPICKUP"
carrierPartyId="_NA_"
facilityId="BACKORDER_PARKING"
orderId="HWCDEMO2017"
shipGroupSeqId="00001"
shipmentMethodTypeId="STOREPICKUP"
/>
<!-- Order Adjustments details(shipping charges, discount, taxes and additional charges) -->
<OrderAdjustment amount="0.000"
createdByUserLogin="[email protected]"
orderAdjustmentId="HWCOA1000"
orderAdjustmentTypeId="SHIPPING_CHARGES"
orderId="HWCDEMO2017"
orderItemSeqId="_NA_"
shipGroupSeqId="00001"
/>
<OrderAdjustment amount="0.000"
createdByUserLogin="[email protected]"
orderAdjustmentId="HWCOA1001"
orderAdjustmentTypeId="ADDITIONAL_FEATURE"
orderId="HWCDEMO2017"
orderItemSeqId="_NA_"
shipGroupSeqId="00001"
/>
<OrderAdjustment amount="0.000"
createdByUserLogin="[email protected]"
orderAdjustmentId="HWCOA1002"
orderAdjustmentTypeId="SALES_TAX"
orderId="HWCDEMO2017"
orderItemSeqId="_NA_"
shipGroupSeqId="00001"
/>
<OrderAdjustment amount="0.000"
createdByUserLogin="[email protected]"
orderAdjustmentId="HWCOA1003"
orderAdjustmentTypeId="DISCOUNT_ADJUSTMENT"
orderId="HWCDEMO2017"
orderItemSeqId="_NA_"
shipGroupSeqId="00001"
/>
<!-- Payment Details -->
<PaymentMethodType paymentMethodTypeId="EXT_SHOPIFY"
description="Shopify Payment"
/>
<OrderPaymentPreference createdByUserLogin="[email protected]"
maxAmount="89.00"
orderId="HWCDEMO2017"
orderPaymentPreferenceId="HWCPMT0001"
overflowFlag="N"
paymentMethodTypeId="EXT_SHOPIFY"
presentFlag="N"
processAttempt="1"
statusId="PAYMENT_AUTHORIZED"
swipedFlag="N"
/>