Contrato histórico: POST create-extra-option-suboption

Contrato histórico de API. Esta página describe un contrato anterior. Los métodos, las rutas y las respuestas pueden diferir de la API vigente.

Significado histórico

Crear subopción de extras

Este endpoint de la API se utiliza para crear una subopción de una opción de producto.

API vigente

Para desarrollar una integración nueva, consulta la referencia o guía vigente enlazada.

Ver la referencia de la API vigente

Parámetros

[
  {
    "name": "language",
    "in": "path",
    "schema": {
      "type": "string",
      "default": "en"
    },
    "required": true
  },
  {
    "name": "project",
    "in": "path",
    "schema": {
      "type": "string",
      "default": "<redacted-personal>"
    },
    "required": true
  },
  {
    "name": "business_id",
    "in": "path",
    "schema": {
      "type": "integer",
      "format": "int32"
    },
    "required": true
  },
  {
    "name": "extra_id",
    "in": "path",
    "schema": {
      "type": "integer",
      "format": "int32"
    },
    "required": true
  },
  {
    "name": "option_id",
    "in": "path",
    "schema": {
      "type": "integer",
      "format": "int32"
    },
    "required": true
  },
  {
    "name": "api_version",
    "in": "path",
    "schema": {
      "type": "string",
      "default": "v400"
    },
    "required": true
  }
]

Cuerpo de solicitud

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name",
          "price"
        ],
        "properties": {
          "name": {
            "type": "string"
          },
          "price": {
            "type": "number",
            "format": "float"
          },
          "image": {
            "type": "string",
            "format": "binary"
          },
          "sku": {
            "type": "string"
          },
          "rank": {
            "type": "integer",
            "format": "int32"
          },
          "description": {
            "type": "string"
          },
          "max": {
            "type": "integer",
            "format": "int32"
          },
          "half_price": {
            "type": "number",
            "format": "float"
          },
          "enabled": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Respuestas

{
  "200": {
    "description": "200",
    "content": {
      "application/json": {
        "examples": {
          "Result": {
            "value": "{\n  \"error\": false,\n  \"result\": {\n    \"extra_option_id\": 53,\n    \"rank\": 4,\n    \"half_price\": 1.5,\n    \"max\": 5,\n    \"name\": \"<redacted-personal>\",\n    \"price\": 12,\n    \"updated_at\": \"2019-01-08 16:09:58\",\n    \"created_at\": \"2019-01-08 16:09:58\",\n    \"id\": 239\n  }\n}"
          }
        },
        "schema": {
          "type": "object",
          "properties": {
            "error": {
              "type": "boolean",
              "example": false,
              "default": true
            },
            "result": {
              "type": "object",
              "properties": {
                "extra_option_id": {
                  "type": "integer",
                  "example": 53,
                  "default": 0
                },
                "rank": {
                  "type": "integer",
                  "example": 4,
                  "default": 0
                },
                "half_price": {
                  "type": "number",
                  "example": 1.5,
                  "default": 0
                },
                "max": {
                  "type": "integer",
                  "example": 5,
                  "default": 0
                },
                "name": {
                  "type": "string",
                  "example": "<redacted-personal>"
                },
                "price": {
                  "type": "integer",
                  "example": 12,
                  "default": 0
                },
                "updated_at": {
                  "type": "string",
                  "example": "2019-01-08 16:09:58"
                },
                "created_at": {
                  "type": "string",
                  "example": "2019-01-08 16:09:58"
                },
                "id": {
                  "type": "integer",
                  "example": 239,
                  "default": 0
                }
              }
            }
          }
        }
      }
    }
  },
  "400": {
    "description": "400",
    "content": {
      "application/json": {
        "examples": {
          "Result": {
            "value": "{\n  \"error\": true,\n  \"result\": [\n    \"The Name field is required.\",\n    \"The Price field is required.\"\n  ]\n}"
          }
        },
        "schema": {
          "type": "object",
          "properties": {
            "error": {
              "type": "boolean",
              "example": true,
              "default": true
            },
            "result": {
              "type": "array",
              "items": {
                "type": "string",
                "example": "The Name field is required."
              }
            }
          }
        }
      }
    }
  },
  "401": {
    "description": "401",
    "content": {
      "application/json": {
        "examples": {
          "Result": {
            "value": "{\n  \"error\": true,\n  \"result\": [\n    \"You do not have permission.\"\n  ]\n}"
          }
        },
        "schema": {
          "type": "object",
          "properties": {
            "error": {
              "type": "boolean",
              "example": true,
              "default": true
            },
            "result": {
              "type": "array",
              "items": {
                "type": "string",
                "example": "You do not have permission."
              }
            }
          }
        }
      }
    }
  }
}