### Artifact Sample

Source: https://docs.loop.com/openapi/index

Example response for an artifact, such as an invoice.

```APIDOC
## Artifact Sample

### Description
This is an example response for an artifact, such as an invoice, detailing its properties.

### Response Example (201)
```json
{
  "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  "createdAt": "2023-01-01T00:00:00.000Z",
  "revisionNumber": 1,
  "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  "artifactType": "INVOICE",
  "artifactFormat": "PDF",
  "displayName": "XPO Invoice 54219 - 2023-12-01",
  "summary": {
    "bolNumber": "201946",
    "carrierName": "Tom's Trucking LLC",
    "consigneeAddress": {
      "addressLine1": "123 Main Street",
      "addressLine2": "Suite 456",
      "city": "Chicago",
      "state": "IL",
      "postalCode": "60601",
      "country": "USA"
    },
    "dropoffAppointmentDateTime": "2023-12-01T12:00:00.000Z",
    "dropoffAppointmentType": "FCFS, Appointment",
    "equipmentRequirements": "straps, tarps, food grade, etc.",
    "equipmentSize": "53', 48'",
    "equipmentType": "Dry Van, Reefer, Flatbed, etc.",
    "consigneeName": "Catherine's Culinary Corner",
    "externalIdentifiers": [
      "89213",
      "OF7890"
    ],
    "invoicedTotal": {
      "amount": "3.50",
      "currencyCode": "AUD"
    },
    "invoiceNumber": "419204",
    "invoiceDate": "2023-12-01",
    "pickupAppointmentDateTime": "2023-12-01T12:00:00.000Z",
    "pickupDateAppointmentType": "FCFS, Appointment",
    "pickupDate": "2023-11-01",
    "poNumber": "19012",
    "proNumber": "76910234",
    "reeferEquipmentTemperature": "35-36F",
    "shipperAddress": {
      "addressLine1": "123 Main Street",
      "addressLine2": "Suite 456",
      "city": "Chicago",
      "state": "IL",
      "postalCode": "60601",
      "country": "USA"
    },
    "shipperName": "Sally's Supply Store",
    "transportationProvider": "TQL, CHR"
  },
  "derivativeArtifacts": [
    {
      "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      "artifactType": "INVOICE"
    }
  ],
  "tags": {}
}
```
```

--------------------------------

### GET /v1/business-exceptions/{qid}

Source: https://docs.loop.com/openapi/index_tag/artifacts

Retrieves a specific business exception by its QID.

```APIDOC
## GET /v1/business-exceptions/{qid}

### Description
Returns the business exception with the specified QID.

### Method
GET

### Endpoint
/v1/business-exceptions/{qid}

### Parameters
#### Path Parameters
- **qid** (string) - Required - QID of the entity to retrieve.

### Responses
#### Success Response (200)
- **qid** (string) - Qualified unique identifier.
- **label** (string) - The description of the business exception.
- **resolvedAt** (string or null) - If resolved, the time the exception was resolved. If the exception was resolved and re-opened, this will be null.
- **targetQid** (string) - Qualified unique identifier of the business exception's target entity.
- **note** (string or null) - The note on the business exception.

#### Response Example (200)
```json
{
  "qid": "qid::business_exception:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  "label": "Variance over threshold",
  "resolvedAt": "2023-01-01T00:00:00.000Z",
  "targetQid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  "note": "string"
}
```
```

--------------------------------

### GET /v1/business-exceptions/target-entity-qid/{targetEntityQid}

Source: https://docs.loop.com/openapi/index_tag/artifacts

Retrieves all business exceptions for a specified target entity QID.

```APIDOC
## GET /v1/business-exceptions/target-entity-qid/{targetEntityQid}

### Description
Returns all business exceptions for the specified target entity.

### Method
GET

### Endpoint
/v1/business-exceptions/target-entity-qid/{targetEntityQid}

### Parameters
#### Path Parameters
- **targetEntityQid** (string) - Required - QID of the target entity for which to retrieve exceptions.

### Responses
#### Success Response (200)
- **qid** (string) - Qualified unique identifier.
- **label** (string) - The description of the business exception.
- **resolvedAt** (string or null) - If resolved, the time the exception was resolved. If the exception was resolved and re-opened, this will be null.
- **targetQid** (string) - Qualified unique identifier of the business exception's target entity.
- **note** (string or null) - The note on the business exception.

#### Response Example (200)
```json
[
  {
    "qid": "qid::business_exception:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    "label": "Variance over threshold",
    "resolvedAt": "2023-01-01T00:00:00.000Z",
    "targetQid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    "note": "string"
  }
]
```
```

--------------------------------

### Retrieve Artifact by QID (API Request)

Source: https://docs.loop.com/openapi/index_tag/artifacts

An example of an API GET request to retrieve a specific artifact using its QID. The request supports query parameters to expand the response with 'summary', 'derivatives', or 'tags' data. It specifies the production endpoint and requires bearer authorization.

```bash
GET https://api.loop.com/v1/artifacts/<qid>?expand=summary&expand=derivatives&expand=tags
Authorization: Bearer <your_token>
```

--------------------------------

### Shipment Data Structure Example

Source: https://docs.loop.com/openapi/index_tag/artifacts

This example demonstrates the structure of a shipment, including carrier information, addresses, stops, and articles. It's a common pattern for representing logistics data.

```json
{
  "carrierOrganizationName": "Example Carrier Inc",
  "carrierOrganizationQid": null,
  "billToAddressName": "Billing Department",
  "billToAddressQid": null,
  "firstOriginAddressName": "Warehouse A",
  "firstOriginAddressQid": null,
  "lastDestinationAddressName": "Distribution Center B",
  "lastDestinationAddressQid": null,
  "stops": [
    {
      "addressName": "Warehouse A",
      "addressQid": null,
      "date": null,
      "organizationQid": null,
      "stopType": "PICK_UP",
      "articlesSummary": {
        "totalGrossWeight": {
          "value": 15000,
          "unit": "LB"
        },
        "totalPackageCount": {
          "value": 25,
          "unit": "PLT"
        },
        "totalHandlingUnit": null
      },
      "articles": [
        {
          "description": "Industrial Equipment",
          "dimensions": {
            "length": 48,
            "width": 40,
            "height": 48,
            "unit": "IN"
          },
          "grossWeight": {
            "value": 2000,
            "unit": "LB"
          },
          "nmfcClass": "70",
          "nmfcCode": "133300",
          "packageCount": {
            "value": 5,
            "unit": "PLT"
          },
          "handlingUnit": null
        },
        {
          "description": "Electronics Components",
          "dimensions": {
            "length": 36,
            "width": 30,
            "height": 24,
            "unit": "IN"
          },
          "grossWeight": {
            "value": 800,
            "unit": "LB"
          },
          "nmfcClass": "125",
          "nmfcCode": "178650",
          "packageCount": {
            "value": 10,
            "unit": "BOX"
          },
          "handlingUnit": null
        }
      ],
      "referenceNumbers": []
    },
    {
      "addressName": "Distribution Center B",
      "addressQid": null,
      "date": null,
      "organizationQid": null,
      "stopType": "DROP_OFF',
      "articlesSummary": {
        "totalGrossWeight": {
          "value": 15000,
          "unit": "LB"
        },
        "totalPackageCount": {
          "value": 25,
          "unit": "PLT"
        },
        "totalHandlingUnit": null
      },
      "articles": [
        {
          "description": "Industrial Equipment",
          "dimensions": {
            "length": 48,
            "width": 40,
            "height": 48,
            "unit": "IN"
          },
          "grossWeight": {
            "value": 2000,
            "unit": "LB"
          },
          "nmfcClass": "70",
          "nmfcCode": "133300",
          "packageCount": {
            "value": 5,
            "unit": "PLT"
          },
          "handlingUnit": null
        },
        {
          "description": "Electronics Components",
          "dimensions": {
            "length": 36,
            "width": 30,
            "height": 24,
            "unit": "IN"
          },
          "grossWeight": {
            "value": 800,
            "unit": "LB"
          },
          "nmfcClass": "125",
          "nmfcCode": "178650",
          "packageCount": {
            "value": 10,
            "unit": "BOX"
          },
          "handlingUnit": null
        }
      ],
      "referenceNumbers": []
    }
  ]
}
```

--------------------------------

### List Payable Invoice Reviews

Source: https://docs.loop.com/openapi/index

Returns a list of payable invoice reviews.

```APIDOC
## GET /v1/payable-invoice-reviews

### Description
Returns a list of payable invoice reviews.

### Method
GET

### Endpoint
/v1/payable-invoice-reviews

### Parameters
(No parameters defined in the provided text)

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
(Response schema not fully defined in the provided text)

#### Response Example
```json
{
  "example": ""
}
```
```

--------------------------------

### Example Response: OrganizationFactorAssignment Record (JSON)

Source: https://docs.loop.com/openapi/index

This JSON represents a successful response (201 Created) after creating an OrganizationFactorAssignment record. It contains the unique identifier (qid), creation timestamps, artifact type, and display name of the newly created record. The summary and derivativeArtifacts fields are optional and depend on query parameters.

```json
{
  "qid": "qid::artifact:a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "createdAt": "2023-10-27T10:00:00.000Z",
  "revisionNumber": 1,
  "revisionCreatedAt": "2023-10-27T10:00:00.000Z",
  "artifactType": "ORGANIZATION_FACTOR_ASSIGNMENT",
  "artifactFormat": "JSON",
  "displayName": "Factor Assignment for Carrier ABC",
  "summary": {
    "carrierName": "Tom's Trucking LLC",
    "factorName": "Factor Corp",
    "effectiveDate": "2023-01-01"
  },
  "derivativeArtifacts": [
    {
      "qid": "qid::artifact:f0e9d8c7-b6a5-4321-fedc-ba9876543210",
      "artifactType": "AGREEMENT"
    }
  ],
  "tags": {
    "environment": "production"
  }
}
```

--------------------------------

### Retrieve Organization by Tag - API Request Example

Source: https://docs.loop.com/openapi/index_tag/artifacts

This example demonstrates how to retrieve an organization using its tag type and value. The endpoint requires path parameters for `tagType` and `tagTypeValue`, and optionally accepts an `expand` query parameter to include related data.

```curl
curl -X GET \
  'https://api.loop.com/v1/organizations/tagged/externalId/123456789?expand=tags' \
  -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'
```

--------------------------------

### Create Shipment Record - API Request Example

Source: https://docs.loop.com/openapi/index

This is an example of how to make a POST request to the /v1/artifacts/shipment-record endpoint to create a new shipment record. It includes the request body with the source of the data and any required jobs. Authentication is typically handled via bearer token.

```http
POST /v1/artifacts/shipment-record HTTP/1.1
Host: api.loop.com
Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json

{
  "source": "your_data_source",
  "jobsRequired": [
    {
      "jobType": "SHIPMENT_RECORD_CREATION",
      "source": "your_data_source",
      "metadata": {
        "externalIdentifier": "SHIPMENT_ID_12345"
      }
    }
  ],
  "artifactTags": {
    "key": "value"
  }
}
```

--------------------------------

### POST /websites/loop_openapi

Source: https://docs.loop.com/openapi/index

Creates a new organization with the provided details. Supports various carrier and customer information.

```APIDOC
## POST /websites/loop_openapi

### Description
Creates a new organization with the provided details. Supports various carrier and customer information.

### Method
POST

### Endpoint
/websites/loop_openapi

### Parameters
#### Request Body
- **displayName** (string) - Required - Name of the organization.
- **legalName** (string) - Required - Legal name of the organization.
- **tradeNames** (array of strings) - Optional - Alternative names for the organization.
- **websiteUrl** (string) - Optional - Website URL of the organization.
- **parentOrganizationQid** (string) - Optional - QID of the parent organization.
- **tags** (object) - Optional - Key-value pairs for custom tags.
  - **accountNumber** (string) - Optional - Account number associated with the organization.
  - **externalId** (string) - Optional - External identifier for the organization.
- **clientDivisionInfo** (object) - Optional - Client division specific information.
  - **isEligiblePayor** (boolean) - Optional - Indicates if the client is eligible as a payor.
  - **vatRegistrationNumber** (string) - Optional - VAT registration number.
- **customerInfo** (object) - Optional - Customer-specific information.
  - **billingEmails** (array of strings) - Optional - List of billing email addresses.
  - **invoiceDeliveryMethod** (string) - Optional - Method for invoice delivery (e.g., "EMAIL").
- **airCarrierInfo** (object) - Optional - Information for air carriers.
  - **scac** (string) - Optional - Standard Carrier Alpha Code.
  - **iataCode** (string) - Optional - IATA code.
  - **icaoCode** (string) - Optional - ICAO code.
- **oceanCarrierInfo** (object) - Optional - Information for ocean carriers.
  - **scac** (string) - Optional - Standard Carrier Alpha Code.
  - **bicCode** (string) - Optional - BIC code.
- **truckingCarrierInfo** (object) - Optional - Information for trucking carriers.
  - **mcNumber** (string) - Optional - MC number.
  - **scac** (string) - Optional - Standard Carrier Alpha Code.
  - **usdotNumber** (string) - Optional - USDOT number.
- **forwarderInfo** (object) - Optional - Information for forwarders.
  - **scac** (string) - Optional - Standard Carrier Alpha Code.
  - **fmcOrganizationNumber** (string) - Optional - FMC organization number.
- **factorInfo** (object) - Optional - Information for factors.
- **brokerageInfo** (object) - Optional - Information for brokerages.
- **asPayee** (object) - Optional - Payment information when acting as a payee.
  - **invoicing** (object) - Optional - Invoicing details.
    - **daysToPay** (integer) - Optional - Number of days to pay.
    - **daysToPayFrom** (string) - Optional - Basis for calculating days to pay (e.g., "ISSUE_DATE").
  - **quickPay** (object) - Optional - Quick pay details.
    - **daysToPay** (integer) - Optional - Number of days to pay for quick pay.
    - **discountPercentage** (string) - Optional - Discount percentage for quick pay.
- **asPayor** (object) - Optional - Payment information when acting as a payor.
  - **invoicing** (object) - Optional - Invoicing details.
    - **daysToPay** (integer) - Optional - Number of days to pay.
  - **primaryBillingAddress** (object) - Optional - Primary billing address.
    - **addressLine1** (string) - Required - First line of the address.
    - **addressLine2** (string) - Optional - Second line of the address.
    - **city** (string) - Required - City.
    - **state** (string) - Required - State or province.
    - **postalCode** (string) - Required - Postal code.
    - **country** (string) - Required - Country.
- **occupiedAddresses** (array of objects) - Optional - List of occupied addresses.
  - **addressLine1** (string) - Required - First line of the address.
  - **addressLine2** (string) - Optional - Second line of the address.
  - **city** (string) - Required - City.
  - **state** (string) - Required - State or province.
  - **postalCode** (string) - Required - Postal code.
  - **country** (string) - Required - Country.

### Request Example
```json
{
  "displayName": "ACME",
  "legalName": "ACME Inc.",
  "tradeNames": [
    "ACME Trucking",
    "ACME Group"
  ],
  "websiteUrl": "https://example.com",
  "parentOrganizationQid": "qid::organization:9bafb1b4-3bdf-4326-bc0d-2d0ff9d616a8",
  "tags": {
    "accountNumber": "AC-123",
    "externalId": "123456789"
  },
  "clientDivisionInfo": {
    "isEligiblePayor": true,
    "vatRegistrationNumber": "DE123456789"
  },
  "customerInfo": {
    "billingEmails": [
      "billing@customer.com"
    ],
    "invoiceDeliveryMethod": "EMAIL"
  },
  "airCarrierInfo": {
    "scac": "AAL",
    "iataCode": "AA",
    "icaoCode": "AAL"
  },
  "oceanCarrierInfo": {
    "scac": "MAEU",
    "bicCode": "MSCU"
  },
  "truckingCarrierInfo": {
    "mcNumber": "179059",
    "scac": "FDEB",
    "usdotNumber": "265752"
  },
  "forwarderInfo": {
    "scac": "FDEG",
    "fmcOrganizationNumber": "FMC123456"
  },
  "factorInfo": { },
  "brokerageInfo": { },
  "asPayee": {
    "invoicing": {
      "daysToPay": 30,
      "daysToPayFrom": "ISSUE_DATE"
    },
    "quickPay": {
      "daysToPay": 1,
      "discountPercentage": "0.02"
    }
  },
  "asPayor": {
    "invoicing": {
      "daysToPay": 30
    },
    "primaryBillingAddress": {
      "addressLine1": "123 Main Street",
      "addressLine2": "Suite 456",
      "city": "Chicago",
      "state": "IL",
      "postalCode": "60601",
      "country": "US"
    }
  },
  "occupiedAddresses": [
    {
      "addressLine1": "123 Main Street",
      "addressLine2": "Suite 456",
      "city": "Chicago",
      "state": "IL",
      "postalCode": "60601",
      "country": "US"
    }
  ]
}
```

### Response
#### Success Response (201)
- **qid** (string) - Qualified unique identifier for the created organization.
- **createdAt** (string) - Timestamp when the organization was created.
- **revisionNumber** (integer) - The current revision number of the organization.
- **revisionCreatedAt** (string) - Timestamp of the last revision.
- **displayName** (string) - Name of the organization.
- **legalName** (string) - Legal name of the organization.
- **websiteUrl** (string) - Website URL of the organization.
- **parentOrganizationQid** (string) - QID of the parent organization, if any.
- **clientDivisionInfo** (object) - Client division specific information.
- **customerInfo** (object) - Customer-specific information.
- **airCarrierInfo** (object) - Information for air carriers.
- **oceanCarrierInfo** (object) - Information for ocean carriers.
- **truckingCarrierInfo** (object) - Information for trucking carriers.
- **forwarderInfo** (object) - Information for forwarders.
- **factorInfo** (object) - Information for factors.
- **brokerageInfo** (object) - Information for brokerages.
- **tags** (object) - Key-value pairs for custom tags.

#### Response Example
```json
{
  "qid": "qid::organization:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  "createdAt": "2023-01-01T00:00:00.000Z",
  "revisionNumber": 1,
  "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  "displayName": "ACME",
  "legalName": "ACME Inc.",
  "websiteUrl": "https://example.com",
  "parentOrganizationQid": "qid::organization:9bafb1b4-3bdf-4326-bc0d-2d0ff9d616a8",
  "clientDivisionInfo": {
    "isEligiblePayor": true,
    "vatRegistrationNumber": "DE123456789"
  },
  "customerInfo": {
    "billingEmails": [
      "billing@customer.com"
    ],
    "invoiceDeliveryMethod": "EMAIL"
  },
  "airCarrierInfo": {
    "scac": "AAL",
    "iataCode": "AA",
    "icaoCode": "AAL"
  },
  "oceanCarrierInfo": {
    "scac": "MAEU",
    "bicCode": "MSCU"
  },
  "truckingCarrierInfo": {
    "mcNumber": "179059",
    "scac": "FDEB",
    "usdotNumber": "265752"
  },
  "forwarderInfo": {
    "scac": "FDEG",
    "fmcOrganizationNumber": "FMC123456"
  },
  "factorInfo": { },
  "brokerageInfo": { },
  "tags": {
    "accountNumber": "AC-123",
    "externalId": "123456789"
  }
}
```
```

--------------------------------

### List Payable Allocations (JSON Response Sample)

Source: https://docs.loop.com/openapi/index_tag/artifacts

This is a sample JSON response for the 'List payable allocations' endpoint. It returns a paginated list of payable allocations, each with details like QID, creation timestamp, associated invoice and payment QIDs, and the allocated amount.

```json
{
  "data": [
    {
      "qid": "qid::payable_allocation:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      "createdAt": "2023-01-01T00:00:00.000Z",
      "payableInvoiceQid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      "paymentQid": "qid::payment:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      "amount": {
        "amount": "3.50",
        "currencyCode": "USD"
      }
    }
  ],
  "pageInfo": {
    "hasPreviousPage": true,
    "hasNextPage": true,
    "startCursor": "string",
    "endCursor": "string"
  }
}
```

--------------------------------

### Payable Invoice Data Structure Example

Source: https://docs.loop.com/openapi/index_tag/artifacts

An example JSON object representing a single payable invoice, including line item groups, rate engine rate items, and adjustment reviews. This structure illustrates the detailed breakdown of costs and adjustments associated with an invoice.

```JSON
{
  "lineItemGroupQid": "qid::payable_invoice_line_item_group:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  "lineItemGroup": {
    "qid": "qid::payable_invoice_line_item_group:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
    "name": "Linehaul",
    "invoiced": {
      "amount": "3.50",
      "currencyCode": "USD"
    },
    "payment": {
      "amount": "3.50",
      "currencyCode": "USD"
    },
    "category": "LINEHAUL"
  },
  "rateEngineRateItemQids": [
    "qid::rate_engine_run_rate_item:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
  ],
  "rateEngineRateItems": [
    {
      "qid": "qid::rate_engine_run_rate_item:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      "code": "660",
      "description": "California Fuel Surcharge",
      "classification": "FUEL_SURCHARGE",
      "tags": { },
      "cost": {
        "amount": "3.50",
        "currencyCode": "USD"
      }
    }
  ],
  "adjustmentReviews": [
    {
      "approved": {
        "amount": "3.50",
        "currencyCode": "USD"
      },
      "appliedAmount": {
        "amount": "3.50",
        "currencyCode": "USD"
      },
      "adjustmentQid": "qid::payable_invoice_adjustment:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      "description": "QUICK_PAY_DISCOUNT",
      "externalIdentifier": { }
    }
  ],
  "expandRevisionCreatedAt": "2023-01-01T00:00:00.000Z"
}
```

--------------------------------

### Artifact Sample: INVOICE

Source: https://docs.loop.com/openapi/index_tag/artifacts

Sample JSON response for an INVOICE artifact.

```APIDOC
## Artifact Sample: INVOICE

### Description
Sample JSON response for an INVOICE artifact, including details like QID, timestamps, artifact type and format, display name, and summary information.

### Response Example (201)
```json
{
  "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  "createdAt": "2023-01-01T00:00:00.000Z",
  "revisionNumber": 1,
  "revisionCreatedAt": "2023-01-01T00:00:00.000Z",
  "artifactType": "INVOICE",
  "artifactFormat": "PDF",
  "displayName": "XPO Invoice 54219 - 2023-12-01",
  "summary": {
    "bolNumber": "201946",
    "carrierName": "Tom's Trucking LLC",
    "consigneeAddress": {
      "addressLine1": "123 Main Street",
      "addressLine2": "Suite 456",
      "city": "Chicago",
      "state": "IL",
      "postalCode": "60601",
      "country": "USA"
    },
    "dropoffAppointmentDateTime": "2023-12-01T12:00:00.000Z",
    "dropoffAppointmentType": "FCFS, Appointment",
    "equipmentRequirements": "straps, tarps, food grade, etc.",
    "equipmentSize": "53', 48'",
    "equipmentType": "Dry Van, Reefer, Flatbed, etc.",
    "consigneeName": "Catherine's Culinary Corner",
    "externalIdentifiers": [
      "89213",
      "OF7890"
    ],
    "invoicedTotal": {
      "amount": "3.50",
      "currencyCode": "AUD"
    },
    "invoiceNumber": "419204",
    "invoiceDate": "2023-12-01",
    "pickupAppointmentDateTime": "2023-12-01T12:00:00.000Z",
    "pickupDateAppointmentType": "FCFS, Appointment",
    "pickupDate": "2023-11-01",
    "poNumber": "19012",
    "proNumber": "76910234",
    "reeferEquipmentTemperature": "35-36F",
    "shipperAddress": {
      "addressLine1": "123 Main Street",
      "addressLine2": "Suite 456",
      "city": "Chicago",
      "state": "IL",
      "postalCode": "60601",
      "country": "USA"
    },
    "shipperName": "Sally's Supply Store",
    "transportationProvider": "TQL, CHR"
  },
  "derivativeArtifacts": [
    {
      "qid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
      "artifactType": "INVOICE"
    }
  ],
  "tags": {}
}
```
```

--------------------------------

### GET /v1/shipment-jobs/{qid}

Source: https://docs.loop.com/openapi/index_tag/artifacts

Retrieves the details of a specific shipment job.

```APIDOC
## GET /v1/shipment-jobs/{qid}

### Description
Retrieves the details of a specific shipment job based on its unique identifier (QID).

### Method
GET

### Endpoint
`/v1/shipment-jobs/{qid}`

### Parameters
#### Path Parameters
- **qid** (string) - Required - The unique identifier (QID) of the shipment job to retrieve.

#### Query Parameters
- **expand** (Array of strings) - Optional - Specifies additional fields to include in the response. Possible values include: `addresses`, `artifacts`, `billingStatus`, `jobTypeInfo.address`, `jobTypeInfo.organizations`, `jobTypeInfo.organizations.tags`, `payableInvoices`, `payableInvoices.artifacts`, `payableInvoices.exceptions`, `payableInvoices.organizations`, `payableInvoices.organizations.tags`, `payableInvoices.shipmentJobs`, `payableInvoices.shipmentJobs.addresses`, `payableInvoices.shipmentJobs.artifacts`, `payableInvoices.shipmentJobs.jobTypeInfo.address`, `payableInvoices.shipmentJobs.jobTypeInfo.organizations`, `payableInvoices.shipmentJobs.jobTypeInfo.organizations.tags`, `payableInvoices.shipmentJobs.shipment`, `payableInvoices.shipmentJobs.shipment.exceptions`, `payableInvoices.shipmentJobs.tags`, `receivableInvoices`, `receivableInvoices.lineItems.invoiceDeliveryMethod`, `receivableInvoices.shipments`, `receivableInvoices.shipments.exceptions`, `receivableInvoices.shipments.shipmentJobs`, `receivableInvoices.shipments.shipmentJobs.addresses`, `receivableInvoices.shipments.shipmentJobs.artifacts`, `receivableInvoices.shipments.shipmentJobs.jobTypeInfo.address`, `receivableInvoices.shipments.shipmentJobs.jobTypeInfo.organizations`, `receivableInvoices.shipments.shipmentJobs.jobTypeInfo.organizations.tags`, `receivableInvoices.shipments.shipmentJobs.tags`, `receivableInvoices.supportingArtifacts`, `shipment`, `shipment.exceptions`, `tags`, `review`, `review.latestRateEngineRun`, `review.latestRateEngineRun.rateItems`, `review.latestRateEngineRun.rateItems.tags`.

### Response
#### Success Response (200)
- **qid** (string) - Qualified unique identifier.
- **createdAt** (string) - UTC timestamp of creation.
- **revisionNumber** (number) - Revision number.
- **revisionCreatedAt** (string) - UTC timestamp of revision creation.
- **jobType** (string) - Type of the job (e.g., "AIR", "FTL", "OCEAN").
- **customerOrganizationQid** (string) - QID of the customer organization.
- **jobTypeInfo** (object or null) - Job-type specific information.
- **artifactQids** (Array of strings) - QIDs of associated artifacts.
- **normalizationStatus** (string) - Normalization status of the shipment job.
- **artifacts** (object) - Associated artifacts (if expanded).
- **billingStatus** (string) - Billing status of the shipment job (if expanded).
- **payableInvoices** (object) - Payable invoices (if expanded).
- **receivableInvoices** (object) - Receivable invoices (if expanded).
- **addresses** (Array of objects) - Addresses associated with the shipment job.
- **referenceNumbers** (object) - Reference numbers for the shipment job.
- **referenceNumbersList** (Array of objects) - All reference numbers for the shipment job.
- **metadata** (object or null) - Semi-structured metadata about the shipment job.
- **tags** (object) - Entity tags (if expanded).
- **shipment** (object) - Associated shipment details (if expanded).
- **review** (object) - Associated review details (if expanded).

#### Response Example (200)
```json
{
  "qid": "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c5",
  "createdAt": "2023-10-27T10:00:00Z",
  "revisionNumber": 1,
  "revisionCreatedAt": "2023-10-27T10:00:00Z",
  "jobType": "FTL",
  "customerOrganizationQid": "qid::organization:abcdef12-3456-7890-abcd-ef1234567890",
  "jobTypeInfo": {
    "type": "ShipmentJobFtlInfo",
    "dimensions": {
      "length": 100,
      "width": 50,
      "height": 50,
      "unit": "CM"
    },
    "weight": {
      "value": 500,
      "unit": "KG"
    }
  },
  "artifactQids": [],
  "normalizationStatus": "COMPLETE",
  "addresses": [
    {
      "type": "PICKUP",
      "location": {
        "name": "Warehouse A",
        "addressLine1": "123 Main St",
        "city": "Anytown",
        "state": "CA",
        "postalCode": "90210",
        "country": "US"
      }
    }
  ],
  "referenceNumbers": {
    "customer": "PO12345"
  },
  "referenceNumbersList": [
    {
      "type": "customer",
      "value": "PO12345"
    }
  ],
  "metadata": {},
  "tags": {},
  "shipment": {},
  "review": {}
}
```

#### Error Response (400)
Invalid QID

#### Error Response (404)
Shipment job not found
```