Print Service (Print) Request

post

https://developer.api.us.stg.walmart.com/printer/print

This request is an outbound call that hands off a print payload. The provider is the tenant. The type is sync.

Response (Status): 200 - Success Status Code
Success response is optional.

{ "printJobId": "", "message": ""
}

Response (Status): 500 - Server Error Status Code

{ "errorCode": "1010", "errorMessage": "Out Of Paper"
}

Body Params

Request print service (print)

printerId

string

required

Specifies the identifier for the printer.

This identifier can be the Media Access Control (MAC) address. The application uses this value to identify the printer to send the print job.

printerId must be null/empty if useDefaultPrinter is set to TRUE. It is expected that the tenant's service identifies the default printer associated with the store. storeId is passed in the header FAAS_NODE_ EXTERNAL_ID.

Example

FC0BA40ABCD80

type

string

required

Specifies the type of printer on which the print is issues.

Example

LASER

ZEBRA

data

string

required

Specifies the actual data/content to be printed.

Example

Print message

dataFormat

string

required

Specifies the format of data/content being printed.

Example

PDF

ipAddr

string

Specifies the format of data/content being printed.

Example

12.11.121.123

port

integer

Specifies the port number to connect to the given IP address.

Example

6100

useDefaultPrinter

boolean

Specifies the designator/indicator if using the default printer.

If useDefaultPrinter is set to true, the printerId field must be null or empty.
Store Assist does not pass explicit printer information.
It is expected that the tenant's service identifies the default printer associated with the store.
The field storeId is passed in the header FAAS_NODE_ EXTERNAL_ID.

If true, users are using the default printer.

If false, users are not using the default printer.

Example

true

printCount

integer

Specifies the number of print copies.

Example

1

waterMarkRequired

boolean

Specifies the designator/indicator if a watermark is required.

If true, then a watermark is required.

If false, then a watermark is not required.

Example

true

waterMarkText

string

Specifies the watermark text to be printed.

Example

Walmart GIF Report

fileName

string

Specifies the name of the file to be printed.

Example

order_id_FSR_Report.pdf

landscape

boolean

Specifies the designator/indicator to enable/disable landscape orientation printing.

If true, landscape orientation printing is enabled.

If false, landscape orientation printing is disabled.

Example

false

Headers

Authorization

string

required

Specifies the literal and value for Bearer <authenticationToken>.

Example

Bearer eyJraWQiOiI1N…yLTQ4MjctOGUz

FAAS_NODE_EXTERNAL_ID

string

required

Specifies the tenant's store or location identifier.FAAS_NODE_EXTERNAL_ID is temporary and will be deprecated .Use X-storeId as an alternate for this header.

Example

Valid external store number

ORDER_SOURCE

string

Specifies the source of the order, used for Print Service API requests.

Example

nsm

Content-Type

string

required

Specifies the literal application/json.

Example

application/json

FAAS_TENANT_ID

string

Specifies the tenant identifier.

FAAS_TENANT_ID is temporary and relates to ORDER_SOURCE. It will be deprecated .Use X-tenantId as an alternate for this header.

Example

1

X-tenantId

int64

required

Specifies the tenant identifier.

X-storeId

string

required

Specifies the external identifier of the client store.

Example

9221

Responses

200Successful Operation

500Server Error