",
"schema": []
},
{
"name": "name",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "siteIds",
"kind": "required",
"type": "array",
"description": "",
"example": "",
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "detail",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "taxCode",
"kind": "optional",
"type": "string",
"description": ""
}
],
"modelRef": "#/components/schemas/CreateShippingMethod",
"isExpanded": true
}
],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "NoChannelPortalAccess",
"name": "NoChannelPortalAccess",
"kind": "optional",
"type": "http",
"description": "This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.
",
"scheme": "bearer"
}
],
"cookieParameters": []
},
"responses": [
{
"statusCode": "201",
"description": "Success-shipping method created.
",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "This represents the common structure of a shipping method.",
"customType": "ShippingMethod",
"schema": [
{
"name": "calculator",
"kind": "required",
"type": "object",
"description": "",
"example": "",
"schema": []
},
{
"name": "dynamicProperties",
"kind": "optional",
"type": "object",
"description": "Dynamic properties on the shipping method.",
"example": "{\"propertyName\":\"This is a dynamic property\"}",
"schema": []
},
{
"name": "id",
"kind": "required",
"type": "string",
"description": "Optional shipping method id.",
"example": "8A218593-40EB-4DD0-94BD-8ACA1D95BB14",
"format": "uuid"
},
{
"name": "limits",
"kind": "optional",
"type": "object",
"description": "Defines optional dimension and weight limits of the shipping method.",
"modelRef": "#/components/schemas/Limits",
"customType": "Limits",
"schema": [
{
"name": "dimensions",
"kind": "optional",
"type": "object",
"description": "Represents the dimensions of a shipping package.",
"modelRef": "#/components/schemas/Dimensions",
"customType": "Dimensions",
"schema": [
{
"name": "width",
"kind": "required",
"type": "number",
"description": "The width of the package.",
"example": 10.5,
"format": "double"
},
{
"name": "length",
"kind": "required",
"type": "number",
"description": "The length of the package.",
"example": 20,
"format": "double"
},
{
"name": "height",
"kind": "required",
"type": "number",
"description": "The height of the package.",
"example": 15,
"format": "double"
},
{
"name": "unit",
"kind": "required",
"type": "string",
"description": "The unit of measurement for dimensions.",
"example": "cm",
"enum": [
"cm",
"m",
"in",
"mm"
]
}
]
},
{
"name": "weight",
"kind": "optional",
"type": "object",
"description": "Represents the weight of a shipping package.",
"modelRef": "#/components/schemas/Weight",
"customType": "Weight",
"schema": [
{
"name": "value",
"kind": "required",
"type": "number",
"description": "The weight value.",
"example": 2.5,
"format": "double"
},
{
"name": "unit",
"kind": "required",
"type": "string",
"description": "The unit of measurement for the weight.",
"example": "kg",
"enum": [
"g",
"kg",
"lb"
]
}
]
}
]
},
{
"name": "media",
"kind": "optional",
"type": "map",
"description": "",
"example": "",
"customType": "map",
"schema": []
},
{
"name": "name",
"kind": "required",
"type": "string",
"description": "name of the shipping method",
"example": "Shipping Method One"
},
{
"name": "siteIds",
"kind": "required",
"type": "array",
"description": "This should be a list of ids indicating the allowed sites. The ids must reference a valid site.",
"example": "",
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "taxCode",
"kind": "optional",
"type": "string",
"description": "Optional tax code for a shipping method.",
"example": "12345"
}
],
"modelRef": "#/components/schemas/ShippingMethod",
"isExpanded": true
}
]
},
{
"statusCode": "400",
"description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ValidationErrorResponse",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "code",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "detail",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "reason",
"kind": "optional",
"type": "string",
"description": ""
}
],
"modelRef": "#/components/schemas/ValidationErrorResponse",
"isExpanded": true
}
]
},
{
"statusCode": "401",
"description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ErrorResponse",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "code",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "detail",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "reason",
"kind": "optional",
"type": "string",
"description": ""
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"isExpanded": true
}
]
},
{
"statusCode": "404",
"description": "The requested resource was not found in the NoChannel system.",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ErrorResponse",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "code",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "detail",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "reason",
"kind": "optional",
"type": "string",
"description": ""
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"isExpanded": true
}
]
},
{
"statusCode": "500",
"description": "Internal server error.",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ErrorResponse",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "code",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "detail",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "reason",
"kind": "optional",
"type": "string",
"description": ""
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "PklvyaURcLgumXUPTgYzA",
"language": "curl",
"label": "cURL",
"code": "curl --request POST \\\n --url https://api.upstartcommerce.com/v1/shipping-method \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --data '{\n \"calculator\": \"\",\n \"limits\": {\n \"dimensions\": {\n \"width\": 10.5,\n \"length\": 20,\n \"height\": 15,\n \"unit\": \"cm\"\n },\n \"weight\": {\n \"value\": 2.5,\n \"unit\": \"kg\"\n }\n },\n \"name\": \"\",\n \"siteIds\": []\n }'"
},
{
"id": "ftq6ChFzebDf29PAoezOZ",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar raw = JSON.stringify({\n \"calculator\": \"\",\n \"limits\": {\n \"dimensions\": {\n \"width\": 10.5,\n \"length\": 20,\n \"height\": 15,\n \"unit\": \"cm\"\n },\n \"weight\": {\n \"value\": 2.5,\n \"unit\": \"kg\"\n }\n },\n \"name\": \"\",\n \"siteIds\": []\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/shipping-method\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "iVolf45SUIwC1NSzdIpQE",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/shipping-method\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\nrequest.body = JSON.dump({\n \"calculator\": \"\",\n \"limits\": {\n \"dimensions\": {\n \"width\": 10.5,\n \"length\": 20,\n \"height\": 15,\n \"unit\": \"cm\"\n },\n \"weight\": {\n \"value\": 2.5,\n \"unit\": \"kg\"\n }\n },\n \"name\": \"\",\n \"siteIds\": []\n})\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "oAE93UP5IV8VK7e-scXlS",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/shipping-method\"\n\npayload = json.dumps({\n \"calculator\": \"\",\n \"limits\": {\n \"dimensions\": {\n \"width\": 10.5,\n \"length\": 20,\n \"height\": 15,\n \"unit\": \"cm\"\n },\n \"weight\": {\n \"value\": 2.5,\n \"unit\": \"kg\"\n }\n },\n \"name\": \"\",\n \"siteIds\": []\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "PklvyaURcLgumXUPTgYzA"
},
"results": {
"languages": [
{
"id": "JNYjLSfBmhyhWzEDiq3b1",
"language": "201",
"code": "// Success-shipping method created.\n{\n \"calculator\": {},\n \"dynamicProperties\": {},\n \"id\": \"8A218593-40EB-4DD0-94BD-8ACA1D95BB14\",\n \"limits\": {\n \"dimensions\": {\n \"width\": 10.5,\n \"length\": 20,\n \"height\": 15,\n \"unit\": \"cm\"\n },\n \"weight\": {\n \"value\": 2.5,\n \"unit\": \"kg\"\n }\n },\n \"media\": \"\",\n \"name\": \"Shipping Method One\",\n \"siteIds\": [\n \"\"\n ],\n \"taxCode\": \"12345\"\n}"
},
{
"id": "ppl82aVW56-5sQzjLRxp9",
"language": "400",
"code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}"
},
{
"id": "5s2VHtaOWKC3U1k94k7cU",
"language": "401",
"code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}"
},
{
"id": "SdlMpUXGf94VwcKTBCS4u",
"language": "404",
"code": "// The requested resource was not found in the NoChannel system.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}"
},
{
"id": "Phf3BZdtXelQJWYuMMaWk",
"language": "500",
"code": "// Internal server error.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}"
}
],
"selectedLanguageId": "JNYjLSfBmhyhWzEDiq3b1"
}
},
"children": [
{
"text": ""
}
]
}