Sign In

Save Naturally - Sign Data

This system is an essential part of transferring sign data from Save Naturally to GPC. On this page, we'll dive into the request for sending data using the API.

Sign Model

StoreName string required
ShipToName string required
ShipToAddress1 string required
ShipToAddress2 string
ShipToCity string required
ShipToState string required
ShipToZip string required
ShipToCountry string required
ShipToUrbanization string
Row1Color string
Row1FontColor string
Location string
UPC string required
BrandName string
ItemName string required
Row2Color string
Row2FontColor1 string
CustomWording1 string
Row2FontColor2 string
MemberExclusiveSavings2 string
Row3Color string
Row3FontColor string
DiscountAmount number required
Action string
Row4Color string
Row4FontColor string
Logo string
CampaignDate string required
CustomWording2 string

Error Codes

api_key_missing

The request's Authorization header did not contain an API key.

invalid_api_key

The API key failed to authenticate. Double check that it has not been rotated.

api_key_forbidden

The API key provided does not have permission to perform the requested action.

insecure_connection

A non-HTTPS request was detected. The exposed API key has been revoked and rotated.

no_body

The request body was empty.

bad_request

The event payload contains invalid data types or is missing required fields.

server_error

Something went wrong on our end. The GPC development team has been notified.


POST /v1/signs

Add Sign

Parameters

No parameters.

Attributes

No attributes.

Returns

An empty 202 Accepted response upon success. If an error occurs an Error model will be returned.

Request

POST /v1/signs

curl -X POST 'savenaturally.gpcoservices.com/v1/signs' \ -H 'GPC-Api-Key: {key}' \ -H 'Content-Type: application/json' \ -d '{ "StoreName": "Test Store - GPC", "ShipToName": "Mike Wilkinson", "ShipToAddress 1": "4719 Ivanrest Ave SW", "ShipToAddress 2": "East Office", "ShipToCity": "GRANDVILLE", "ShipToState": "MI", "ShipToZip": "49418", "ShipToCountry": "USA", "ShipToUrbanization": "", "Row1Color": "#FFFFFF", "Row1FontColor": "#000000", "Location": "EXT THERAPY", "UPC": "810094200589", "Brand Name": "Pranarom", "Item Name": "Vapor Rub NEW!", "Row 2 Color": "#FFFFFF", "Row 2 Font Color 1": "", "Custom Wording 1": "", "Row 2 Font Color 2": "#000000", "Member Exclusive Savings 2": "Member Exclusive Savings", "Row 3 Color": "#FFFFFF", "Row 3 Font Color": "#000000", "Discount Amount": "2", "Action": "keep", "Row 4 Color": "#FFFFFF", "Row 4 Font Color": "#000000", "Logo": "savenaturally.png", "Campaign Date": "Q4'\''25", "Custom Wording 2": "Powered By SaveNaturally" }' Copy