Update Shipping Carrier

PUT 
/store/shipping-carrier/:shippingCarrierId

The "update Shipping Carrier" API allows update a shipping carrier to the system.

Request

shippingCarrierId stringrequired

ID of the shipping carrier that needs to be returned

application/json

application/json

Body

Bodyrequired

altIdstring

Location Id or Agency Id

altTypestring
Available optionslocation
namestring

Name of the shipping carrier

callbackUrlstring

The URL endpoint that CRM needs to retrieve shipping rates. This must be a public URL.

servicesobject[]

An array of available shipping carrier services

allowsMultipleServiceSelectionboolean

The seller can choose multiple services while creating shipping rates if this is true.

Example (auto)

{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "name": "FedEx",
  "callbackUrl": "https://example.com/get-shipping-rates",
  "services": [
    {
      "name": "Priority Mail Express International",
      "value": "PriorityMailExpressInternational"
    }
  ],
  "allowsMultipleServiceSelection": true
}

application/json

Successful response

application/json

Schema

Schema

statusbooleanrequired

Status of api action

messagestring

Success message

dataobjectrequired

Shipping carrier data

Example (auto)

{
  "status": true,
  "message": "Successfully created",
  "data": {
    "altId": "6578278e879ad2646715ba9c",
    "altType": "location",
    "name": "FedEx",
    "callbackUrl": "https://example.com/get-shipping-rates",
    "services": [
      {
        "name": "Priority Mail Express International",
        "value": "PriorityMailExpressInternational"
      }
    ],
    "allowsMultipleServiceSelection": true,
    "_id": "655b33a82209e60b6adb87a5",
    "marketplaceAppId": "655b33a82209e60b6adb87a5",
    "createdAt": "2023-12-12T09:27:42.355Z",
    "updatedAt": "2023-12-12T09:27:42.355Z"
  }
}