Shipping

With the following endpoints, you will be able to interact with the different Shipping options that you will find in Outshifter. You can create, update, edit and delete Shippings. Add new parameters to the shipping you have created and apply the changes to your products depending on your needs.
Get Shipping by Id
At any time you can retrieve shipping information with all the added parameters.
get
https://api.outshifter.com/api
/shipping/id/:shippingId
Get Shipping by Id
Response Example:
{
    "createdAt": "2022-12-06T12:49:01.033Z",
    "updatedAt": "2022-12-06T12:49:01.033Z",
    "id": "a96a9723-82c6-413f-8471-2e7ae1f2e99b",
    "amount": "10.00",
    "customPriceEnabled": false,
    "name": "Standard Shipping",
    "description": null,
    "deletedAt": null,
    "currencyCode": "NOK",
    "shippingCountry": []
}
Create Shipping
Create a custom shipping with customized details. Add the amount you are going to use, add a name to distinguish the shipping from the rest that you can find on the platform, and choose the currency that will be applied to the shipping.
post
https://api.outshifter.com/api
/shipping/create
Create Shipping
Body Example:
{
    "amount": 10,
    "name": "Standard Shipping",
    "currencyCode": "NOK"
}
Response Example:
{
    "name": "Standard Shipping",
    "amount": "10.00",
    "currencyCode": "NOK",
    "description": null,
    "customPriceEnabled": false,
    "deletedAt": null,
    "createdAt": "2022-12-06T11:07:34.793Z",
    "updatedAt": "2022-12-06T11:07:34.793Z",
    "id": "756bbfc8-a8df-48a5-95f3-9b986bb27859"
}
Update Shipping
When general information on shipping needs to be updated, you can use this endpoint.
You will have to get the shipping information and send in the request body with the updated data. Below you may find available updatable fields.
put
https://api.outshifter.com/api
/shipping/:shippingId
Update Shipping
Body Example:
{
    "amount": 100,
    "name": "Standard Shipping",
    "currencyCode": "NOK"
}
Response example:
{
    "createdAt": "2022-12-06T11:07:34.793Z",
    "updatedAt": "2022-12-06T11:11:16.000Z",
    "id": "756bbfc8-a8df-48a5-95f3-9b986bb27859",
    "amount": 100,
    "customPriceEnabled": false,
    "name": "Standard Shipping",
    "description": null,
    "deletedAt": null,
    "currencyCode": "NOK"
}
Delete Shipping
In case you need to delete shipping, it is possible via this endpoint.
delete
https://api.outshifter.com/api
/shipping/:shippingId
Delete Shipping
Response Example:
{
    "status": 200,
    "message": "Shipping deleted"
}
Add country to Shipping
post
https://api.outshifter.com/api
/shipping/add-country
Add country to Shipping
Body Example:
{
    "idShipping": "756bbfc8-a8df-48a5-95f3-9b986bb27859",
    "countries": [
        {
            "amount": 10,
            "currencyCode": "NOK",
            "country": "NO"
        }
    ]
​
}
Response Example:
{
    "createdAt": "2022-12-06T11:07:34.793Z",
    "updatedAt": "2022-12-06T11:11:16.000Z",
    "id": "756bbfc8-a8df-48a5-95f3-9b986bb27859",
    "amount": "100.00",
    "customPriceEnabled": false,
    "name": "Standard Shipping",
    "description": null,
    "deletedAt": null,
    "currencyCode": "NOK",
    "shippingCountry": [
        {
            "createdAt": "2022-12-06T11:33:02.120Z",
            "updatedAt": "2022-12-06T11:33:02.120Z",
            "id": "20b2d185-0c55-4183-8904-17c0621281dc",
            "amount": "10.00",
            "country": "NO",
            "deletedAt": null,
            "currencyCode": "NOK"
        }
    ]
}
Update country on Shipping
put
https://api.outshifter.com/api
/shipping/edit/country
Update country on Shipping
Body Response:
{
    "id": "20b2d185-0c55-4183-8904-17c0621281dc",
    "amount": 100,
    "country": "NO",
    "currencyCode":"EUR"
}
Response Example:
{
    "createdAt": "2022-12-06T11:07:34.793Z",
    "updatedAt": "2022-12-06T11:11:16.000Z",
    "id": "756bbfc8-a8df-48a5-95f3-9b986bb27859",
    "amount": "100.00",
    "customPriceEnabled": false,
    "name": "Standard Shipping",
    "description": null,
    "deletedAt": null,
    "currencyCode": "NOK",
    "shippingCountry": [
        {
            "createdAt": "2022-12-06T11:33:02.120Z",
            "updatedAt": "2022-12-06T11:36:40.000Z",
            "id": "20b2d185-0c55-4183-8904-17c0621281dc",
            "amount": "100.00",
            "country": "NO",
            "deletedAt": null,
            "currencyCode": "EUR"
        }
    ]
}
Delete Shipping Country
delete
https://api.outshifter.com/api
/shipping/delete/country/:shippingCountryId
Delete Shipping Country
Response Example:
{
    "status": 200,
    "message": "Delete success."
}
Associate Shipping to a Product
post
https://api.outshifter.com/api
/shipping/join-product
Associate Shipping to a Product
Body Example:
{
    "shippingId": "756bbfc8-a8df-48a5-95f3-9b986bb27859",
    "productsId": [4950, 4952, 4953]
}
Response Example:
{
    "status": 200,
    "message": ""
}
Delete Shipping associated to a Product
delete
https://api.outshifter.com/api
/shipping/delete/join
Delete Shipping associated to a Product
Response Example:
{
    "status": 200,
    "message": ""
}
Get the Shipping associated with a Product
get
https://api.outshifter.com/api
/shipping/product-id/:productId
Get the Shipping associated with a Product
Response Example:
[
    {
        "createdAt": "2022-12-06T11:07:34.793Z",
        "updatedAt": "2022-12-06T11:11:16.000Z",
        "id": "756bbfc8-a8df-48a5-95f3-9b986bb27859",
        "amount": "100.00",
        "customPriceEnabled": false,
        "name": "Standard Shipping",
        "description": null,
        "deletedAt": null,
        "currencyCode": "NOK",
        "shippingCountry": []
    }
]
​
Last modified 3mo ago