Carriers | Tajima Software Solutions Inc.

With the /Carriers endpoint user can manage Carriers from the database.

GET /api/Carriers/List Get a list of all Carriers

Request Example

    /api/Carriers/List

RESPONSE EXAMPLE

    [
        {
            "Id": "string",
            "MarketId": "string",
            "MarketName": "string",
            "Carrier": "string",
            "Account": "string",
            "ShipBillingMethod": "string",
            "ShipBillingZipCode": "string",
            "DefaultCarrier": true/false
        },
        {...}
    ]

GET /api/Carriers/Get Get a Carrier

Request Example

    /api/Carriers/Get?id=CarrierId&carrier=Carrier&marketName=MarketName
            Use id parameter to get CarrierCode by id or
            Use carrier and marketName parameter to get Carrier

RESPONSE EXAMPLE

    If found, a Carriers is returned with status code 200. Otherwise an error with code and message is returned with status code 404  
    {
        {
            "Id": "string",
            "MarketId": "string",
            "MarketName": "string",
            "Carrier": "string",
            "Account": "string",
            "ShipBillingMethod": "string",
            "ShipBillingZipCode": "string",
            "DefaultCarrier": true/false
        }
    }

POST /api/Carriers/Create Create a Carrier

Model Request Example

    {
        "Id": "string
        "Name": "string",
        "Code": "string"
    }

Response Example

If the operation is successful a Carrier will be returned with status code 201
Otherwise an error with code and message will be returned with status code 409

PUT /api/Carriers/Update Update a Carrier

Request Example

    /api/Carriers/Update?id=CarrierId&carrier=Carrier&marketName=MarketName
            Use id parameter to identify the Carrier to update by id or
            Use carrier and marketName parameter to identify the Carrier to update by carrier and marketName

Model Request Example

    All fields are updated
    {
        "Name": "string",
        "Code": "string"
    }

Response Example

If the operation is successful an empty response will be returned with status code 200
Otherwise an error with code and message will be returned with status code 409

DELETE /api/Carriers/Delete Delete a Carrier

Request Example

/api/Carriers/Delete?id=CarrierId&carrier=Carrier&marketName=MarketName
Use id parameter to identify the Carrier to update by id or
Use carrier and marketName parameter to identify the Carrier to delete by carrier and marketName

Response Example

If the operation is successful an empty response will be returned with status code 200
Otherwise an error with code and message will be returned with status code 409