{
  "openapi": "3.0.1",
  "info": {
    "title": "Distribution Arrangements",
    "description": "Create and administer a collection of distribution arrangements.",
    "version": "9.1.20.0",
    "x-introduced": "9.1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}:{port}/rest/admin/v2",
      "variables": {
        "port": {
          "default": "443",
          "enum": [
            "443",
            "8000"
          ]
        },
        "hostname": {
          "default": "localhost",
          "enum": [
            "localhost",
            "test.hcl.com"
          ]
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Distribution Arrangements",
      "description": "Provide RESTful services to manage Distribution Arrangements."
    }
  ],
  "paths": {
    "/distribution-arrangements": {
      "get": {
        "tags": [
          "Distribution Arrangements"
        ],
        "description": "Get a collection of distribution arrangements.",
        "operationId": "getDistributionArrangements",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The unique numeric ID for identifying the distribution arrangement.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The reference ID of the store this distribution arrangement associated with. This value must be the same as the value of the wholeSaleStoreId.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "pickingMethod",
            "in": "query",
            "description": "Determines the sequence in which inventory is picked from the RECEIPT table under this arrangement.F = FIFO (First In First Out) - the least recently received inventory.L = LIFO (Last in First Out) - the most recently received inventory.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "startDateTime",
            "in": "query",
            "description": "The time this distribution arrangement begins being effective.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "endDateTime",
            "in": "query",
            "description": "The time this distribution arrangement stops being effective. Specify an end date that will not expire.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "field1",
            "in": "query",
            "description": "Customizable.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "field2",
            "in": "query",
            "description": "Customizable.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "field3",
            "in": "query",
            "description": "Customizable.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "wholeSaleStoreId",
            "in": "query",
            "description": "The wholesale store that owns the inventory that can be sold by the store.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "baseItemId",
            "in": "query",
            "description": "The product covered by this distribution arrangement.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "updatedDateTime",
            "in": "query",
            "description": "The last time this distribution arrangement was updated.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of distribution arrangements.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DistributionArrangementCollection"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "Distribution Arrangements"
        ],
        "description": "Create a distribution arrangement.",
        "operationId": "createDistributionArrangement",
        "requestBody": {
          "description": "The distribution arrangement.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DistributionArrangement_Request"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the Distribution-Arrangements.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetDistributionArrangementsByDistributionArrangementsId": {
                "operationRef": "#/paths/~1distribution-arrangements~1{id}/get",
                "parameters": {
                  "id": "request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /distribution-arrangements/{id}`.\n"
              },
              "DeleteDistributionArrangementsByDistributionArrangementsId": {
                "operationRef": "#/paths/~1distribution-arrangements~1{id}/delete",
                "parameters": {
                  "id": "request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `DELETE /distribution-arrangements/{id}`.\n"
              },
              "UpdateDistributionArrangementsByDistributionArrangementsId": {
                "operationRef": "#/paths/~1distribution-arrangements~1{id}/patch",
                "parameters": {
                  "id": "request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `PATCH /distribution-arrangements/{id}`.\n"
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "DistributionArrangement"
      }
    },
    "/distribution-arrangements/{id}": {
      "get": {
        "tags": [
          "Distribution Arrangements"
        ],
        "description": "Get a distribution arrangement.",
        "operationId": "getDistributionArrangementById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the distribution arrangement.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The distribution arrangement.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DistributionArrangement"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Distribution Arrangements"
        ],
        "description": "Delete a distribution arrangement.",
        "operationId": "deleteDistributionArrangementById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the distribution arrangement.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "patch": {
        "tags": [
          "Distribution Arrangements"
        ],
        "description": "Update a distribution arrangement.",
        "operationId": "updateDistributionArrangementById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the distribution arrangement.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "requestBody": {
          "description": "The distribution arrangement.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DistributionArrangement_Request"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "DistributionArrangement"
      }
    }
  },
  "components": {
    "schemas": {
      "Link": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "The URL of the link.",
            "format": "uri"
          }
        },
        "description": "Links to related resources."
      },
      "Error": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "string",
            "description": "The error message code."
          },
          "errorMessage": {
            "type": "string",
            "description": "The error message."
          },
          "errorKey": {
            "type": "string",
            "description": "The error message key."
          },
          "errorParameters": {
            "type": "array",
            "description": "The arguments used to construct the error message.",
            "items": {
              "type": "object",
              "properties": {}
            }
          },
          "errorLevel": {
            "type": "string",
            "description": "The error level."
          },
          "errorHref": {
            "type": "string",
            "description": "The error hypertext reference."
          }
        },
        "description": "The error message item model."
      },
      "ErrorResponseContainer": {
        "type": "object",
        "properties": {
          "requestId": {
            "type": "string",
            "description": "The request identifier."
          },
          "errors": {
            "type": "array",
            "description": "The errors.",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          }
        },
        "description": "The error message model."
      },
      "DistributionArrangement": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "storeId": {
            "type": "integer"
          },
          "pickingMethod": {
            "type": "string"
          },
          "startDateTime": {
            "type": "string"
          },
          "endDateTime": {
            "type": "string"
          },
          "field1": {
            "type": "string"
          },
          "field2": {
            "type": "string"
          },
          "field3": {
            "type": "string"
          },
          "wholeSaleStoreId": {
            "type": "integer"
          },
          "baseItemId": {
            "type": "integer"
          },
          "updatedDateTime": {
            "type": "string"
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                },
                "required": [
                  "href"
                ]
              }
            },
            "required": [
              "self"
            ]
          }
        },
        "required": [
          "id",
          "storeId",
          "pickingMethod",
          "startDateTime",
          "endDateTime",
          "field1",
          "field2",
          "field3",
          "wholeSaleStoreId",
          "baseItemId",
          "updatedDateTime",
          "links"
        ]
      },
      "DistributionArrangement_Request": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "storeId": {
            "type": "integer"
          },
          "pickingMethod": {
            "type": "string"
          },
          "startDateTime": {
            "type": "string"
          },
          "endDateTime": {
            "type": "string"
          },
          "field1": {
            "type": "string"
          },
          "field2": {
            "type": "string"
          },
          "field3": {
            "type": "string"
          },
          "wholeSaleStoreId": {
            "type": "integer"
          },
          "baseItemId": {
            "type": "integer"
          },
          "updatedDateTime": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "storeId",
          "pickingMethod",
          "startDateTime",
          "endDateTime",
          "field1",
          "field2",
          "field3",
          "wholeSaleStoreId",
          "baseItemId",
          "updatedDateTime",
          "links"
        ]
      },
      "DistributionArrangementCollection": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/DistributionArrangement"
            }
          }
        },
        "description": "A collection of distribution arrangements."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}