Distribution | Subrite

Distribution

Endpoints for Distribution

ReferenceUpdated October 13, 2026View as Markdown

GET/api/v1/distribution/titles

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema Examplearray of DistributionTitleResponseDto

3 top-level fields

diProductCodestringRequired when parent is present
productNamesarray of stringRequired when parent is present
publicationDaysstringRequired when parent is present
Can be nullWeekdays the title is published, digits 1-7 where 1 is Monday.

3 documented fields · Scroll to see moreShow full heightShow compact view

Schema Examplearray of DistributionTitleResponseDto

200 · application/json

[
  {
    "diProductCode": "ABC",
    "productNames": [],
    "publicationDays": "4"
  }
]

Example · 7 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
messagestring
errorsarray of FieldErrorRequired7 fields
errors

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as List the DI titles the tenant can generate distribution files for (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/distribution/titles \
  --header 'Authorization: Bearer <token>'

Try it

GET/api/v1/distribution/runs

Authentication: Bearer token (JWT)

Parameters

Query parameters4

pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderBystringOptional
Default: "createdAt"Allowed values: "createdAt", "id", "updatedAt"
orderDirectionstringOptional

Start generating the four DI files for one title and distribution date#

POST/api/v1/distribution/runs

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleCreateDistributionRunDto

2 top-level fields

diProductCodestringRequired
DI product code of the title, as set on its products.pattern: /^[A-Za-z0-9]{1,5}$/
distributionDatestringRequired

GET/api/v1/distribution/runs/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

GET/api/v1/distribution/files/{id}/download

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

7 status codes

Responses 200

Status200 400 401 403 404 500 502application/xml

The XML file, ISO-8859-1 encoded

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExampleDistributionRunResponseDtoPaginated

2 top-level fieldsSelect an object to expand

itemsarray of DistributionRunResponseDtoRequired11 fields
items
- idnumberRequired when parent is presentField path: items[].id
- diProductCodestringRequired when parent is presentField path: items[].diProductCode
- distributionDatestringRequired when parent is presentField path: items[].distributionDate
- transTypeDISTRIBUTION_TRANS_TYPERequired when parent is presentField path: items[].transType
  Allowed values: "C", "T"
- statusDISTRIBUTION_RUN_STATUSRequired when parent is presentField path: items[].status
  Allowed values: "queued", "started", "completed", "failed"
- startedBystringRequired when parent is presentField path: items[].startedBy
  Can be null
- generatedAtstring (date-time)Required when parent is presentField path: items[].generatedAt
  Can be null
- addressParseFailureCountnumberRequired when parent is presentField path: items[].addressParseFailureCount
- addressStoppedCountnumberRequired when parent is presentField path: items[].addressStoppedCount
  How many of the address failures this run wrote as Type=S.
- errorstringRequired when parent is presentField path: items[].error
  Can be null
- filesarray of DistributionFileResponseDtoRequired when parent is presentField path: items[].files5 fields
  items[].files
  - idnumberRequired when parent is presentField path: items[].files[].id
  - kindDISTRIBUTION_FILE_KINDRequired when parent is presentField path: items[].files[].kind
    Allowed values: "subscriber_deliveries", "messages", "single_copy_retailers", "single_copy_quantities"
  - fileNamestringRequired when parent is presentField path: items[].files[].fileName
  - byteSizenumberRequired when parent is presentField path: items[].files[].byteSize
metaPageMetaRequired6 fields
meta
- pagenumberRequiredField path: meta.page
- takenumberRequiredField path: meta.take
- countnumberRequiredField path: meta.count
- pageCountnumberRequiredField path: meta.pageCount
- hasPreviousPagebooleanRequiredField path: meta.hasPreviousPage
- hasNextPagebooleanRequiredField path: meta.hasNextPage

24 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleDistributionRunResponseDtoPaginated

200 · application/json

{
  "items": [
    {
      "files": []
    }
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 15 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest"
messagestring
errorsarray of FieldError

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as List the DI titles the tenant can generate distribution files for (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Responses 500

Status200 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as List the DI titles the tenant can generate distribution files for (403).

Responses

8 status codes

Responses 201

Status201 400 401 403 404 409 500 503application/json

Schema ExampleDistributionRunDetailResponseDto

12 top-level fieldsSelect an object to expand

idnumberRequired
diProductCodestringRequired
distributionDatestringRequired
transTypeDISTRIBUTION_TRANS_TYPERequired
Allowed values: "C", "T"
statusDISTRIBUTION_RUN_STATUSRequired
Allowed values: "queued", "started", "completed", "failed"
startedBystringRequired
Can be null
generatedAtstring (date-time)Required
Can be null
addressParseFailureCountnumberRequired
addressStoppedCountnumberRequired
How many of the address failures this run wrote as Type=S.
errorstringRequired
Can be null
filesarray of DistributionFileResponseDtoRequired5 fields
files
- idnumberRequired when parent is presentField path: files[].id
- kindDISTRIBUTION_FILE_KINDRequired when parent is presentField path: files[].kind
  Allowed values: "subscriber_deliveries", "messages", "single_copy_retailers", "single_copy_quantities"
- fileNamestringRequired when parent is presentField path: files[].fileName
- byteSizenumberRequired when parent is presentField path: files[].byteSize
- rowCountnumberRequired when parent is presentField path: files[].rowCount
addressParseFailuresarray of AddressParseFailureDtoRequired5 fields
addressParseFailures
Deliveries left out because the address could not be split; stopped ones first.
- memberPackageIdnumberRequired when parent is presentField path: addressParseFailures[].memberPackageId
- memberNumbernumberRequired when parent is presentField path: addressParseFailures[].memberNumber
  Can be null
- namestringRequired when parent is presentField path: addressParseFailures[].name
- line1stringRequired when parent is presentField path: addressParseFailures[].line1

22 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleDistributionRunDetailResponseDto

201 · application/json

{
  "id": 0,
  "diProductCode": "string",
  "distributionDate": "2026-08-27",
  "transType": "C",
  "status": "queued",
  "startedBy": "string",
  "generatedAt": "2019-08-24T14:15:22Z",
  "addressParseFailureCount": 0,
  "addressStoppedCount": 0,
  "error": "string",
  "files": [
    {}
  ],
  "addressParseFailures": [
    {}
  ]
}

Example · 18 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 409 500 503application/json

Body validation failed, or the tenant has no DI customer code

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "distributionCustomerSystemMissing"

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 404 409 500 503application/json

DI is not enabled for the tenant, or the user lacks access to data exports

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "distributionDisabled", "forbiddenResource"

Responses 404

Status201 400 401 403 404 409 500 503application/json

distributionTitleNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "distributionTitleNotFound"
message

Responses 409

Status201 400 401 403 404 409 500 503application/json

A run for this title and date already exists, or another run of the title is unfinished

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "distributionRunExists", "distributionRunInProgress"

Responses 500

Status201 400 401 403 404 409 500 503application/json

internalServerError

Schema ExampleErrorResponse

Same fields as List the DI titles the tenant can generate distribution files for (403).

Schema ExampleErrorResponse

500 · application/json

Responses 503

Status201 400 401 403 404 409 500 503application/json

distributionQueueFailed

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "distributionQueueFailed"
message

Example requestcurl

curl

curl https://api.subrite.no/api/v1/distribution/runs \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "diProductCode": "ABC",
  "distributionDate": "2026-08-27"
}'

DistributionRunDetailResponseDto

Schema ExampleDistributionRunDetailResponseDto

200 · application/json

{
  "id": 0,
  "diProductCode": "string",
  "distributionDate": "2026-08-27",
  "transType": "C",
  "status": "queued",
  "startedBy": "string",
  "generatedAt": "2019-08-24T14:15:22Z",
  "addressParseFailureCount": 0,
  "addressStoppedCount": 0,
  "error": "string",
  "files": [
    {}
  ],
  "addressParseFailures": [
    {}
  ]
}

Example · 18 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as List distribution runs, newest distribution date first (400).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as List the DI titles the tenant can generate distribution files for (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500application/json

distributionRunNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "distributionRunNotFound"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is present

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "distributionRunNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500 502application/json

badRequest

Schema ExampleErrorResponse

Same fields as List distribution runs, newest distribution date first (400).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 404 500 502application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as List the DI titles the tenant can generate distribution files for (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500 502application/json

distributionFileNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "distributionFileNotFound"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "distributionFileNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 502

Status200 400 401 403 404 500 502application/json

distributionFileDownloadFailed

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "distributionFileDownloadFailed"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

502 · application/json

{
  "messageCode": "distributionFileDownloadFailed",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "distributionDisabled",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

string

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "distributionTitleNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema ExampleErrorResponse

409 · application/json

{
  "messageCode": "distributionRunExists",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

string

Schema ExampleErrorResponse

503 · application/json

{
  "messageCode": "distributionQueueFailed",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

List the DI titles the tenant can generate distribution files for#

Responses

Responses 200

Responses 401

Responses 403

Responses 500

List distribution runs, newest distribution date first#

Parameters

Start generating the four DI files for one title and distribution date#

Request body

Get one distribution run with its files and address problems#

Parameters

Responses

Responses 200

Download a stored DI file; the file name is in the X-Filename header#

Parameters

Responses

Responses 200

List the DI titles the tenant can generate distribution files for#

Responses

Responses 200

Responses 401

Responses 403

Responses 500

List distribution runs, newest distribution date first#

Parameters

Start generating the four DI files for one title and distribution date#

Request body

Get one distribution run with its files and address problems#

Parameters

Responses

Responses 200

Download a stored DI file; the file name is in the X-Filename header#

Parameters

Responses

Responses 200

Responses

Responses 200

Responses 400

Responses 401

Responses 403

Responses 500

Responses

Responses 201

Responses 400

Responses 401

Responses 403

Responses 404

Responses 409

Responses 500

Responses 503

Responses 400

Responses 401

Responses 403

Responses 404

Responses 500

Responses 400

Responses 401

Responses 403

Responses 404

Responses 500

Responses 502