Request Parameters:


Submits the return request for order.


URL: ../Api/Client/ShipmentDetails 


Header:

Content-Type:application/json


Required Parameters :  CustomerGUID, ShipmentId


Resource string : Plugins.XcellenceIT.WebApiClient.Message.Order.NotFoundForShipment


Case-1. Exception Response :
Parameter:

{    

     "ApiSecretKey":"i99b98d117m116a112o98k115c111",

     "CustomerGUID":"496DBB2A-F9EB-4522-A804-B108693B69CE",

     "LanguageId": "1",

     "ShipmentId":""

}
Response :
{

    "Status": 0,

    "Message": "Request cannot be empty",

    "Data": null,

    "ValidationMessage": [],

    "ErrorMessage": null

}


Case-2. Validating parameters :
{    

     "ApiSecretKey":"i99b98d117m116a112o98k115c111",

     "CustomerGUID":"496DBB2A-F9EB-4522-A804-B108693B69CE",

    "LanguageId": "1",

     "ShipmentId":"1"

}


Response :
{

    "Status": 0,

    "Message": "Order not found for shipment id : 1",

    "Data": null,

    "ValidationMessage": [],

    "ErrorMessage": null

}


Case-3. Success Response :
Parameter:

{    

     "ApiSecretKey":"i99b98d117m116a112o98k115c111",

     "CustomerGUID":"496DBB2A-F9EB-4522-A804-B108693B69CE",

     "LanguageId": "1",

     "ShipmentId":"6"

}

Response :

{

    "Status": 1,

    "Message": "Success",

    "Data": {

        "TrackingNumber": "123",

        "TrackingNumberUrl": null,

        "ShippedDate": "2021-05-18T10:20:21",

        "DeliveryDate": "2021-05-18T10:20:23",

        "ShipmentStatusEvents": [],

        "ShowSku": true,

        "Items": [

            {

                "Sku": "AP_MBP_13",

                "ProductId": 4,

                "ProductName": "Apple MacBook Pro 13-inch",

                "ProductSeName": "apple-macbook-pro-13-inch",

                "AttributeInfo": "",

                "RentalInfo": null,

                "QuantityOrdered": 2,

                "QuantityShipped": 2,

                "Id": 6,

                "CustomProperties": {}

            }

        ],

        "Order": {

            "PrintMode": false,

            "PdfInvoiceDisabled": false,

            "CustomOrderNumber": "7",

            "CreatedOn": "2021-05-18T09:58:01",

            "OrderStatus": "Complete",

            "IsReOrderAllowed": true,

            "IsReturnRequestAllowed": true,

            "IsShippable": true,

            "PickupInStore": false,

            "PickupAddress": {

                "FirstName": null,

                "LastName": null,

                "Email": null,

                "CompanyEnabled": false,

                "CompanyRequired": false,

                "Company": null,

                "CountryEnabled": false,

                "CountryId": null,

                "CountryName": null,

                "StateProvinceEnabled": false,

                "StateProvinceId": null,

                "StateProvinceName": null,

                "CountyEnabled": false,

                "CountyRequired": false,

                "County": null,

                "CityEnabled": false,

                "CityRequired": false,

                "City": null,

                "StreetAddressEnabled": false,

                "StreetAddressRequired": false,

                "Address1": null,

                "StreetAddress2Enabled": false,

                "StreetAddress2Required": false,

                "Address2": null,

                "ZipPostalCodeEnabled": false,

                "ZipPostalCodeRequired": false,

                "ZipPostalCode": null,

                "PhoneEnabled": false,

                "PhoneRequired": false,

                "PhoneNumber": null,

                "FaxEnabled": false,

                "FaxRequired": false,

                "FaxNumber": null,

                "AvailableCountries": [],

                "AvailableStates": [],

                "FormattedCustomAddressAttributes": null,

                "CustomAddressAttributes": [],

                "Id": 0,

                "CustomProperties": {}

            },

            "ShippingStatus": "Delivered",

            "ShippingAddress": {

                "FirstName": "John",

                "LastName": "Smith",

                "Email": "admin@yourStore.com",

                "CompanyEnabled": true,

                "CompanyRequired": false,

                "Company": "Nop Solutions Ltd",

                "CountryEnabled": true,

                "CountryId": 237,

                "CountryName": "United States of America",

                "StateProvinceEnabled": true,

                "StateProvinceId": 1709,

                "StateProvinceName": "New York",

                "CountyEnabled": false,

                "CountyRequired": false,

                "County": null,

                "CityEnabled": true,

                "CityRequired": true,

                "City": "New York",

                "StreetAddressEnabled": true,

                "StreetAddressRequired": true,

                "Address1": "21 West 52nd Street",

                "StreetAddress2Enabled": true,

                "StreetAddress2Required": false,

                "Address2": "",

                "ZipPostalCodeEnabled": true,

                "ZipPostalCodeRequired": true,

                "ZipPostalCode": "10021",

                "PhoneEnabled": true,

                "PhoneRequired": true,

                "PhoneNumber": "12345678",

                "FaxEnabled": true,

                "FaxRequired": false,

                "FaxNumber": "",

                "AvailableCountries": [],

                "AvailableStates": [],

                "FormattedCustomAddressAttributes": "",

                "CustomAddressAttributes": [],

                "Id": 1031,

                "CustomProperties": {}

            },

            "ShippingMethod": "Ground",

            "Shipments": [

                {

                    "TrackingNumber": "123",

                    "ShippedDate": "2021-05-18T10:20:21",

                    "DeliveryDate": "2021-05-18T10:20:23",

                    "Id": 5,

                    "CustomProperties": {}

                }

            ],

            "BillingAddress": {

                "FirstName": "John",

                "LastName": "Smith",

                "Email": "admin@yourStore.com",

                "CompanyEnabled": true,

                "CompanyRequired": false,

                "Company": "Nop Solutions Ltd",

                "CountryEnabled": true,

                "CountryId": 237,

                "CountryName": "United States of America",

                "StateProvinceEnabled": true,

                "StateProvinceId": 1709,

                "StateProvinceName": "New York",

                "CountyEnabled": false,

                "CountyRequired": false,

                "County": null,

                "CityEnabled": true,

                "CityRequired": true,

                "City": "New York",

                "StreetAddressEnabled": true,

                "StreetAddressRequired": true,

                "Address1": "21 West 52nd Street",

                "StreetAddress2Enabled": true,

                "StreetAddress2Required": false,

                "Address2": "",

                "ZipPostalCodeEnabled": true,

                "ZipPostalCodeRequired": true,

                "ZipPostalCode": "10021",

                "PhoneEnabled": true,

                "PhoneRequired": true,

                "PhoneNumber": "12345678",

                "FaxEnabled": true,

                "FaxRequired": false,

                "FaxNumber": "",

                "AvailableCountries": [],

                "AvailableStates": [],

                "FormattedCustomAddressAttributes": "",

                "CustomAddressAttributes": [],

                "Id": 1030,

                "CustomProperties": {}

            },

            "VatNumber": null,

            "PaymentMethod": "Check / Money Order",

            "PaymentMethodStatus": "Paid",

            "CanRePostProcessPayment": false,

            "CustomValues": {},

            "OrderSubtotal": "$3,600.00",

            "OrderSubTotalDiscount": null,

            "OrderShipping": "$0.00",

            "PaymentMethodAdditionalFee": null,

            "CheckoutAttributeInfo": "Gift wrapping: No",

            "PricesIncludeTax": false,

            "DisplayTaxShippingInfo": false,

            "Tax": "$0.00",

            "TaxRates": [

                {

                    "Rate": "0",

                    "Value": "$0.00",

                    "CustomProperties": {}

                }

            ],

            "DisplayTax": true,

            "DisplayTaxRates": false,

            "OrderTotalDiscount": null,

            "RedeemedRewardPoints": 0,

            "RedeemedRewardPointsAmount": null,

            "OrderTotal": "$3,600.00",

            "GiftCards": [],

            "ShowSku": true,

            "Items": [

                {

                    "OrderItemGuid": "2b39d679-e9cf-4b5d-81ab-c19f20637455",

                    "Sku": "AP_MBP_13",

                    "ProductId": 4,

                    "ProductName": "Apple MacBook Pro 13-inch",

                    "ProductSeName": "apple-macbook-pro-13-inch",

                    "UnitPrice": "$1,800.00",

                    "SubTotal": "$3,600.00",

                    "Quantity": 2,

                    "AttributeInfo": "",

                    "RentalInfo": null,

                    "VendorName": "",

                    "DownloadId": 8,

                    "LicenseId": 0,

                    "Id": 14,

                    "CustomProperties": {}

                }

            ],

            "OrderNotes": [],

            "ShowVendorName": false,

            "Id": 7,

            "CustomProperties": {}

        },

        "Id": 5,

        "CustomProperties": {}

    },

    "ValidationMessage": [],

    "ErrorMessage": null

}