logo

Receptacles service

Imports and retrieves receptacle data

Import receptacles

Imports inbound receptacles.

Access to this method is authorized by the Import receptacles operation.

This API method corresponds to the receptacle import interface. The structure of the request body corresponds to the element of the interface XML schema. For more information, see the IPS Import/Export Administration Guide.

Note:If you want to import outbound receptacles, you can do this as part of creating dispatches.

Securityips_token
Request
Request Body schema: application/json
ReceptacleId
required
string <= 29 characters ^[A-z0-9]{29}$

Receptacle Identifier. Allowed values: S9 UPU receptacle identifier

Weight
required
number <float> ^[0-9]{5}\.[0-9]{3}$

Receptacle weight

DocumentationEnclosed
string <= 1 characters

Indicates that the receptacle contains documentation

Enum: "0" "1"
MailSubclassFcd
required
string <= 2 characters ^[A-z0-9]{2}$

Valid receptacle mail subclass (from code list 117)
If not provided, the receptacle mail subclass defaults to the dispatch mail subclass.

CharacteristicCd
string <= 1 characters ^[A-z0-9]{1}$

Receptacle characteristic

Enum: "B (Bulk)" "E (Exempt)" "I (IBRS)" "M (M Bag)" "O (Parcel Out Of Bag)" "V (Empty Bag)"
SubtypeCd
string <= 2 characters ^[A-z0-9]{2}$

Receptacle subtype

MailItmsNo
integer
RegNo
integer
InsNo
integer
PostalStatusFcd
boolean <= 4 characters ^[A-z0-9]{4}$

Indicates that the receptacle contains documentation

RecptclContentFormat
string <= 1 characters ^[A-z0-9]{1}$

Valid receptacle mail subclass (from code list 117)

object (InboundInfo)
ReceptacleTareWeight
number <float> ^[0-9]{5}\.[0-9]{3}$

Receptacle tare weight

Array of objects (Events)
Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/ReceptaclesService.svc/rest/receptacles
Request samples
application/json
{
  • "ReceptacleId": "NLAMSAITLINAAUN10231002000210",
  • "Weight": 45.657,
  • "DocumentationEnclosed": "1",
  • "MailSubclassFcd": "UN",
  • "CharacteristicCd": "B (Bulk)",
  • "SubtypeCd": "BG",
  • "MailItmsNo": 10,
  • "RegNo": 2,
  • "InsNo": 2,
  • "PostalStatusFcd": "1",
  • "RecptclContentFormat": "X",
  • "InboundInfo": {
    },
  • "ReceptacleTareWeight": "3.4",
  • "Events": [
    ]
}
Response samples
application/json
{
  • "Receptacle": {
    }
}

Get receptacle data

Retrieves receptacle data.

Access to this method is authorized by the Get receptacles operation.

List of search parameters is in URL query string format, combined in a logical AND.

Securityips_token
Request
query Parameters
receptacleId
string

S8 standard identifier.

Not mandatory, although if not specified, must specify either lastEventGMTFrom/To or lastEventCaptureGMTFrom/To instead

originCountry
string

Two character country code, not needed if origin operator is specified

originOperator
string

Three character operator code

destinationCountry
string

Two character country code, not needed if destination operator is specified

destinationOperator
string

Two character operator code

originOffice
string

Six character office code from UPU code list 108

destinationOffice
string

Six character office code from UPU code list 108

mailCategory
string

Mail category A, B, C or D

Enum: "A" "B" "C" "D"
mailClass
string

Mail class U, C or E, not needed if the mail subclass is specified

Enum: "U" "C" "E"
mailSubClass
string

Value from UPU code list 117

lastEventGMTFrom
string <date-time>

Receptacles with last event on or after this date and time, in format YYYY-MM-DDThh:mm:ss.sss

Not mandatory, although must specify lastEventGMTFrom/To or lastEventCaptureGMTFrom/To if no receptacle ID is specified

lastEventGMTTo
string <date-time>

Receptacles with last event before this date and time, in format YYYY-MM-DDThh:mm:ss.sss

Not mandatory, although must specify lastEventGMTFrom/To or lastEventCaptureGMTFrom/To if no receptacle ID is specified

lastEventCaptureGMTFrom
string <date-time>

Receptacles with last event capture date on or after this date and time, in format YYYY-MM-DDThh:mm:ss.sss

Not mandatory, although must specify lastEventGMTFrom/To or lastEventCaptureGMTFrom/To if no receptacle ID is specified

lastEventCaptureGMTTo
string <date-time>

Receptacles with last event capture date before this date and time, in format YYYY-MM-DDThh:mm:ss.sss

Not mandatory, although must specify lastEventGMTFrom/To or lastEventCaptureGMTFrom/To if no receptacle ID is specified

Responses
200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/ReceptaclesService.svc/rest/receptacles
Response samples
application/json
{
  • "Receptacles": [
    ]
}
➔ Next to Reference data service