# Cross Reference Lookups

## List Cross Reference Lookups

> Retrieves a paginated list of cross reference lookups. Can be filtered by \`name\`.

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Cross Reference Lookups"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: `<api-key>`"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"CrossReferenceLookupsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CrossReferenceLookups"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"CrossReferenceLookups":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"cross_reference_lookup_template_id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string","items":{"type":"object"}},"default_value":{"type":"string","items":{"type":"object"}},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"left_value":{"type":"string"},"right_value":{"type":"string"},"cross_reference_lookup_values":{"type":"array","items":{"type":"object"}}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}},"paths":{"/api/v1/cross-reference-lookups":{"get":{"summary":"List Cross Reference Lookups","description":"Retrieves a paginated list of cross reference lookups. Can be filtered by `name`.","parameters":[{"name":"filter[name]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by name."},{"name":"filter[id]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by id."},{"name":"filter[,]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by ,."},{"name":"include","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of relationships to include. Available: crossReferenceLookupValues"},{"name":"sort","in":"query","required":false,"schema":{"type":"string"},"description":"Sort field. Prefix with - for descending. Available: name"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1},"description":"Page number for pagination."},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Number of results per page."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrossReferenceLookupsListResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Cross Reference Lookups"]}}}}
```

## Create Cross Reference Lookup

> Creates a new cross reference lookup.

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Cross Reference Lookups"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: `<api-key>`"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"CrossReferenceLookupsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CrossReferenceLookups"}}},"CrossReferenceLookups":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"cross_reference_lookup_template_id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string","items":{"type":"object"}},"default_value":{"type":"string","items":{"type":"object"}},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"left_value":{"type":"string"},"right_value":{"type":"string"},"cross_reference_lookup_values":{"type":"array","items":{"type":"object"}}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"CrossReferenceLookupsStoreRequest":{"type":"object","properties":{"description":{"type":"string"},"default_value":{"type":"string","nullable":true},"name":{"type":"string"}},"required":["description","name"]}}},"paths":{"/api/v1/cross-reference-lookups":{"post":{"summary":"Create Cross Reference Lookup","description":"Creates a new cross reference lookup.","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrossReferenceLookupsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrossReferenceLookupsStoreRequest"}}}},"tags":["Cross Reference Lookups"],"parameters":[]}}}}
```

## Install Cross Reference Lookup

> Installs a standard cross reference lookup from a template, such as ISO currency code or country code conversions.

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Cross Reference Lookups"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: `<api-key>`"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}},"paths":{"/api/v1/cross-reference-lookups/{crossReferenceLookupTemplate}/install":{"post":{"summary":"Install Cross Reference Lookup","description":"Installs a standard cross reference lookup from a template, such as ISO currency code or country code conversions.","parameters":[{"name":"crossReferenceLookupTemplate","in":"path","required":true,"schema":{"type":"string"},"description":"The crossReferenceLookupTemplate identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Cross Reference Lookups"]}}}}
```

## Upload Cross Reference Lookup

> Uploads a given cross reference lookup to your \`private\` marketplace.\
> \
> This operation requires \`administrator\` permissions. If you are authorising requests with an API key, this request won't work (company-level API keys are associated with manager-level permissions). If you are an \`administrator\`, you can use OAuth 2 credentials to complete this operation. For more information please see our \[Authentication]\(<https://doc.wearepatchworks.com/product-documentation/api-reference/getting-started/authentication#oauth-2-client-credentials>) section.

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Cross Reference Lookups"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: `<api-key>`"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"CrossReferenceLookupsUploadUploadRequest":{"type":"object","properties":{"private":{"type":"string"}}}}},"paths":{"/api/v1/cross-reference-lookups/{crossReferenceLookup}/upload":{"post":{"summary":"Upload Cross Reference Lookup","description":"Uploads a given cross reference lookup to your `private` marketplace.\n\nThis operation requires `administrator` permissions. If you are authorising requests with an API key, this request won't work (company-level API keys are associated with manager-level permissions). If you are an `administrator`, you can use OAuth 2 credentials to complete this operation. For more information please see our [Authentication](https://doc.wearepatchworks.com/product-documentation/api-reference/getting-started/authentication#oauth-2-client-credentials) section.","parameters":[{"name":"crossReferenceLookup","in":"path","required":true,"schema":{"type":"string"},"description":"The crossReferenceLookup identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrossReferenceLookupsUploadUploadRequest"}}}},"tags":["Cross Reference Lookups"]}}}}
```

## Get Cross Reference Lookup

> Retrieves the details of a specific cross reference lookup.

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Cross Reference Lookups"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: `<api-key>`"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"CrossReferenceLookupsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CrossReferenceLookups"}}},"CrossReferenceLookups":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"cross_reference_lookup_template_id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string","items":{"type":"object"}},"default_value":{"type":"string","items":{"type":"object"}},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"left_value":{"type":"string"},"right_value":{"type":"string"},"cross_reference_lookup_values":{"type":"array","items":{"type":"object"}}}}}},"paths":{"/api/v1/cross-reference-lookups/{cross_reference_lookup}":{"get":{"summary":"Get Cross Reference Lookup","description":"Retrieves the details of a specific cross reference lookup.","parameters":[{"name":"cross_reference_lookup","in":"path","required":true,"schema":{"type":"string"},"description":"The cross reference lookup identifier."},{"name":"filter[name]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by name."},{"name":"filter[id]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by id."},{"name":"filter[,]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by ,."},{"name":"include","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of relationships to include. Available: crossReferenceLookupValues"},{"name":"sort","in":"query","required":false,"schema":{"type":"string"},"description":"Sort field. Prefix with - for descending. Available: name"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1},"description":"Page number for pagination."},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Number of results per page."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrossReferenceLookupsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Cross Reference Lookups"]}}}}
```

## Update Cross Reference Lookup

> Updates an existing cross reference lookup.

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Cross Reference Lookups"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: `<api-key>`"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"CrossReferenceLookupsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CrossReferenceLookups"}}},"CrossReferenceLookups":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"cross_reference_lookup_template_id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string","items":{"type":"object"}},"default_value":{"type":"string","items":{"type":"object"}},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"left_value":{"type":"string"},"right_value":{"type":"string"},"cross_reference_lookup_values":{"type":"array","items":{"type":"object"}}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"CrossReferenceLookupsUpdateRequest":{"type":"object","properties":{"description":{"type":"string"},"default_value":{"type":"string","nullable":true},"name":{"type":"string"}}}}},"paths":{"/api/v1/cross-reference-lookups/{cross_reference_lookup}":{"put":{"summary":"Update Cross Reference Lookup","description":"Updates an existing cross reference lookup.","parameters":[{"name":"cross_reference_lookup","in":"path","required":true,"schema":{"type":"string"},"description":"The cross reference lookup identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrossReferenceLookupsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrossReferenceLookupsUpdateRequest"}}}},"tags":["Cross Reference Lookups"]}}}}
```

## Delete Cross Reference Lookup

> Permanently deletes a specific cross reference lookup.

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Cross Reference Lookups"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: `<api-key>`"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"MessageResponse":{"type":"object","properties":{"message":{"type":"string"}}}}},"paths":{"/api/v1/cross-reference-lookups/{cross_reference_lookup}":{"delete":{"summary":"Delete Cross Reference Lookup","description":"Permanently deletes a specific cross reference lookup.","parameters":[{"name":"cross_reference_lookup","in":"path","required":true,"schema":{"type":"string"},"description":"The cross reference lookup identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Cross Reference Lookups"]}}}}
```

## Clear Cross Reference Lookup

> Removes all values from a specific cross reference lookup.

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Cross Reference Lookups"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: `<api-key>`"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}},"paths":{"/api/v1/cross-reference-lookups/{cross_reference_lookup}/clear":{"post":{"summary":"Clear Cross Reference Lookup","description":"Removes all values from a specific cross reference lookup.","tags":["Cross Reference Lookups"],"parameters":[{"name":"cross_reference_lookup","in":"path","required":true,"schema":{"type":"string"},"description":"The cross reference lookup identifier."}],"responses":{"200":{"description":"Successful response"},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## List Cross Reference Lookup Values

> Retrieves a paginated list of values for a specific cross reference lookup. Can be filtered by \`left\_value\` and \`right\_value\`.

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Cross Reference Lookups"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: `<api-key>`"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"CrossReferenceLookupsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CrossReferenceLookups"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"CrossReferenceLookups":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"cross_reference_lookup_template_id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string","items":{"type":"object"}},"default_value":{"type":"string","items":{"type":"object"}},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"left_value":{"type":"string"},"right_value":{"type":"string"},"cross_reference_lookup_values":{"type":"array","items":{"type":"object"}}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}},"paths":{"/api/v1/cross-reference-lookups/{cross_reference_lookup}/cross-reference-lookup-values":{"get":{"summary":"List Cross Reference Lookup Values","description":"Retrieves a paginated list of values for a specific cross reference lookup. Can be filtered by `left_value` and `right_value`.","parameters":[{"name":"cross_reference_lookup","in":"path","required":true,"schema":{"type":"string"},"description":"The cross reference lookup identifier."},{"name":"filter[cross_reference_lookup_id]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by cross_reference_lookup_id."},{"name":"filter[left_value]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by left_value."},{"name":"filter[right_value]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by right_value."},{"name":"sort","in":"query","required":false,"schema":{"type":"string"},"description":"Sort field. Prefix with - for descending. Available: cross_reference_lookup_id, left_value, right_value"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1},"description":"Page number for pagination."},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Number of results per page."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrossReferenceLookupsListResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Cross Reference Lookups"]}}}}
```

## Create Cross Reference Lookup Value

> Creates a new value for a specific cross reference lookup.

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Cross Reference Lookups"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: `<api-key>`"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"CrossReferenceLookupsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CrossReferenceLookups"}}},"CrossReferenceLookups":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"cross_reference_lookup_template_id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string","items":{"type":"object"}},"default_value":{"type":"string","items":{"type":"object"}},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"left_value":{"type":"string"},"right_value":{"type":"string"},"cross_reference_lookup_values":{"type":"array","items":{"type":"object"}}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"CrossReferenceLookupsStoreCrossReferenceLookupValuesRequest":{"type":"object","properties":{"left_value":{"type":"string","nullable":true},"right_value":{"type":"string","nullable":true}}}}},"paths":{"/api/v1/cross-reference-lookups/{cross_reference_lookup}/cross-reference-lookup-values":{"post":{"summary":"Create Cross Reference Lookup Value","description":"Creates a new value for a specific cross reference lookup.","parameters":[{"name":"cross_reference_lookup","in":"path","required":true,"schema":{"type":"string"},"description":"The cross reference lookup identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrossReferenceLookupsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrossReferenceLookupsStoreCrossReferenceLookupValuesRequest"}}}},"tags":["Cross Reference Lookups"]}}}}
```

## Import Cross Reference Lookup Value

> Imports values into a specific cross reference lookup from a CSV file containing \`left\_value\` and \`right\_value\` columns.

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Cross Reference Lookups"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: `<api-key>`"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"CrossReferenceLookupsImportImportRequest":{"type":"object","properties":{"values_file":{"type":"string"}},"required":["values_file"]}}},"paths":{"/api/v1/cross-reference-lookups/{cross_reference_lookup}/cross-reference-lookup-values/import":{"post":{"summary":"Import Cross Reference Lookup Value","description":"Imports values into a specific cross reference lookup from a CSV file containing `left_value` and `right_value` columns.","parameters":[{"name":"cross_reference_lookup","in":"path","required":true,"schema":{"type":"string"},"description":"The cross reference lookup identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrossReferenceLookupsImportImportRequest"}}}},"tags":["Cross Reference Lookups"]}}}}
```

## Get Cross Reference Lookup Value

> Retrieves the details of a specific cross reference lookup value.

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Cross Reference Lookups"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: `<api-key>`"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"CrossReferenceLookupsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CrossReferenceLookups"}}},"CrossReferenceLookups":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"cross_reference_lookup_template_id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string","items":{"type":"object"}},"default_value":{"type":"string","items":{"type":"object"}},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"left_value":{"type":"string"},"right_value":{"type":"string"},"cross_reference_lookup_values":{"type":"array","items":{"type":"object"}}}}}},"paths":{"/api/v1/cross-reference-lookups/{cross_reference_lookup}/cross-reference-lookup-values/{cross_reference_lookup_value}":{"get":{"summary":"Get Cross Reference Lookup Value","description":"Retrieves the details of a specific cross reference lookup value.","parameters":[{"name":"cross_reference_lookup","in":"path","required":true,"schema":{"type":"string"},"description":"The cross reference lookup identifier."},{"name":"cross_reference_lookup_value","in":"path","required":true,"schema":{"type":"string"},"description":"The cross reference lookup value identifier."},{"name":"filter[cross_reference_lookup_id]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by cross_reference_lookup_id."},{"name":"filter[left_value]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by left_value."},{"name":"filter[right_value]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by right_value."},{"name":"sort","in":"query","required":false,"schema":{"type":"string"},"description":"Sort field. Prefix with - for descending. Available: cross_reference_lookup_id, left_value, right_value"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1},"description":"Page number for pagination."},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Number of results per page."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrossReferenceLookupsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Cross Reference Lookups"]}}}}
```

## Update Cross Reference Lookup Value

> Updates an existing cross reference lookup value.

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Cross Reference Lookups"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: `<api-key>`"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"CrossReferenceLookupsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CrossReferenceLookups"}}},"CrossReferenceLookups":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"cross_reference_lookup_template_id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string","items":{"type":"object"}},"default_value":{"type":"string","items":{"type":"object"}},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"left_value":{"type":"string"},"right_value":{"type":"string"},"cross_reference_lookup_values":{"type":"array","items":{"type":"object"}}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"CrossReferenceLookupsUpdateCrossReferenceLookupValuesRequest":{"type":"object","properties":{"left_value":{"type":"string","nullable":true},"right_value":{"type":"string","nullable":true}}}}},"paths":{"/api/v1/cross-reference-lookups/{cross_reference_lookup}/cross-reference-lookup-values/{cross_reference_lookup_value}":{"put":{"summary":"Update Cross Reference Lookup Value","description":"Updates an existing cross reference lookup value.","parameters":[{"name":"cross_reference_lookup","in":"path","required":true,"schema":{"type":"string"},"description":"The cross reference lookup identifier."},{"name":"cross_reference_lookup_value","in":"path","required":true,"schema":{"type":"string"},"description":"The cross reference lookup value identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrossReferenceLookupsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrossReferenceLookupsUpdateCrossReferenceLookupValuesRequest"}}}},"tags":["Cross Reference Lookups"]}}}}
```

## Delete Cross Reference Lookup Value

> Permanently deletes a specific cross reference lookup value.

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Cross Reference Lookups"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: `<api-key>`"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"MessageResponse":{"type":"object","properties":{"message":{"type":"string"}}}}},"paths":{"/api/v1/cross-reference-lookups/{cross_reference_lookup}/cross-reference-lookup-values/{cross_reference_lookup_value}":{"delete":{"summary":"Delete Cross Reference Lookup Value","description":"Permanently deletes a specific cross reference lookup value.","parameters":[{"name":"cross_reference_lookup","in":"path","required":true,"schema":{"type":"string"},"description":"The cross reference lookup identifier."},{"name":"cross_reference_lookup_value","in":"path","required":true,"schema":{"type":"string"},"description":"The cross reference lookup value identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Cross Reference Lookups"]}}}}
```

## Download Cross Reference Lookup

> Triggers the download of a specific cross reference lookup as a CSV file with \`left\_value\` and \`right\_value\` columns. The file is added to the File Downloads section in General Settings.

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Cross Reference Lookups"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: `<api-key>`"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}}},"paths":{"/api/v1/cross-reference-lookups/{cross_reference_lookup}/download":{"get":{"summary":"Download Cross Reference Lookup","description":"Triggers the download of a specific cross reference lookup as a CSV file with `left_value` and `right_value` columns. The file is added to the File Downloads section in General Settings.","parameters":[{"name":"cross_reference_lookup","in":"path","required":true,"schema":{"type":"string"},"description":"The cross reference lookup identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Cross Reference Lookups"]}}}}
```