Order and Fulfillment API

 

Authentication Request 

Resource Name

Authentication

URL

/login

Method

POST

Headers

  • username

  • password

  • x-api-key

Response Body

{
"id": "",
"firstName": "fenixname",
"lastName": "Dev",
"phone": null,
"emailId": "fenixname",
"type": "business_user",
"status": "ACTIVE",
"organizationId": "",
"authToken": "MWI2MjcwMTMwhZjQzZDJkMmNmNTI",
"x-identity": "dd704b93ecedc04c87fda804c"
}

 

  • authToken get expired every 24hrs(UTC)

  • x-identity will be rotated once every three months

  • x-api-key will be rotated once every six months

Order API 

Resource Name

Rest Endpoint to send the order data information Fenix

Resource URL

/api/v1/orders/{order_id}/created

Method

POST

Headers

  • store_name

  • authToken

  • x-api-key

  • x-identity

  • content-type

Request Payload

{

            "id": "18879048253891",

            "number": "#859731",

            "status": "NA",

            "fulfillment_status": "PARTIALLY_FILLED",

            "item_quantity": 2,

            "total_weight": {

                        "value": 18,

                        "units": "oz"

            },

            "shipping_info": {

                        "code": "FEDEX_2_DAY",

                        "title": "Express (Est Delivery by Wednesday, Dec 4 , 2019)",

                        "price": {

                                    "value": 14.99,

                                    "currency": "USD"

                        },

                        "discount": {

                                    "value": 0,

                                    "currency": "USD"

                        },

                        "source": "Fennix Commerce"

            },

            "updated_at": "2020-01-23T10:14:15-05:00",

            "created_at": "2020-01-23T10:14:15-05:00",

            "cancelled_at": null,

            "cancel_reason": null,

            "closed_at": null,

            "currency": "USD",

            "shipping_address": {

                        "first_name": "Srinivas",

                        "last_name": "Aluri",

                        "company": null,

                        "address1": "1345  Serenity Street",

                        "address2": "",

                        "country": "United States",

                        "country_code": "US",

                        "province": "North Carolina",

                        "province_code": "NC",

                        "city": "Huntersville",

                        "zip": "28078",

                        "latitude": "35.4234431",

                        "longitude": "-80.85062322"

            },

            "billing_address": {

                        "first_name": "Srinivas",

                        "last_name": "Aluri",

                        "company": null,

                        "address1": "1345  Serenity Street",

                        "address2": "",

                        "country": "United States",

                        "country_code": "US",

                        "province": "North Carolina",

                        "province_code": "NC",

                        "city": "Huntersville",

                        "zip": "28078",

                        "latitude": "35.4234431",

                        "longitude": "-80.85062322"

            },

            "line_items": [{

                        "sku": "CAAD Optimo 3",

                        "quantity": 1,

                        "title": "Standard (Est Delivery by Monday, Dec 16)",

                        "product_id": "43515734262211",

                        "product_name": "CAAD Optimo",

                        "variant_id": "43515734262211",

                        "variant_name": "cannondale",

                        "vendor": "cannondale",

                        "taxable": true,

                        "gift_card": false,

                        "tags": [],

                        "weight": {

                                    "value": 0,

                                    "units": "oz"

                        },

                        "dimensions": {

                                    "length": 8,

                                    "width": 6,

                                    "height": 5,

                                    "girth": 3,

                                    "thickness": 0,

                                    "units": "IN"

                        },

                        "price": {

                                    "value": 15,

                                    "currency": "USD"

                        },

                        "image_url": "",

                        "properties": [{

                                    "name": "Property Name",

                                    "value": "Property Value"

                        }]

            }],

            "financial_details": {

                        "subtotal_price": {

                                    "value": 145,

                                    "currency": "USD"

                        },

                        "total_tax": {

                                    "value": null,

                                    "currency": "USD"

                        },

                        "total_discounts": {

                                    "value": null,

                                    "currency": "USD"

                        },

                        "total_price": {

                                    "value": 159.99,

                                    "currency": "USD"

                        },

                        "taxes_included": false,

                        "financial_status": "paid",

                        "gateway": "shopify_payments"

            },

"customer":{
"first_name": "John",
"last_name": "Corner",
"email":"john1234@gmail.com",
"phone":9999000000,
"tags":[],
"address":{
"province_code": "SC",
"cou ntry_code": "US",
"country_name": "United States"
"zip": "29572",
"address1": "704 40th St S",
"address2": "",
"city": "North Myrtle Beach",
"province": "South Carolina",
"country": "United States"
}
},  “checkout_token“: ”3513625886”,

"tags": [],

"properties": [{

                        "name": "Property Name",

                        "value": "Property Value"

            }]

}

Response Payload

NA

Response Status

201 - Success

400 – Failure

401 - Un-Authentication

 Note: Date and time must be associated with zone (e.g., 2020-01-23T10:14:15-05:00)

 Once data is successfully sent to Fenix commerce. Retailers can able to see the data in the order summary Grid

  • Order details will be visible by clicking on the order number

Order Insights

 

Order Summary

Order Details

 

Fulfillment API

Resource Name

Rest Endpoint to send the fulfilment data Information Fenix

Resource URL

/api/v1/order/{order_id}/fulfillment/{fulfillment_id}/created

Method

POST

Headers

  • store_name

  • authToken

  • x-api-key

  • x-identity

  • content-type

Request Payload

{

            "id": "17773197066691",

            "order_id": "18879048253892",

            "shipment_status": "INTRANSIT",

            "createdAt": "2019-12-01T00:51:39-05:00",

            "updatedAt": "2019-12-01T00:51:39-05:00",

            "shipment_info": {

                        "tracking_number": "1Z2FE6220199363003",

                        "tracking_company": "UPS",

                        "shipping_service": "manual",

                        "shipcost": {

                                    "value": 15,

                                    "currency": "USD"

                        }

            },

            "line_items": [{

                        "sku": "CAAD Optimo 3",

                        "quantity": 1,

                        "title": "CAAD Optimo",

                        "product_id": "43515734262211",

                        "product_name": "CAAD Optimo",

                        "variant_id": "43515734262211",

                        "variant_name": "cannondale",

                        "vendor": "cannondale",

                        "taxable": true,

                        "gift_card": false,

                        "tags": [],

                        "weight": {

                                    "value": 0,

                                    "units": "oz"

                        },

                        "dimensions": {},

                        "price": {

                                    "value": 15,

                                    "currency": "USD"

                        },

                        "image_url": null,

                        "properties": [{

                                    "name": "Property Name",

                                    "value": "Property Value"

                        }]

            }]

}

Response Payload

NA

Response Status

201 - Success

400 – Failure

401 - Un-Authentication

 

Note: Date and time must be associated with zone (e.g., 2020-01-23T10:14:15-05:00) 

Shipment Summary View