Skip to main content
POST
/
contracts
/
{id}
/
schedules
/
{schedule_id}
/
transport-chains
Create Transport Chain
curl --request POST \
  --url https://v1.api.flux-os.com/contracts/{id}/schedules/{schedule_id}/transport-chains \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-user-id: <api-key>' \
  --data '{}'
{
  "data": {
    "id": "<string>",
    "schedule": {
      "production_month": "2023-12-25",
      "id": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "legs": [
      {
        "position": 123,
        "chain": "<unknown>",
        "volume": 123,
        "id": "<string>",
        "mode": {
          "name": "<string>",
          "short_code": "<string>",
          "id": "<string>"
        },
        "source_well": {
          "id": "<string>",
          "name": null
        },
        "source_commercial_facility": {
          "name": "<string>",
          "id": "<string>",
          "lsd": null,
          "section": null,
          "township": null,
          "range": null,
          "meridian": null
        },
        "source_facility": {
          "name": "<string>",
          "id": "<string>"
        },
        "source_land_description": {
          "description": "<string>",
          "latitude": 123,
          "longitude": 123,
          "id": "<string>",
          "survey_system": {
            "name": "<string>",
            "short_code": "<string>",
            "id": "<string>"
          },
          "unit": {
            "name": "<string>",
            "short_code": "<string>",
            "id": "<string>"
          }
        },
        "destination_commercial_facility": {
          "name": "<string>",
          "id": "<string>",
          "lsd": null,
          "section": null,
          "township": null,
          "range": null,
          "meridian": null
        },
        "destination_facility": {
          "name": "<string>",
          "id": "<string>"
        },
        "volume_measurement_unit": {
          "name": "<string>",
          "abbreviation": "<string>",
          "id": "<string>",
          "html_symbol": null
        },
        "custodian_organization": {
          "name": "<string>",
          "id": "<string>",
          "image_url": null
        },
        "custodian_entity": {
          "legal_name": "<string>",
          "id": "<string>"
        },
        "is_custody_transfer": false,
        "is_chain_source": false,
        "is_chain_destination": false,
        "fob": false,
        "carrier_organization": {
          "name": "<string>",
          "id": "<string>",
          "image_url": null
        },
        "carrier_entity": {
          "legal_name": "<string>",
          "id": "<string>"
        },
        "carrier_user": {
          "first_name": "<string>",
          "last_name": "<string>",
          "id": "<string>"
        },
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

x-api-key
string
header
required
x-user-id
string
header
required

Path Parameters

id
integer
required

The contract ID.

Query Parameters

schedule_id
integer
required

The schedule ID.

Body

application/json

The body is of type object.

Response

Transport chain successfully created.

data
object